se.swedenconnect.opensaml.xmlsec.keyinfo

Class KeyAgreementKeyInfoGeneratorFactory

java.lang.Object

org.opensaml.xmlsec.keyinfo.impl.BasicKeyInfoGeneratorFactory

org.opensaml.xmlsec.keyinfo.impl.X509KeyInfoGeneratorFactory

se.swedenconnect.opensaml.xmlsec.keyinfo.KeyAgreementKeyInfoGeneratorFactory

All Implemented Interfaces:

KeyInfoGeneratorFactory

public class KeyAgreementKeyInfoGeneratorFactory
extends X509KeyInfoGeneratorFactory

Key info generator to be used when encrypting using key agreement methods.

Note that either emitOriginatorKeyInfoPublicKeyValue or emitOriginatorKeyInfoPublicDEREncodedKeyValue must be set. Otherwise, and empty OriginatorKeyInfo element will be created.

Author:

Martin Lindström (martin@idsec.se), Stefan Santesson (stefan@idsec.se)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	KeyAgreementKeyInfoGeneratorFactory.ExtendedX509Options Since the visibility of the X509Options class prevents us from cloning it, we have to come up with a workaround.
class	KeyAgreementKeyInfoGeneratorFactory.KeyAgreementKeyInfoGenerator An implementation of KeyInfoGenerator capable of handling the information contained within a KeyAgreementCredential.

Nested classes/interfaces inherited from class org.opensaml.xmlsec.keyinfo.impl.X509KeyInfoGeneratorFactory

X509KeyInfoGeneratorFactory.X509KeyInfoGenerator, X509KeyInfoGeneratorFactory.X509Options

Nested classes/interfaces inherited from class org.opensaml.xmlsec.keyinfo.impl.BasicKeyInfoGeneratorFactory

BasicKeyInfoGeneratorFactory.BasicKeyInfoGenerator, BasicKeyInfoGeneratorFactory.BasicOptions

Constructor Summary

Constructors

Constructor and Description
KeyAgreementKeyInfoGeneratorFactory()

Method Summary

Modifier and Type	Method and Description
boolean	emitOriginatorKeyInfoPublicDEREncodedKeyValue() Get the option to emit the value of KeyAgreementCredential.getSenderGeneratedPublicKey() as a DEREncodedKeyValue element in the OriginatorKeyInfo element.
boolean	emitOriginatorKeyInfoPublicKeyValue() Get the option to emit the value of KeyAgreementCredential.getSenderGeneratedPublicKey() as a KeyValue element in the OriginatorKeyInfo element.
Class<? extends Credential>	getCredentialType()
boolean	handles(Credential credential)
KeyInfoGenerator	newInstance()
protected X509KeyInfoGeneratorFactory.X509Options	newOptions()
void	setEmitOriginatorKeyInfoPublicDEREncodedKeyValue(boolean value) Set the option to emit the value of KeyAgreementCredential.getSenderGeneratedPublicKey() as a DEREncodedKeyValue element in the OriginatorKeyInfo element.
void	setEmitOriginatorKeyInfoPublicKeyValue(boolean value) Set the option to emit the value of KeyAgreementCredential.getSenderGeneratedPublicKey() as a KeyValue element in the OriginatorKeyInfo element.

Methods inherited from class org.opensaml.xmlsec.keyinfo.impl.X509KeyInfoGeneratorFactory

emitCRLs, emitEntityCertificate, emitEntityCertificateChain, emitSubjectAltNamesAsKeyNames, emitSubjectCNAsKeyName, emitSubjectDNAsKeyName, emitX509Digest, emitX509IssuerSerial, emitX509SKI, emitX509SubjectName, getOptions, getSubjectAltNames, getX500DNHandler, getX500IssuerDNFormat, getX500SubjectDNFormat, getX509DigestAlgorithmURI, setEmitCRLs, setEmitEntityCertificate, setEmitEntityCertificateChain, setEmitSubjectAltNamesAsKeyNames, setEmitSubjectCNAsKeyName, setEmitSubjectDNAsKeyName, setEmitX509Digest, setEmitX509IssuerSerial, setEmitX509SKI, setEmitX509SubjectName, setX500DNHandler, setX500IssuerDNFormat, setX500SubjectDNFormat, setX509DigestAlgorithmURI

Methods inherited from class org.opensaml.xmlsec.keyinfo.impl.BasicKeyInfoGeneratorFactory

emitEntityIDAsKeyName, emitKeyNames, emitPublicDEREncodedKeyValue, emitPublicKeyValue, setEmitEntityIDAsKeyName, setEmitKeyNames, setEmitPublicDEREncodedKeyValue, setEmitPublicKeyValue

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyAgreementKeyInfoGeneratorFactory

public KeyAgreementKeyInfoGeneratorFactory()

Method Detail

handles

public boolean handles(@Nonnull
                       Credential credential)

Specified by:

handles in interface KeyInfoGeneratorFactory

Overrides:

handles in class X509KeyInfoGeneratorFactory

getCredentialType

public Class<? extends Credential> getCredentialType()

Specified by:

getCredentialType in interface KeyInfoGeneratorFactory

Overrides:

getCredentialType in class X509KeyInfoGeneratorFactory

newInstance

@Nonnull
public KeyInfoGenerator newInstance()

Specified by:

newInstance in interface KeyInfoGeneratorFactory

Overrides:

newInstance in class X509KeyInfoGeneratorFactory

emitOriginatorKeyInfoPublicKeyValue

public boolean emitOriginatorKeyInfoPublicKeyValue()

Get the option to emit the value of KeyAgreementCredential.getSenderGeneratedPublicKey() as a KeyValue element in the OriginatorKeyInfo element.

Returns:

the option value

setEmitOriginatorKeyInfoPublicKeyValue

public void setEmitOriginatorKeyInfoPublicKeyValue(boolean value)

Set the option to emit the value of KeyAgreementCredential.getSenderGeneratedPublicKey() as a KeyValue element in the OriginatorKeyInfo element.

Parameters:

value - the new option value to set

emitOriginatorKeyInfoPublicDEREncodedKeyValue

public boolean emitOriginatorKeyInfoPublicDEREncodedKeyValue()

Get the option to emit the value of KeyAgreementCredential.getSenderGeneratedPublicKey() as a DEREncodedKeyValue element in the OriginatorKeyInfo element.

Returns:

the option value

setEmitOriginatorKeyInfoPublicDEREncodedKeyValue

public void setEmitOriginatorKeyInfoPublicDEREncodedKeyValue(boolean value)

Set the option to emit the value of KeyAgreementCredential.getSenderGeneratedPublicKey() as a DEREncodedKeyValue element in the OriginatorKeyInfo element.

Parameters:

value - the new option value to set

newOptions

protected X509KeyInfoGeneratorFactory.X509Options newOptions()

Overrides:

newOptions in class X509KeyInfoGeneratorFactory