org.opensaml.xmlsec.keyinfo.impl

Class BasicKeyInfoGeneratorFactory

java.lang.Object

org.opensaml.xmlsec.keyinfo.impl.BasicKeyInfoGeneratorFactory

All Implemented Interfaces:

KeyInfoGeneratorFactory

Direct Known Subclasses:

X509KeyInfoGeneratorFactory

public class BasicKeyInfoGeneratorFactory
extends Object
implements KeyInfoGeneratorFactory

A factory implementation which produces instances of KeyInfoGenerator capable of handling the information contained within a Credential. All boolean options default to false.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BasicKeyInfoGeneratorFactory.BasicKeyInfoGenerator An implementation of KeyInfoGenerator capable of handling the information contained within a Credential.
protected class	BasicKeyInfoGeneratorFactory.BasicOptions Options to be used in the production of a KeyInfo from a Credential.

Field Summary

Fields

Modifier and Type	Field and Description
private BasicKeyInfoGeneratorFactory.BasicOptions	options The set of options configured for the factory.

Constructor Summary

Constructors

Constructor and Description
BasicKeyInfoGeneratorFactory() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	emitEntityIDAsKeyName() Get the option to emit the entity ID value in a Credential as a KeyName element.
boolean	emitKeyNames() Get the option to emit key names found in a Credential as KeyName elements.
boolean	emitPublicDEREncodedKeyValue() Get the option to emit the value of Credential.getPublicKey() as a DEREncodedKeyValue element.
boolean	emitPublicKeyValue() Get the option to emit the value of Credential.getPublicKey() as a KeyValue element.
Class<? extends org.opensaml.security.credential.Credential>	getCredentialType()
protected BasicKeyInfoGeneratorFactory.BasicOptions	getOptions() Get the options of this instance.
boolean	handles(org.opensaml.security.credential.Credential credential)
KeyInfoGenerator	newInstance()
protected BasicKeyInfoGeneratorFactory.BasicOptions	newOptions() Get a new instance to hold options.
void	setEmitEntityIDAsKeyName(boolean newValue) Set the option to emit the entity ID value in a Credential as a KeyName element.
void	setEmitKeyNames(boolean newValue) Set the option to emit key names found in a Credential as KeyName elements.
void	setEmitPublicDEREncodedKeyValue(boolean newValue) Set the option to emit the value of Credential.getPublicKey() as a DEREncodedKeyValue element.
void	setEmitPublicKeyValue(boolean newValue) Set the option to emit the value of Credential.getPublicKey() as a KeyValue element.

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 configured for the factory.

Constructor Detail

BasicKeyInfoGeneratorFactory

public BasicKeyInfoGeneratorFactory()

Constructor. All boolean options are initialzed as false;

Method Detail

getCredentialType

@Nonnull
public Class<? extends org.opensaml.security.credential.Credential> getCredentialType()

Specified by:

getCredentialType in interface KeyInfoGeneratorFactory

handles

public boolean handles(@Nonnull
              org.opensaml.security.credential.Credential credential)

Specified by:

handles in interface KeyInfoGeneratorFactory

newInstance

@Nonnull
public KeyInfoGenerator newInstance()

Specified by:

newInstance in interface KeyInfoGeneratorFactory

emitEntityIDAsKeyName

public boolean emitEntityIDAsKeyName()

Get the option to emit the entity ID value in a Credential as a KeyName element.

Returns:

return the option value

setEmitEntityIDAsKeyName

public void setEmitEntityIDAsKeyName(boolean newValue)

Set the option to emit the entity ID value in a Credential as a KeyName element.

Parameters:

newValue - the new option value to set

emitKeyNames

public boolean emitKeyNames()

Get the option to emit key names found in a Credential as KeyName elements.

Returns:

the option value

setEmitKeyNames

public void setEmitKeyNames(boolean newValue)

Set the option to emit key names found in a Credential as KeyName elements.

Parameters:

newValue - the new option value to set

emitPublicKeyValue

public boolean emitPublicKeyValue()

Get the option to emit the value of Credential.getPublicKey() as a KeyValue element.

Returns:

the option value

setEmitPublicKeyValue

public void setEmitPublicKeyValue(boolean newValue)

Set the option to emit the value of Credential.getPublicKey() as a KeyValue element.

Parameters:

newValue - the new option value to set

emitPublicDEREncodedKeyValue

public boolean emitPublicDEREncodedKeyValue()

Get the option to emit the value of Credential.getPublicKey() as a DEREncodedKeyValue element.

Returns:

the option value

setEmitPublicDEREncodedKeyValue

public void setEmitPublicDEREncodedKeyValue(boolean newValue)

Set the option to emit the value of Credential.getPublicKey() as a DEREncodedKeyValue element.

Parameters:

newValue - the new option value to set

newOptions

@Nonnull
protected BasicKeyInfoGeneratorFactory.BasicOptions newOptions()

Get a new instance to hold options. Used by the top-level superclass constructor. Subclasses MUST override to produce an instance of the appropriate subclass of BasicKeyInfoGeneratorFactory.BasicOptions.

Returns:

a new instance of factory/generator options

getOptions

@Nonnull
protected BasicKeyInfoGeneratorFactory.BasicOptions getOptions()

Get the options of this instance. Used by subclass constructors to get the options built by the top-level class constructor with newOptions().

Returns:

the options instance