org.opensaml.xmlsec.keyinfo.impl

Class StaticKeyInfoGenerator

java.lang.Object

org.opensaml.xmlsec.keyinfo.impl.StaticKeyInfoGenerator

All Implemented Interfaces:

KeyInfoGenerator

public class StaticKeyInfoGenerator
extends Object
implements KeyInfoGenerator

Implementation of KeyInfoGenerator which always returns static KeyInfo data. Note that the argument to generate(Credential) is not used in generating the new KeyInfo, and so may be null. If the original KeyInfo that was passed to this instance is already the child of some other XMLObject at the time generate(Credential) is called, then a newly constructed KeyInfo object will be returned that contains the same data as the original. Otherwise, the original KeyInfo instance is returned directly.

Constructor Summary

Constructors

Constructor and Description
StaticKeyInfoGenerator(KeyInfo newKeyInfo) Constructor.

Method Summary

Modifier and Type	Method and Description
KeyInfo	generate(Credential credential) Generate a new KeyInfo object based on keying material and other information within a credential.
KeyInfo	getKeyInfo() Get the static KeyInfo object held by this generator.
void	setKeyInfo(KeyInfo newKeyInfo) Set the static KeyInfo object held by this generator.

Methods inherited from class java.lang.Object

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

Constructor Detail

StaticKeyInfoGenerator

public StaticKeyInfoGenerator(@Nonnull
                              KeyInfo newKeyInfo)

Constructor.

Parameters:

newKeyInfo - the KeyInfo used as the basis to return new KeyInfo objects from this generator

Method Detail

generate

@Nonnull
public KeyInfo generate(@Nullable
                                 Credential credential)
                          throws SecurityException

Generate a new KeyInfo object based on keying material and other information within a credential.

Specified by:

generate in interface KeyInfoGenerator

Parameters:

credential - the credential containing keying material and possibly other information

Returns:

a new KeyInfo object or null if nothing was generated

Throws:

SecurityException - thrown if there is any error generating the new KeyInfo from the credential

getKeyInfo

@Nonnull
public KeyInfo getKeyInfo()

Get the static KeyInfo object held by this generator.

Returns:

the currently held KeyInfo object

setKeyInfo

public void setKeyInfo(@Nonnull
                       KeyInfo newKeyInfo)

Set the static KeyInfo object held by this generator.

Parameters:

newKeyInfo - the new KeyInfo object