org.opensaml.messaging.handler

Class AbstractMessageHandler<MessageType>

java.lang.Object

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

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

Type Parameters:

MessageType - the type of message being handled

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, MessageHandler<MessageType>

Direct Known Subclasses:

AddChannelBindingsHeaderHandler, AddConsentToResponseHandler, AddECPResponseHeaderHandler, AddGeneratedKeyHeaderHandler, AddRelayStateHeaderHandler, AddRequestAuthenticatedHeaderHandler, BaseSAMLSimpleSignatureSecurityHandler, BaseTrustEngineSecurityHandler, BasicMessageHandlerChain, CheckMandatoryAuthentication, CheckMandatoryIssuer, CheckMessageVersionHandler, EndpointURLSchemeSecurityHandler, EnvelopeBodyHandler, ExtractChannelBindingsExtensionsHandler, ExtractChannelBindingsHeadersHandler, ExtractConsentFromRequestHandler, HTTPRequestValidationHandler, MessageLifetimeSecurityHandler, MessageReplaySecurityHandler, ReceivedEndpointSecurityHandler, SAML1ArtifactRequestIssuerHandler, SAML2AuthnRequestsSignedSecurityHandler, SAMLAddAttributeConsumingServiceHandler, SAMLMetadataLookupHandler, SAMLOutboundDestinationHandler, SAMLOutboundProtocolMessageSigningHandler, SAMLProtocolAndRoleHandler, SAMLSOAPDecoderBodyHandler, SchemaValidateXMLMessage, SimplePayloadBodyHandler

@Prototype
public abstract class AbstractMessageHandler<MessageType>
extends net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
implements MessageHandler<MessageType>

A base abstract implementation of MessageHandler.

Constructor Summary

Constructors

Constructor and Description
AbstractMessageHandler()

Method Summary

Modifier and Type	Method and Description
protected abstract void	doInvoke(MessageContext<MessageType> messageContext) Performs the handler logic.
protected void	doPostInvoke(MessageContext<MessageType> messageContext) Called after execution, handlers may override this method to perform post-processing for a request.
protected void	doPostInvoke(MessageContext<MessageType> messageContext, java.lang.Exception e) Called after execution, handlers may override this method to perform post-processing for a request.
protected boolean	doPreInvoke(MessageContext<MessageType> messageContext) Called prior to execution, handlers may override this method to perform pre-processing for a request.
protected java.lang.String	getLogPrefix() Return a prefix for logging messages for this component.
void	invoke(MessageContext<MessageType> messageContext) Invoke the handler on the specified message context.

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

Constructor Detail

AbstractMessageHandler

public AbstractMessageHandler()

Method Detail

invoke

public void invoke(@Nonnull
                   MessageContext<MessageType> messageContext)
            throws MessageHandlerException

Invoke the handler on the specified message context.

Specified by:

invoke in interface MessageHandler<MessageType>

Parameters:

messageContext - the message context on which to invoke the handler

Throws:

MessageHandlerException - if the there is an error invoking the handler on the message context

doPreInvoke

protected boolean doPreInvoke(@Nonnull
                              MessageContext<MessageType> messageContext)
                       throws MessageHandlerException

Called prior to execution, handlers may override this method to perform pre-processing for a request.

If false is returned, execution will not proceed.

If returning successfully, the last step should be to return the result of the superclass version of this method.

Parameters:

messageContext - the message context on which to invoke the handler

Returns:

true iff execution should proceed

Throws:

MessageHandlerException - if there is a problem executing the handler pre-routine

doInvoke

protected abstract void doInvoke(@Nonnull
                                 MessageContext<MessageType> messageContext)
                          throws MessageHandlerException

Performs the handler logic.

Parameters:

messageContext - the message context on which to invoke the handler

Throws:

MessageHandlerException - if there is an error invoking the handler on the message context

doPostInvoke

protected void doPostInvoke(@Nonnull
                            MessageContext<MessageType> messageContext)

Called after execution, handlers may override this method to perform post-processing for a request.

Handlers must not "fail" during this step. This method will not be called if doPreInvoke(org.opensaml.messaging.context.MessageContext<MessageType>) fails, but is called if an exception is raised by doInvoke(org.opensaml.messaging.context.MessageContext<MessageType>).

Parameters:

messageContext - the message context on which the handler was invoked

doPostInvoke

protected void doPostInvoke(@Nonnull
                            MessageContext<MessageType> messageContext,
                            @Nonnull
                            java.lang.Exception e)

Called after execution, handlers may override this method to perform post-processing for a request.

Handlers must not "fail" during this step. This method will not be called if doPreInvoke(org.opensaml.messaging.context.MessageContext<MessageType>) fails, but is called if an exception is raised by doInvoke(org.opensaml.messaging.context.MessageContext<MessageType>).

This version of the method will be called if an exception is raised during execution of the handler. The overall handler result will be to raise this error, so any errors inadvertently raised by this method will be logged and superseded.

The default implementation simply calls the error-less version of this method.

Parameters:

messageContext - the message context on which the handler was invoked

e - an exception raised by the doInvoke(org.opensaml.messaging.context.MessageContext<MessageType>) method

getLogPrefix

@Nonnull
 @NotEmpty
protected java.lang.String getLogPrefix()

Return a prefix for logging messages for this component.

Returns:

a string for insertion at the beginning of any log messages