1 /*
2 * GordianKnot: Security Suite
3 * Copyright 2012-2026. Tony Washer
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6 * use this file except in compliance with the License. You may obtain a copy
7 * of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 * License for the specific language governing permissions and limitations under
15 * the License.
16 */
17 package io.github.tonywasher.joceanus.gordianknot.api.keyset;
18
19 import io.github.tonywasher.joceanus.gordianknot.api.base.GordianException;
20 import io.github.tonywasher.joceanus.gordianknot.api.keyset.spec.GordianKeySetSpec;
21 import io.github.tonywasher.joceanus.gordianknot.api.keyset.spec.GordianKeySetSpecBuilder;
22
23 import java.util.function.Predicate;
24
25 /**
26 * GordianKnot KeySet API.
27 */
28 public interface GordianKeySetFactory {
29 /**
30 * generate random KeySet.
31 *
32 * @param pKeySetSpec the keySetSpec
33 * @return the new keySet
34 * @throws GordianException on error
35 */
36 GordianKeySet generateKeySet(GordianKeySetSpec pKeySetSpec) throws GordianException;
37
38 /**
39 * create new GordianKeySetSpecBuilder.
40 *
41 * @return the new KeySetSpecBuilder
42 */
43 GordianKeySetSpecBuilder newKeySetSpecBuilder();
44
45 /**
46 * Obtain predicate for supported KeySetSpecs.
47 *
48 * @return the predicate
49 */
50 Predicate<GordianKeySetSpec> supportedKeySetSpecs();
51 }