org.opensaml.xmlsec.keyinfo.impl

Class BasicKeyInfoGeneratorFactory.BasicKeyInfoGenerator

java.lang.Object

org.opensaml.xmlsec.keyinfo.impl.BasicKeyInfoGeneratorFactory.BasicKeyInfoGenerator

All Implemented Interfaces:

KeyInfoGenerator

Direct Known Subclasses:

X509KeyInfoGeneratorFactory.X509KeyInfoGenerator

Enclosing class:

BasicKeyInfoGeneratorFactory

public class BasicKeyInfoGeneratorFactory.BasicKeyInfoGenerator
extends java.lang.Object
implements KeyInfoGenerator

An implementation of KeyInfoGenerator capable of handling the information contained within a Credential.

Field Summary

Fields

Modifier and Type	Field and Description
private KeyInfoBuilder	keyInfoBuilder Builder for KeyInfo objects.
private BasicKeyInfoGeneratorFactory.BasicOptions	options The set of options to be used by the generator.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BasicKeyInfoGenerator(BasicKeyInfoGeneratorFactory.BasicOptions newOptions) Constructor.

Method Summary

Modifier and Type	Method and Description
KeyInfo	generate(Credential credential) Generate a new KeyInfo object based on keying material and other information within a credential.
protected void	processEntityID(KeyInfo keyInfo, Credential credential) Process the value of Credential.getEntityId().
protected void	processKeyNames(KeyInfo keyInfo, Credential credential) Process the values of Credential.getKeyNames().
protected void	processPublicKey(KeyInfo keyInfo, Credential credential) Process the value of Credential.getPublicKey().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

options

private final BasicKeyInfoGeneratorFactory.BasicOptions options

The set of options to be used by the generator.

keyInfoBuilder

private final KeyInfoBuilder keyInfoBuilder

Builder for KeyInfo objects.

Constructor Detail

BasicKeyInfoGenerator

protected BasicKeyInfoGenerator(@Nonnull
                                BasicKeyInfoGeneratorFactory.BasicOptions newOptions)

Constructor.

Parameters:

newOptions - the options to be used by the generator

Method Detail

generate

@Nullable
public KeyInfo generate(@Nullable
                                  Credential credential)
                           throws SecurityException

Generate a new KeyInfo object based on keying material and other information within a credential.

Specified by:

generate in interface KeyInfoGenerator

Parameters:

credential - the credential containing keying material and possibly other information

Returns:

a new KeyInfo object or null if nothing was generated

Throws:

SecurityException - thrown if there is any error generating the new KeyInfo from the credential

processKeyNames

protected void processKeyNames(@Nonnull
                               KeyInfo keyInfo,
                               @Nonnull
                               Credential credential)

Process the values of Credential.getKeyNames().

Parameters:

keyInfo - the KeyInfo that is being built

credential - the Credential that is geing processed

processEntityID

protected void processEntityID(@Nonnull
                               KeyInfo keyInfo,
                               @Nonnull
                               Credential credential)

Process the value of Credential.getEntityId().

Parameters:

keyInfo - the KeyInfo that is being built

credential - the Credential that is geing processed

processPublicKey

protected void processPublicKey(@Nonnull
                                KeyInfo keyInfo,
                                @Nonnull
                                Credential credential)
                         throws SecurityException

Process the value of Credential.getPublicKey().

Parameters:

keyInfo - the KeyInfo that is being built

credential - the Credential that is being processed

Throws:

SecurityException - if the public key can't be encoded properly