org.opensaml.xml.security.credential

クラス BasicKeyInfoGeneratorFactory

java.lang.Object

org.opensaml.xml.security.credential.BasicKeyInfoGeneratorFactory

すべての実装されたインタフェース:

KeyInfoGeneratorFactory

直系の既知のサブクラス:

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.

ネストされたクラスの概要

ネストされたクラス

修飾子とタイプ	クラスと説明
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.

コンストラクタの概要

コンストラクタ

コンストラクタと説明
BasicKeyInfoGeneratorFactory() Constructor.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
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.

クラスから継承されたメソッド java.lang.Object

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

コンストラクタの詳細

BasicKeyInfoGeneratorFactory

public BasicKeyInfoGeneratorFactory()

Constructor. All boolean options are initialzed as false;

メソッドの詳細

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.

定義:

getCredentialType インタフェース内 KeyInfoGeneratorFactory

戻り値:

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.

定義:

handles インタフェース内 KeyInfoGeneratorFactory

パラメータ:

credential - the credential to evaluate

戻り値:

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.

定義:

newInstance インタフェース内 KeyInfoGeneratorFactory

戻り値:

a new KeyInfoGenerator instance

emitEntityIDAsKeyName

public boolean emitEntityIDAsKeyName()

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

戻り値:

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.

パラメータ:

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.

戻り値:

the option value

setEmitKeyNames

public void setEmitKeyNames(boolean newValue)

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

パラメータ:

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.

戻り値:

the option value

setEmitPublicKeyValue

public void setEmitPublicKeyValue(boolean newValue)

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

パラメータ:

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.

戻り値:

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().

戻り値:

the options instance