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

Class SAMLOutboundProtocolMessageSigningHandler

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

org.opensaml.messaging.handler.AbstractMessageHandler<SAMLObject>

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

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, org.opensaml.messaging.handler.MessageHandler<SAMLObject>

public class SAMLOutboundProtocolMessageSigningHandler
extends org.opensaml.messaging.handler.AbstractMessageHandler<SAMLObject>

A message handler implementation that signs an outbound SAML protocol message if the message context contains an instance of org.opensaml.xmlsec.context.SignatureSigningParameters as determined by SAMLMessageSecuritySupport.getContextSigningParameters(MessageContext).

Field Summary

Fields

Modifier and Type	Field and Description
private Logger	log Logger.
private boolean	signErrorResponses Whether to sign responses containing errors.

Constructor Summary

Constructors

Constructor and Description
SAMLOutboundProtocolMessageSigningHandler() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doInvoke(org.opensaml.messaging.context.MessageContext<SAMLObject> messageContext)
private boolean	isErrorResponse(SAMLObject message) Get whether the message is a SAML response containing an error status.
void	setSignErrorResponses(boolean flag) Set whether to sign response messages that contain errors (defaults to true).

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

doPostInvoke, doPostInvoke, doPreInvoke, getLogPrefix, invoke

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, doInitialize, 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.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Field Detail

log

@Nonnull
private final Logger log

Logger.

signErrorResponses

private boolean signErrorResponses

Whether to sign responses containing errors.

Constructor Detail

SAMLOutboundProtocolMessageSigningHandler

public SAMLOutboundProtocolMessageSigningHandler()

Constructor.

Method Detail

setSignErrorResponses

public void setSignErrorResponses(boolean flag)

Set whether to sign response messages that contain errors (defaults to true).

Parameters:

flag - flag to set

doInvoke

protected void doInvoke(@Nonnull
            org.opensaml.messaging.context.MessageContext<SAMLObject> messageContext)
                 throws org.opensaml.messaging.handler.MessageHandlerException

Specified by:

doInvoke in class org.opensaml.messaging.handler.AbstractMessageHandler<SAMLObject>

Throws:

org.opensaml.messaging.handler.MessageHandlerException

isErrorResponse

private boolean isErrorResponse(@Nullable
                      SAMLObject message)

Get whether the message is a SAML response containing an error status.

Parameters:

message - message to check

Returns:

true iff the message is a SAML response containing an error status