org.opensaml.common.binding.artifact

クラス BasicSAMLArtifactMap

java.lang.Object

org.opensaml.common.binding.artifact.BasicSAMLArtifactMap

すべての実装されたインタフェース:

SAMLArtifactMap

public class BasicSAMLArtifactMap
extends Object
implements SAMLArtifactMap

Basic artifact map implementation that uses a StorageService to store and retrieve artifacts.

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

インタフェースから継承されたネストされたクラス/インタフェース org.opensaml.common.binding.artifact.SAMLArtifactMap

SAMLArtifactMap.SAMLArtifactMapEntry, SAMLArtifactMap.SAMLArtifactMapEntryFactory

フィールドの概要

フィールド

修飾子とタイプ	フィールドと説明
static String	DEFAULT_STORAGE_PARTITION The default StorageService partition name to use.

コンストラクタの概要

コンストラクタ

コンストラクタと説明
BasicSAMLArtifactMap(ParserPool parser, StorageService<String,SAMLArtifactMap.SAMLArtifactMapEntry> storage, long lifetime) 推奨されていません。 replacement BasicSAMLArtifactMap(StorageService, long)
BasicSAMLArtifactMap(SAMLArtifactMap.SAMLArtifactMapEntryFactory factory, StorageService<String,SAMLArtifactMap.SAMLArtifactMapEntry> storage, long lifetime) Constructor.
BasicSAMLArtifactMap(SAMLArtifactMap.SAMLArtifactMapEntryFactory factory, StorageService<String,SAMLArtifactMap.SAMLArtifactMapEntry> storage, String storageParition, long lifetime) Constructor.
BasicSAMLArtifactMap(StorageService<String,SAMLArtifactMap.SAMLArtifactMapEntry> storage, long lifetime) Constructor.
BasicSAMLArtifactMap(StorageService<String,SAMLArtifactMap.SAMLArtifactMapEntry> storage, String storageParition, long lifetime) Constructor.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
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.

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

DEFAULT_STORAGE_PARTITION

public static final String DEFAULT_STORAGE_PARTITION

The default StorageService partition name to use.

関連項目:

定数フィールド値

コンストラクタの詳細

BasicSAMLArtifactMap

public BasicSAMLArtifactMap(ParserPool parser,
                    StorageService<String,SAMLArtifactMap.SAMLArtifactMapEntry> storage,
                    long lifetime)

推奨されていません。 replacement BasicSAMLArtifactMap(StorageService, long)

Constructor.

パラメータ:

parser - parser pool used to parse serialized messages. (Note: ParserPool arg is deprecated and no longer used).

storage - artifact mapping storage

lifetime - lifetime of an artifact in milliseconds

BasicSAMLArtifactMap

public BasicSAMLArtifactMap(StorageService<String,SAMLArtifactMap.SAMLArtifactMapEntry> storage,
                    long lifetime)

Constructor.

パラメータ:

storage - artifact mapping storage

lifetime - lifetime of an artifact in milliseconds

BasicSAMLArtifactMap

public BasicSAMLArtifactMap(StorageService<String,SAMLArtifactMap.SAMLArtifactMapEntry> storage,
                    String storageParition,
                    long lifetime)

Constructor.

パラメータ:

storage - artifact mapping storage

storageParition - name of storage service partition to use

lifetime - lifetime of an artifact in milliseconds

BasicSAMLArtifactMap

public BasicSAMLArtifactMap(SAMLArtifactMap.SAMLArtifactMapEntryFactory factory,
                    StorageService<String,SAMLArtifactMap.SAMLArtifactMapEntry> storage,
                    long lifetime)

Constructor.

パラメータ:

factory - the SAML artifact map entry factory to use

storage - artifact mapping storage

lifetime - lifetime of an artifact in milliseconds

BasicSAMLArtifactMap

public BasicSAMLArtifactMap(SAMLArtifactMap.SAMLArtifactMapEntryFactory factory,
                    StorageService<String,SAMLArtifactMap.SAMLArtifactMapEntry> storage,
                    String storageParition,
                    long lifetime)

Constructor.

パラメータ:

factory - the SAML artifact map entry factory to use

storage - artifact mapping storage

storageParition - name of storage service partition to use

lifetime - lifetime of an artifact in milliseconds

メソッドの詳細

contains

public boolean contains(String artifact)

Checks if a given artifact has a map entry.

定義:

contains インタフェース内 SAMLArtifactMap

パラメータ:

artifact - the artifact to check

戻り値:

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

get

public SAMLArtifactMap.SAMLArtifactMapEntry get(String artifact)

Gets the artifact entry for the given artifact.

定義:

get インタフェース内 SAMLArtifactMap

パラメータ:

artifact - the artifact to retrieve the entry for

戻り値:

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

put

public 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.

定義:

put インタフェース内 SAMLArtifactMap

パラメータ:

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

remove

public void remove(String artifact)

Removes the artifact from this map.

定義:

remove インタフェース内 SAMLArtifactMap

パラメータ:

artifact - artifact to be removed