Package org.opensaml.saml.common.binding.security.impl

Class BaseSAMLXMLSignatureSecurityHandler

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

org.opensaml.messaging.handler.AbstractMessageHandler

org.opensaml.security.messaging.impl.BaseTrustEngineSecurityHandler<Signature>

org.opensaml.saml.common.binding.security.impl.BaseSAMLXMLSignatureSecurityHandler

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, MessageHandler

Direct Known Subclasses:

SAMLProtocolMessageXMLSignatureSecurityHandler

public abstract class BaseSAMLXMLSignatureSecurityHandler
extends BaseTrustEngineSecurityHandler<Signature>

Base class for SAML security message handlers which evaluate a signature with a signature trust engine.

Field Summary

Fields

Modifier and Type	Field	Description
private SAMLPeerEntityContext	peerContext	The context representing the SAML peer entity.
private String	samlProtocol	The SAML protocol in use.
private SAMLProtocolContext	samlProtocolContext	The SAML protocol context in operation.
private QName	samlRole	The SAML role in use.
private SignatureValidationParameters	signatureValidationParameters	Parameters for signature validation.

Constructor Summary

Constructors

Constructor	Description
BaseSAMLXMLSignatureSecurityHandler()

Method Summary

Modifier and Type	Method	Description
protected CriteriaSet	buildCriteriaSet(String entityID, MessageContext messageContext)
protected boolean	doPreInvoke(MessageContext messageContext)
protected SAMLPeerEntityContext	getSAMLPeerEntityContext()	Get the SAMLPeerEntityContext associated with the message.
protected SAMLProtocolContext	getSAMLProtocolContext()	Get the SAMLProtocolContext associated with the message.
protected TrustEngine<Signature>	resolveTrustEngine(MessageContext messageContext)

Methods inherited from class org.opensaml.security.messaging.impl.BaseTrustEngineSecurityHandler

evaluate, evaluate, getTrustEngine

Methods inherited from class org.opensaml.messaging.handler.AbstractMessageHandler

doInvoke, doPostInvoke, doPostInvoke, getActivationCondition, getLogPrefix, invoke, isPreInvokeCalled, setActivationCondition

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, doInitialize, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.shibboleth.shared.component.InitializableComponent

initialize, isInitialized

Field Details

peerContext

@Nullable
private SAMLPeerEntityContext peerContext

The context representing the SAML peer entity.

samlProtocolContext

@Nullable
private SAMLProtocolContext samlProtocolContext

The SAML protocol context in operation.

samlProtocol

@Nullable
private String samlProtocol

The SAML protocol in use.

samlRole

@Nullable
private QName samlRole

The SAML role in use.

signatureValidationParameters

@Nullable
private SignatureValidationParameters signatureValidationParameters

Parameters for signature validation.

Constructor Details

BaseSAMLXMLSignatureSecurityHandler

public BaseSAMLXMLSignatureSecurityHandler()

Method Details

getSAMLPeerEntityContext

@Nullable
protected SAMLPeerEntityContext getSAMLPeerEntityContext()

Get the SAMLPeerEntityContext associated with the message.

Returns:

the peer context

getSAMLProtocolContext

@Nullable
protected SAMLProtocolContext getSAMLProtocolContext()

Get the SAMLProtocolContext associated with the message.

Returns:

the protocol context

doPreInvoke

protected boolean doPreInvoke(@Nonnull
 MessageContext messageContext)
                       throws MessageHandlerException

Overrides:

doPreInvoke in class BaseTrustEngineSecurityHandler<Signature>

Throws:

MessageHandlerException

resolveTrustEngine

@Nullable
protected TrustEngine<Signature> resolveTrustEngine(@Nonnull
 MessageContext messageContext)

Specified by:

resolveTrustEngine in class BaseTrustEngineSecurityHandler<Signature>

buildCriteriaSet

@Nonnull
protected CriteriaSet buildCriteriaSet(@Nullable
 String entityID,
 @Nonnull
 MessageContext messageContext)
                                throws MessageHandlerException

Specified by:

buildCriteriaSet in class BaseTrustEngineSecurityHandler<Signature>

Throws:

MessageHandlerException