1 /*
2 * Copyright [2007] [University Corporation for Advanced Internet Development, Inc.]
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package org.opensaml.xml.security.keyinfo;
18
19 import org.opensaml.xml.security.SecurityException;
20 import org.opensaml.xml.security.credential.Credential;
21 import org.opensaml.xml.signature.KeyInfo;
22
23 /**
24 * Interface for implementations which generate a {@link KeyInfo} based on keying material and other
25 * information found within a {@link Credential}.
26 */
27 public interface KeyInfoGenerator {
28
29 /**
30 * Generate a new KeyInfo object based on keying material and other information within a credential.
31 *
32 * @param credential the credential containing keying material and possibly other information
33 * @return a new KeyInfo object
34 * @throws SecurityException thrown if there is any error generating the new KeyInfo from the credential
35 */
36 public KeyInfo generate(Credential credential) throws SecurityException;
37
38 }