X509KeyInfoGeneratorFactory (Shibboleth Identity Provider 2.3.0 API)

java.lang.Object
- org.opensaml.xml.security.credential.BasicKeyInfoGeneratorFactory
- - org.opensaml.xml.security.x509.X509KeyInfoGeneratorFactory

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

KeyInfoGeneratorFactory
```
public class X509KeyInfoGeneratorFactory
extends BasicKeyInfoGeneratorFactory
```
A factory implementation which produces instances of KeyInfoGenerator capable of handling the information contained within an X509Credential. All boolean options default to false. The default implementation of X500DNHandler used is InternalX500DNHandler. The default output format for subject and issuer DN's is RFC2253. The default set of subject alternative names to process is empty.

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

ネストされたクラス
修飾子とタイプ	クラスと説明
`class`	`X509KeyInfoGeneratorFactory.X509KeyInfoGenerator` An implementation of `KeyInfoGenerator` capable of handling the information contained within a `X509Credential`.
`protected class`	`X509KeyInfoGeneratorFactory.X509Options` Options to be used in the production of a `KeyInfo` from an `X509Credential`.

クラスから継承されたネストされたクラス/インタフェース org.opensaml.xml.security.credential.BasicKeyInfoGeneratorFactory
BasicKeyInfoGeneratorFactory.BasicKeyInfoGenerator, BasicKeyInfoGeneratorFactory.BasicOptions

コンストラクタの概要

コンストラクタ
コンストラクタと説明

X509KeyInfoGeneratorFactory()
Constructor.

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

メソッドの概要

メソッド
修飾子とタイプ	メソッドと説明
`boolean`	`emitCRLs()` Get the option to emit the CRL list as sequence of X509CRL elements within X509Data.
`boolean`	`emitEntityCertificate()` Get the option to emit the entity certificate as an X509Certificate element within X509Data.
`boolean`	`emitEntityCertificateChain()` Get the option to emit the entity certificate chain as sequence of X509Certificate elements within X509Data.
`boolean`	`emitSubjectAltNamesAsKeyNames()` Get the option to emit the entity certificate subject alternative name extension values as KeyName elements.
`boolean`	`emitSubjectCNAsKeyName()` Get the option to emit the entity certificate subject DN common name (CN) fields as KeyName elements.
`boolean`	`emitSubjectDNAsKeyName()` Get the option to emit the entity certificate subject DN as a KeyName element.
`boolean`	`emitX509IssuerSerial()` Get the option to emit the entity certificate issuer name and serial number as an X509IssuerSerial element within X509Data.
`boolean`	`emitX509SKI()` Get the option to emit the entity certificate subject key identifier as an X509SKI element within X509Data.
`boolean`	`emitX509SubjectName()` Get the option to emit the entity certificate subject DN as an X509SubjectName element within X509Data.
`Class<? extends Credential>`	`getCredentialType()` Get the type (interface) of the specific type of credential handled by generators produced by this factory.
`protected X509KeyInfoGeneratorFactory.X509Options`	`getOptions()` Get the options of this instance.
`Set<Integer>`	`getSubjectAltNames()` The set of types of subject alternative names to process.
`X500DNHandler`	`getX500DNHandler()` Get the handler which process X.500 distinguished names.
`String`	`getX500IssuerDNFormat()` Get the output format specifier for X.500 issuer names.
`String`	`getX500SubjectDNFormat()` Get the output format specifier for X.500 subject names.
`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 X509KeyInfoGeneratorFactory.X509Options`	`newOptions()` Get a new instance to hold options.
`void`	`setEmitCRLs(boolean newValue)` Set the option to emit the CRL list as sequence of X509CRL elements within X509Data.
`void`	`setEmitEntityCertificate(boolean newValue)` Set the option to emit the entity certificate as an X509Certificate element within X509Data.
`void`	`setEmitEntityCertificateChain(boolean newValue)` Set the option to emit the entity certificate chain as sequence of X509Certificate elements within X509Data.
`void`	`setEmitSubjectAltNamesAsKeyNames(boolean newValue)` Set the option to emit the entity certificate subject alternative name extension values as KeyName elements.
`void`	`setEmitSubjectCNAsKeyName(boolean newValue)` Set the option to emit the entity certificate subject DN common name (CN) fields as KeyName elements.
`void`	`setEmitSubjectDNAsKeyName(boolean newValue)` Set the option to emit the entity certificate subject DN as a KeyName element.
`void`	`setEmitX509IssuerSerial(boolean newValue)` Set the option to emit the entity certificate issuer name and serial number as an X509IssuerSerial element within X509Data.
`void`	`setEmitX509SKI(boolean newValue)` Set the option to emit the entity certificate subject key identifier as an X509SKI element within X509Data.
`void`	`setEmitX509SubjectName(boolean newValue)` Set the option to emit the entity certificate subject DN as an X509SubjectName element within X509Data.
`void`	`setX500DNHandler(X500DNHandler handler)` Set the handler which process X.500 distinguished names.
`void`	`setX500IssuerDNFormat(String format)` Set the output format specifier for X.500 issuer names.
`void`	`setX500SubjectDNFormat(String format)` Set the output format specifier for X.500 subject names.

