org.opensaml.xmlsec.keyinfo.impl

Class BasicKeyInfoGeneratorFactory.BasicKeyInfoGenerator

java.lang.Object

org.opensaml.xmlsec.keyinfo.impl.BasicKeyInfoGeneratorFactory.BasicKeyInfoGenerator

All Implemented Interfaces:

KeyInfoGenerator

Direct Known Subclasses:

X509KeyInfoGeneratorFactory.X509KeyInfoGenerator

Enclosing class:

BasicKeyInfoGeneratorFactory

public class BasicKeyInfoGeneratorFactory.BasicKeyInfoGenerator
extends Object
implements KeyInfoGenerator

An implementation of KeyInfoGenerator capable of handling the information contained within a Credential.

Field Summary

Fields

Modifier and Type	Field and Description
private KeyInfoBuilder	keyInfoBuilder Builder for KeyInfo objects.
private BasicKeyInfoGeneratorFactory.BasicOptions	options The set of options to be used by the generator.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BasicKeyInfoGeneratorFactory.BasicKeyInfoGenerator(BasicKeyInfoGeneratorFactory.BasicOptions newOptions) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
KeyInfo	generate(org.opensaml.security.credential.Credential credential)
protected void	processEntityID(KeyInfo keyInfo, org.opensaml.security.credential.Credential credential) Process the value of Credential.getEntityId().
protected void	processKeyNames(KeyInfo keyInfo, org.opensaml.security.credential.Credential credential) Process the values of Credential.getKeyNames().
protected void	processPublicKey(KeyInfo keyInfo, org.opensaml.security.credential.Credential credential) Process the value of Credential.getPublicKey().

Methods inherited from class java.lang.Object

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

Field Detail

options

private final BasicKeyInfoGeneratorFactory.BasicOptions options

The set of options to be used by the generator.

keyInfoBuilder

private final KeyInfoBuilder keyInfoBuilder

Builder for KeyInfo objects.

Constructor Detail

BasicKeyInfoGeneratorFactory.BasicKeyInfoGenerator

protected BasicKeyInfoGeneratorFactory.BasicKeyInfoGenerator(@Nonnull
                                                  BasicKeyInfoGeneratorFactory.BasicOptions newOptions)

Constructor.

Parameters:

newOptions - the options to be used by the generator

Method Detail

generate

@Nullable
public KeyInfo generate(@Nullable
                        org.opensaml.security.credential.Credential credential)
                 throws org.opensaml.security.SecurityException

Specified by:

generate in interface KeyInfoGenerator

Throws:

org.opensaml.security.SecurityException

processKeyNames

protected void processKeyNames(@Nonnull
                   KeyInfo keyInfo,
                   @Nonnull
                   org.opensaml.security.credential.Credential credential)

Process the values of Credential.getKeyNames().

Parameters:

keyInfo - the KeyInfo that is being built

credential - the Credential that is geing processed

processEntityID

protected void processEntityID(@Nonnull
                   KeyInfo keyInfo,
                   @Nonnull
                   org.opensaml.security.credential.Credential credential)

Process the value of Credential.getEntityId().

Parameters:

keyInfo - the KeyInfo that is being built

credential - the Credential that is geing processed

processPublicKey

protected void processPublicKey(@Nonnull
                    KeyInfo keyInfo,
                    @Nonnull
                    org.opensaml.security.credential.Credential credential)
                         throws org.opensaml.security.SecurityException

Process the value of Credential.getPublicKey().

Parameters:

keyInfo - the KeyInfo that is being built

credential - the Credential that is being processed

Throws:

org.opensaml.security.SecurityException - if the public key can't be encoded properly