|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opensaml.xml.security.credential.BasicKeyInfoGeneratorFactory
org.opensaml.xml.security.x509.X509KeyInfoGeneratorFactory
public class X509KeyInfoGeneratorFactory
A factory implementation which produces instances of X509KeyInfoGeneratorFactory.X509KeyInfoGenerator
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.
Nested Class Summary | |
---|---|
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 . |
Nested classes/interfaces inherited from class org.opensaml.xml.security.credential.BasicKeyInfoGeneratorFactory |
---|
BasicKeyInfoGeneratorFactory.BasicKeyInfoGenerator, BasicKeyInfoGeneratorFactory.BasicOptions |
Constructor Summary | |
---|---|
X509KeyInfoGeneratorFactory()
Constructor. |
Method Summary | |
---|---|
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. Primarily used as an index by manager implementions such as KeyInfoGeneratorManager . |
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. |
Methods inherited from class org.opensaml.xml.security.credential.BasicKeyInfoGeneratorFactory |
---|
emitEntityIDAsKeyName, emitKeyNames, emitPublicKeyValue, setEmitEntityIDAsKeyName, setEmitKeyNames, setEmitPublicKeyValue |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public X509KeyInfoGeneratorFactory()
Method Detail |
---|
public Class<? extends Credential> getCredentialType()
KeyInfoGeneratorManager
.
getCredentialType
in interface KeyInfoGeneratorFactory
getCredentialType
in class BasicKeyInfoGeneratorFactory
public boolean handles(Credential credential)
handles
in interface KeyInfoGeneratorFactory
handles
in class BasicKeyInfoGeneratorFactory
credential
- the credential to evaluate
public KeyInfoGenerator newInstance()
newInstance
in interface KeyInfoGeneratorFactory
newInstance
in class BasicKeyInfoGeneratorFactory
public boolean emitCRLs()
public void setEmitCRLs(boolean newValue)
newValue
- the new option valuepublic boolean emitEntityCertificate()
public void setEmitEntityCertificate(boolean newValue)
newValue
- the new option valuepublic boolean emitEntityCertificateChain()
public void setEmitEntityCertificateChain(boolean newValue)
newValue
- the new option valuepublic boolean emitSubjectAltNamesAsKeyNames()
public void setEmitSubjectAltNamesAsKeyNames(boolean newValue)
newValue
- the new option valuepublic boolean emitSubjectCNAsKeyName()
public void setEmitSubjectCNAsKeyName(boolean newValue)
newValue
- the new option valuepublic boolean emitSubjectDNAsKeyName()
public void setEmitSubjectDNAsKeyName(boolean newValue)
newValue
- the new option valuepublic boolean emitX509IssuerSerial()
public void setEmitX509IssuerSerial(boolean newValue)
newValue
- the new option valuepublic boolean emitX509SKI()
public void setEmitX509SKI(boolean newValue)
newValue
- the new option valuepublic boolean emitX509SubjectName()
public void setEmitX509SubjectName(boolean newValue)
newValue
- the new option valuepublic Set<Integer> getSubjectAltNames()
X509Util
.
public X500DNHandler getX500DNHandler()
InternalX500DNHandler
.
public void setX500DNHandler(X500DNHandler handler)
InternalX500DNHandler
.
handler
- the new X500DNHandler instancepublic String getX500SubjectDNFormat()
X500DNHandler
which is used.
public void setX500SubjectDNFormat(String format)
X500DNHandler
which is used.
format
- the new X500DNHandler instancepublic String getX500IssuerDNFormat()
X500DNHandler
which is used.
public void setX500IssuerDNFormat(String format)
X500DNHandler
which is used.
format
- the new X500DNHandler instanceprotected X509KeyInfoGeneratorFactory.X509Options getOptions()
BasicKeyInfoGeneratorFactory.newOptions()
.
getOptions
in class BasicKeyInfoGeneratorFactory
protected X509KeyInfoGeneratorFactory.X509Options newOptions()
BasicKeyInfoGeneratorFactory.BasicOptions
.
newOptions
in class BasicKeyInfoGeneratorFactory
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |