org.opensaml.ws.security.provider

クラス BaseTrustEngineRule<TokenType>

java.lang.Object

org.opensaml.ws.security.provider.BaseTrustEngineRule<TokenType>

型パラメータ:

TokenType - type of token which is being evaluated by the underlying trust engine

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

SecurityPolicyRule

直系の既知のサブクラス:

BaseSAMLXMLSignatureSecurityPolicyRule, ClientCertAuthRule

public abstract class BaseTrustEngineRule<TokenType>
extends Object
implements SecurityPolicyRule

Base rule which uses a trust engine to evaluate a token extracted from the request or message.

コンストラクタの概要

コンストラクタ

コンストラクタと説明
BaseTrustEngineRule(TrustEngine<TokenType> engine) Constructor.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
protected abstract CriteriaSet	buildCriteriaSet(String entityID, MessageContext messageContext) Subclasses are required to implement this method to build a criteria set for the trust engine according to trust engine and application-specific needs.
protected boolean	evaluate(TokenType token, CriteriaSet criteriaSet) Evaluate the token against the specified criteria using the configured trust engine.
protected boolean	evaluate(TokenType token, String entityID, MessageContext messageContext) Evaluate the token using the configured trust engine against criteria built using the specified candidate issuer entity ID and message context information.
protected TrustEngine<TokenType>	getTrustEngine() Gets the engine used to validate the untrusted token.

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

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

インタフェースから継承されたメソッド org.opensaml.ws.security.SecurityPolicyRule

evaluate

コンストラクタの詳細

BaseTrustEngineRule

public BaseTrustEngineRule(TrustEngine<TokenType> engine)

Constructor.

パラメータ:

engine - Trust engine used to verify the particular token type

メソッドの詳細

getTrustEngine

protected TrustEngine<TokenType> getTrustEngine()

Gets the engine used to validate the untrusted token.

戻り値:

engine engine used to validate the untrusted token

buildCriteriaSet

protected abstract CriteriaSet buildCriteriaSet(String entityID,
                           MessageContext messageContext)
                                         throws SecurityPolicyException

Subclasses are required to implement this method to build a criteria set for the trust engine according to trust engine and application-specific needs.

パラメータ:

entityID - the candidate issuer entity ID which is being evaluated

messageContext - the message context which is being evaluated

戻り値:

a newly constructly set of criteria suitable for the configured trust engine

例外:

SecurityPolicyException - thrown if criteria set can not be constructed

evaluate

protected boolean evaluate(TokenType token,
               String entityID,
               MessageContext messageContext)
                    throws SecurityPolicyException

Evaluate the token using the configured trust engine against criteria built using the specified candidate issuer entity ID and message context information.

パラメータ:

token - the token to be evaluated

entityID - the candidate issuer entity ID which is being evaluated

messageContext - the message context which is being evaluated

戻り値:

true if the token satisfies the criteria as determined by the trust engine, otherwise false

例外:

SecurityPolicyException - thrown if there is a fatal error during trust engine evaluation

evaluate

protected boolean evaluate(TokenType token,
               CriteriaSet criteriaSet)
                    throws SecurityPolicyException

Evaluate the token against the specified criteria using the configured trust engine.

パラメータ:

token - the token to be evaluated

criteriaSet - the set of criteria against which to evaluate the token

戻り値:

true if the token satisfies the criteria as determined by the trust engine, otherwise false

例外:

SecurityPolicyException - thrown if there is a fatal error during trust engine evaluation