org.opensaml.xml.security.credential

Class BasicKeyInfoGeneratorFactory

java.lang.Object

org.opensaml.xml.security.credential.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.

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	emitPublicKeyValue() Get the option to emit the value of Credential.getPublicKey() as a KeyValue element.
Class<? extends Credential>	getCredentialType() Get the type (interface) of the specific type of credential handled by generators produced by this factory.
protected BasicKeyInfoGeneratorFactory.BasicOptions	getOptions() Get the options of this instance.
boolean	handles(Credential credential) Check whether the generators produced by this factory can handle the specified credential.
KeyInfoGenerator	newInstance() Get a new instance of the generator type produced by the factory.
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	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

Constructor Detail

BasicKeyInfoGeneratorFactory

public BasicKeyInfoGeneratorFactory()

Constructor. All boolean options are initialzed as false;

Method Detail

getCredentialType

public Class<? extends Credential> getCredentialType()

Get the type (interface) of the specific type of credential handled by generators produced by this factory. Primarily used as an index by manager implementions such as KeyInfoGeneratorManager.

Specified by:

getCredentialType in interface KeyInfoGeneratorFactory

Returns:

the specifc type of credential handled by the generators produced by this factory

handles

public boolean handles(Credential credential)

Check whether the generators produced by this factory can handle the specified credential.

Specified by:

handles in interface KeyInfoGeneratorFactory

Parameters:

credential - the credential to evaluate

Returns:

true if the generators produced by this factory can handle the type of the specified credential, false otherwise

newInstance

public KeyInfoGenerator newInstance()

Get a new instance of the generator type produced by the factory.

Specified by:

newInstance in interface KeyInfoGeneratorFactory

Returns:

a new KeyInfoGenerator instance

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

newOptions

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

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