org.opensaml.xmlsec.keyinfo.impl

Class KeyInfoResolutionContext

java.lang.Object

org.opensaml.xmlsec.keyinfo.impl.KeyInfoResolutionContext

public class KeyInfoResolutionContext
extends java.lang.Object

Resolution context class that is used to supply state information to, and to share information amongst, KeyInfoProviders.

The extensible properties map available from getProperties() may for example used to communicate state between two or more providers, or between a provider and custom logic in a particular implementation of KeyInfoCredentialResolver. It is recommended that providers and/or resolvers define and use property names in such a way as to avoid collisions with those used by other providers and resolvers, and to also clearly define the data type stored for each propery name.

Field Summary

Fields

Modifier and Type	Field and Description
private java.security.Key	key Get the key currently known to be represented by the KeyInfo.
private KeyInfo	keyInfo The KeyInfo being processed.
private java.util.Set<java.lang.String>	keyNames Key names which are known to be associated with the KeyInfo being processed.
private java.util.Map<java.lang.String,java.lang.Object>	properties Extensible map of properties used to share state amongst providers and/or resolver logic.
private java.util.Collection<Credential>	resolvedCredentials This list provides KeyInfo resolvers and providers in a particular processing environment access to credentials that may have already been previously resolved.

Constructor Summary

Constructors

Constructor and Description
KeyInfoResolutionContext(java.util.Collection<Credential> credentials) Constructor.

Method Summary

Modifier and Type	Method and Description
java.security.Key	getKey() Get the key currently known to be represented by the KeyInfo.
KeyInfo	getKeyInfo() Gets the KeyInfo being processed.
java.util.Set<java.lang.String>	getKeyNames() The key names which are currently known.
java.util.Map<java.lang.String,java.lang.Object>	getProperties() Get the extensible properties map.
java.util.Collection<Credential>	getResolvedCredentials() Get the set of credentials previously resolved.
void	setKey(java.security.Key newKey) Set the key currently known to be represented by the KeyInfo.
void	setKeyInfo(KeyInfo newKeyInfo) Sets the KeyInfo being processed.

Methods inherited from class java.lang.Object

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

Field Detail

keyInfo

private KeyInfo keyInfo

The KeyInfo being processed.

keyNames

private final java.util.Set<java.lang.String> keyNames

Key names which are known to be associated with the KeyInfo being processed. These may have for example been extracted from KeyName elements present, or may have been inferred from the context in which the KeyInfo exists or is being used.

key

private java.security.Key key

Get the key currently known to be represented by the KeyInfo.

resolvedCredentials

private final java.util.Collection<Credential> resolvedCredentials

This list provides KeyInfo resolvers and providers in a particular processing environment access to credentials that may have already been previously resolved.

properties

private final java.util.Map<java.lang.String,java.lang.Object> properties

Extensible map of properties used to share state amongst providers and/or resolver logic.

Constructor Detail

KeyInfoResolutionContext

public KeyInfoResolutionContext(@Nonnull
                                java.util.Collection<Credential> credentials)

Constructor.

Parameters:

credentials - a reference to the collection in which credentials previously resolved in a processing flow are being stored

Method Detail

getKeyInfo

@Nullable
public KeyInfo getKeyInfo()

Gets the KeyInfo being processed.

Returns:

Returns the keyInfo.

setKeyInfo

public void setKeyInfo(@Nullable
                       KeyInfo newKeyInfo)

Sets the KeyInfo being processed.

Parameters:

newKeyInfo - The keyInfo to set.

getKeyNames

@Nonnull
public java.util.Set<java.lang.String> getKeyNames()

The key names which are currently known. These key names should be those which are known to be associated with the key represented by the KeyInfo being processed. These may have for example been directly extracted from KeyName elements present, or may have been inferred from the context in which the KeyInfo exists or is being used.

Returns:

the set of key names

getKey

@Nullable
public java.security.Key getKey()

Get the key currently known to be represented by the KeyInfo.

Returns:

the key currently known to be represented by the KeyInfo or null if not currently known

setKey

public void setKey(@Nullable
                   java.security.Key newKey)

Set the key currently known to be represented by the KeyInfo.

Parameters:

newKey - the new Key

getResolvedCredentials

@Nonnull
public java.util.Collection<Credential> getResolvedCredentials()

Get the set of credentials previously resolved.

Returns:

Returns the keyValueCredential.

getProperties

@Nonnull
public java.util.Map<java.lang.String,java.lang.Object> getProperties()

Get the extensible properties map.

Returns:

Returns the properties.