org.opensaml.messaging.handler

Interface MessageHandler<MessageType>

Type Parameters:

MessageType - the type of message being handled

All Superinterfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.InitializableComponent

All Known Subinterfaces:

MessageHandlerChain<MessageType>, SOAPHandler<MessageType>

All Known Implementing Classes:

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

public interface MessageHandler<MessageType>
extends net.shibboleth.utilities.java.support.component.InitializableComponent

A message handler represents some reusable logic that may be invoked on a message context.

Method Summary

Modifier and Type	Method and Description
void	invoke(MessageContext<MessageType> messageContext) Invoke the handler on the specified message context.

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Method Detail

invoke

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

Invoke the handler on the specified message context.

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