クラスから継承されたメソッド org.opensaml.xml.security.credential.BasicKeyInfoGeneratorFactory
emitEntityIDAsKeyName, emitKeyNames, emitPublicKeyValue, setEmitEntityIDAsKeyName, setEmitKeyNames, setEmitPublicKeyValue

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - X509KeyInfoGeneratorFactory
```
public X509KeyInfoGeneratorFactory()
```
    Constructor.
- メソッドの詳細
  - 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
    
    オーバーライド:
    
    getCredentialType クラス内 BasicKeyInfoGeneratorFactory
    
    戻り値:
    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
    
    オーバーライド:
    
    handles クラス内 BasicKeyInfoGeneratorFactory
    
    パラメータ:
    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
    
    オーバーライド:
    
    newInstance クラス内 BasicKeyInfoGeneratorFactory
    
    戻り値:
    a new KeyInfoGenerator instance
  - emitCRLs
```
public boolean emitCRLs()
```
    Get the option to emit the CRL list as sequence of X509CRL elements within X509Data.
    
    戻り値:
    the option value
  - setEmitCRLs
```
public void setEmitCRLs(boolean newValue)
```
    Set the option to emit the CRL list as sequence of X509CRL elements within X509Data.
    
    パラメータ:
    newValue - the new option value
  - emitEntityCertificate
```
public boolean emitEntityCertificate()
```
    Get the option to emit the entity certificate as an X509Certificate element within X509Data.
    
    戻り値:
    the option value
  - setEmitEntityCertificate
```
public void setEmitEntityCertificate(boolean newValue)
```
    Set the option to emit the entity certificate as an X509Certificate element within X509Data.
    
    パラメータ:
    newValue - the new option value
  - emitEntityCertificateChain
```
public boolean emitEntityCertificateChain()
```
    Get the option to emit the entity certificate chain as sequence of X509Certificate elements within X509Data.
    
    戻り値:
    the option value
  - setEmitEntityCertificateChain
```
public void setEmitEntityCertificateChain(boolean newValue)
```
    Set the option to emit the entity certificate chain as sequence of X509Certificate elements within X509Data.
    
    パラメータ:
    newValue - the new option value
  - emitSubjectAltNamesAsKeyNames
```
public boolean emitSubjectAltNamesAsKeyNames()
```
    Get the option to emit the entity certificate subject alternative name extension values as KeyName elements.
    
    戻り値:
    the option value
  - setEmitSubjectAltNamesAsKeyNames
```
public void setEmitSubjectAltNamesAsKeyNames(boolean newValue)
```
    Set the option to emit the entity certificate subject alternative name extension values as KeyName elements.
    
    パラメータ:
    newValue - the new option value
  - emitSubjectCNAsKeyName
```
public boolean emitSubjectCNAsKeyName()
```
    Get the option to emit the entity certificate subject DN common name (CN) fields as KeyName elements.
    
    戻り値:
    the option value
  - setEmitSubjectCNAsKeyName
```
public void setEmitSubjectCNAsKeyName(boolean newValue)
```
    Set the option to emit the entity certificate subject DN common name (CN) fields as KeyName elements.
    
    パラメータ:
    newValue - the new option value
  - emitSubjectDNAsKeyName
```
public boolean emitSubjectDNAsKeyName()
```
    Get the option to emit the entity certificate subject DN as a KeyName element.
    
    戻り値:
    the option value
  - setEmitSubjectDNAsKeyName
```
public void setEmitSubjectDNAsKeyName(boolean newValue)
```
    Set the option to emit the entity certificate subject DN as a KeyName element.
    
    パラメータ:
    newValue - the new option value
  - emitX509IssuerSerial
```
public boolean emitX509IssuerSerial()
```
    Get the option to emit the entity certificate issuer name and serial number as an X509IssuerSerial element within X509Data.
    
    戻り値:
    the option value
  - setEmitX509IssuerSerial
```
public void setEmitX509IssuerSerial(boolean newValue)
```
    Set the option to emit the entity certificate issuer name and serial number as an X509IssuerSerial element within X509Data.
    
    パラメータ:
    newValue - the new option value
  - emitX509SKI
