org.opensaml.common.binding.artifact

インタフェース SAMLArtifactMap

既知の実装クラスのリスト:

BasicSAMLArtifactMap

public interface SAMLArtifactMap

Maps an artifact to a SAML message and back again.

Artifacts must be thread safe.

An implementation of this interface MUST ensure that the persisted SAML message is no longer tied to any parent XMLObject that may have contained it. This ensures that it can be safely added to another object once retrieved from the map. This might for example be achieved by: 1) cloning the SAMLObject prior to storage, or 2) by serializing it to a string and re-parsing and unmarhsalling it once retrieved from the underlying data store. This requirement may be handled by the SAMLArtifactMap directly, or by the use of of a specific implementation of SAMLArtifactMap.SAMLArtifactMapEntryFactory.

ネストされたクラスの概要

ネストされたクラス

修飾子とタイプ	インタフェースと説明
static interface	SAMLArtifactMap.SAMLArtifactMapEntry Represents a mapping between an artifact a SAML message with some associated metadata.
static interface	SAMLArtifactMap.SAMLArtifactMapEntryFactory A factory for producing SAMLArtifactMapEntry instances based on standard inputs.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
boolean	contains(String artifact) Checks if a given artifact has a map entry.
SAMLArtifactMap.SAMLArtifactMapEntry	get(String artifact) Gets the artifact entry for the given artifact.
void	put(String artifact, String relyingPartyId, String issuerId, SAMLObject samlMessage) Creates a mapping between a given artifact and the SAML message to which it maps.
void	remove(String artifact) Removes the artifact from this map.

メソッドの詳細

contains

boolean contains(String artifact)

Checks if a given artifact has a map entry.

パラメータ:

artifact - the artifact to check

戻り値:

true of this map has an entry for the given artifact, false it not

put

void put(String artifact,
       String relyingPartyId,
       String issuerId,
       SAMLObject samlMessage)
         throws MarshallingException

Creates a mapping between a given artifact and the SAML message to which it maps.

パラメータ:

artifact - the artifact

relyingPartyId - ID of the party the artifact was sent to

issuerId - ID of the issuer of the artifact

samlMessage - the SAML message

例外:

MarshallingException - thrown if the given SAML message can not be marshalled

get

SAMLArtifactMap.SAMLArtifactMapEntry get(String artifact)

Gets the artifact entry for the given artifact.

パラメータ:

artifact - the artifact to retrieve the entry for

戻り値:

the entry or null if the artifact has already expired or did not exist

remove

void remove(String artifact)

Removes the artifact from this map.

パラメータ:

artifact - artifact to be removed