```
public boolean emitX509SKI()
```
    Get the option to emit the entity certificate subject key identifier as an X509SKI element within X509Data.
    
    戻り値:
    the option value
  - setEmitX509SKI
```
public void setEmitX509SKI(boolean newValue)
```
    Set the option to emit the entity certificate subject key identifier as an X509SKI element within X509Data.
    
    パラメータ:
    newValue - the new option value
  - emitX509SubjectName
```
public boolean emitX509SubjectName()
```
    Get the option to emit the entity certificate subject DN as an X509SubjectName element within X509Data.
    
    戻り値:
    the option value
  - setEmitX509SubjectName
```
public void setEmitX509SubjectName(boolean newValue)
```
    Set the option to emit the entity certificate subject DN as an X509SubjectName element within X509Data.
    
    パラメータ:
    newValue - the new option value
  - getSubjectAltNames
```
public Set<Integer> getSubjectAltNames()
```
    The set of types of subject alternative names to process. Name types are represented using the constant OID tag name values defined in X509Util.
    
    戻り値:
    the modifiable set of alt name identifiers
  - getX500DNHandler
```
public X500DNHandler getX500DNHandler()
```
    Get the handler which process X.500 distinguished names. Defaults to InternalX500DNHandler.
    
    戻り値:
    returns the X500DNHandler instance
  - setX500DNHandler
```
public void setX500DNHandler(X500DNHandler handler)
```
    Set the handler which process X.500 distinguished names. Defaults to InternalX500DNHandler.
    
    パラメータ:
    handler - the new X500DNHandler instance
  - getX500SubjectDNFormat
```
public String getX500SubjectDNFormat()
```
    Get the output format specifier for X.500 subject names. Defaults to RFC2253 format. The meaning of this format specifier value is dependent upon the implementation of X500DNHandler which is used.
    
    戻り値:
    returns the format specifier
  - setX500SubjectDNFormat
```
public void setX500SubjectDNFormat(String format)
```
    Set the output format specifier for X.500 subject names. Defaults to RFC2253 format. The meaning of this format specifier value is dependent upon the implementation of X500DNHandler which is used.
    
    パラメータ:
    format - the new X500DNHandler instance
  - getX500IssuerDNFormat
```
public String getX500IssuerDNFormat()
```
    Get the output format specifier for X.500 issuer names. Defaults to RFC2253 format. The meaning of this format specifier value is dependent upon the implementation of X500DNHandler which is used.
    
    戻り値:
    returns the format specifier
  - setX500IssuerDNFormat
```
public void setX500IssuerDNFormat(String format)
```
    Set the output format specifier for X.500 issuer names. Defaults to RFC2253 format. The meaning of this format specifier value is dependent upon the implementation of X500DNHandler which is used.
    
    パラメータ:
    format - the new X500DNHandler instance
  - getOptions
```
protected X509KeyInfoGeneratorFactory.X509Options getOptions()
```
    Get the options of this instance. Used by subclass constructors to get the options built by the top-level class constructor with BasicKeyInfoGeneratorFactory.newOptions().
    
    オーバーライド:
    
    getOptions クラス内 BasicKeyInfoGeneratorFactory
    
    戻り値:
    the options instance
  - newOptions
```
protected X509KeyInfoGeneratorFactory.X509Options 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.
    
    オーバーライド:
    
    newOptions クラス内 BasicKeyInfoGeneratorFactory
    
    戻り値:
    a new instance of factory/generator options

クラス X509KeyInfoGeneratorFactory

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

クラスから継承されたネストされたクラス/インタフェース org.opensaml.xml.security.credential.BasicKeyInfoGeneratorFactory

コンストラクタの概要

メソッドの概要

クラスから継承されたメソッド org.opensaml.xml.security.credential.BasicKeyInfoGeneratorFactory

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

コンストラクタの詳細

X509KeyInfoGeneratorFactory

メソッドの詳細

getCredentialType

handles

newInstance

emitCRLs

setEmitCRLs

emitEntityCertificate

setEmitEntityCertificate

emitEntityCertificateChain

setEmitEntityCertificateChain

emitSubjectAltNamesAsKeyNames

setEmitSubjectAltNamesAsKeyNames

emitSubjectCNAsKeyName

setEmitSubjectCNAsKeyName

emitSubjectDNAsKeyName

setEmitSubjectDNAsKeyName

emitX509IssuerSerial

setEmitX509IssuerSerial

emitX509SKI

setEmitX509SKI

emitX509SubjectName

setEmitX509SubjectName

getSubjectAltNames

getX500DNHandler

setX500DNHandler

getX500SubjectDNFormat

setX500SubjectDNFormat

getX500IssuerDNFormat

setX500IssuerDNFormat

getOptions

newOptions