# Uses of Interface
org.opensaml.messaging.handler.MessageHandler

Packages that use MessageHandler
Package
Description
org.opensaml.messaging.error
Interfaces and classes for message-related error handling.
org.opensaml.messaging.handler
Interfaces and classes for message context handlers.
org.opensaml.messaging.handler.impl
Implementations of message context handlers.
org.opensaml.messaging.pipeline
Interfaces and classes for message processing pipelines.
org.opensaml.profile.action
Interfaces and classes for profile actions, discrete units of behavior that make up a profile.
org.opensaml.profile.action.impl
Implementations of general profile actions.
org.opensaml.saml.common.binding.impl
Implementation of SAML binding-level functionality, such as MessageHandlers.
org.opensaml.saml.common.binding.security.impl
Classes responsible for performing transport-related and basic message validation of decoded SAML messages.
org.opensaml.saml.saml1.binding.impl
General message handlers for SAML 1.x.
org.opensaml.saml.saml2.binding.impl
General message handlers for SAML 2.0.
org.opensaml.saml.saml2.binding.security.impl
Security-related message handlers for SAML 2.0.
org.opensaml.saml.saml2.wssecurity.messaging.impl
Implementation of SAML WS-Security message handler functionality.
org.opensaml.security.messaging.impl
Message handler implementations.
org.opensaml.soap.client.soap11.decoder.http.impl
SOAP 1.1 client message decoding support implementations.
org.opensaml.soap.common
Common classes shared across SOAP versions, clients, and transports.
org.opensaml.soap.messaging
SOAP messaging support components.
org.opensaml.soap.soap11.decoder.http.impl
SOAP over HTTP 1.1 message decoder and handlers.
org.opensaml.soap.wsaddressing.messaging.impl
WS-Addressing message handling components.
org.opensaml.soap.wssecurity.messaging.impl
WS-Security message handling components.
org.opensaml.xmlsec.messaging.impl
Message handlers for XML Security functionality.

## Uses of MessageHandler in org.opensaml.messaging.error

Methods in org.opensaml.messaging.error that return MessageHandler
Modifier and Type
Method
Description
`MessageHandler`
PipelineMessageErrorHandler.`getHandler()`
Deprecated, for removal: This API element is subject to removal in a future version.
Get the handler to invoke on the outbound error message.
Methods in org.opensaml.messaging.error with parameters of type MessageHandler
Modifier and Type
Method
Description
`void`
PipelineMessageErrorHandler.`setHandler(MessageHandler handler)`
Deprecated, for removal: This API element is subject to removal in a future version.
Set the handler to invoke on the outbound error message.

## Uses of MessageHandler in org.opensaml.messaging.handler

Subinterfaces of MessageHandler in org.opensaml.messaging.handler
Modifier and Type
Interface
Description
`interface`
`MessageHandlerChain`
A specialization of `MessageHandler` which represents an ordered list of message handlers which may be invoked in order.
Classes in org.opensaml.messaging.handler that implement MessageHandler
Modifier and Type
Class
Description
`class`
`AbstractHttpServletRequestMessageHandler`
Base class for message handlers that require access to an `HttpServletRequest`.
`class`
`AbstractMessageHandler`
A base abstract implementation of `MessageHandler`.
Methods in org.opensaml.messaging.handler that return types with arguments of type MessageHandler
Modifier and Type
Method
Description
`List<MessageHandler>`
MessageHandlerChain.`getHandlers()`
Get the ordered list of message handlers which comprise the handler chain.

## Uses of MessageHandler in org.opensaml.messaging.handler.impl

Classes in org.opensaml.messaging.handler.impl that implement MessageHandler
Modifier and Type
Class
Description
`class`
`AbstractMessageChannelSecurity`
Abstract base class for message handlers which populate a `MessageChannelSecurityContext` on a `BaseContext`, where the latter is located using a lookup strategy.
`class`
`BasicMessageHandlerChain`
A basic implementation of `MessageHandlerChain`.
`final class`
`CheckExpectedIssuer`
Message handler that checks that a message context's issuer matches an expected value, both supplied by a lookup function.
`final class`
`CheckMandatoryAuthentication`
Message handler that checks that a message context is authenticated.
`final class`
`CheckMandatoryIssuer`
Message handler that checks that a message context has an issuer.
`final class`
`FunctionMessageHandler`
Message handler that runs an injected function (expected to have side effects).
`class`
`HttpServletRequestValidationHandler`
Message handler that validates an HTTP request via an instance of `HttpServletRequestValidator`.
`class`
`MessageHandlerErrorStrategyAdapter`
A `MessageHandler` which wraps and invokes another handler, catches any `Throwable` which is thrown by the wrapped handler's `invoke(MessageContext)`, and applies a list of configured `TypedMessageErrorHandler` strategies.
`class`
`SchemaValidateXMLMessage`
A handler that schema validates an XML-based message.
`class`
`StaticMessageChannelSecurity`
Message handler which populates a `MessageChannelSecurityContext` based on static configuration flags.
`class`
`URLEvaluatingMessageChannelSecurity`
Message handler which populates a `MessageChannelSecurityContext` based on evaluating a target URL resolved via a configured strategy function.
Fields in org.opensaml.messaging.handler.impl declared as MessageHandler
Modifier and Type
Field
Description
`private MessageHandler`
MessageHandlerErrorStrategyAdapter.`wrappedHandler`
The wrapped message handler.
Fields in org.opensaml.messaging.handler.impl with type parameters of type MessageHandler
Modifier and Type
Field
Description
`private List<MessageHandler>`
BasicMessageHandlerChain.`members`
The list of members of the handler chain.
Methods in org.opensaml.messaging.handler.impl that return types with arguments of type MessageHandler
Modifier and Type
Method
Description
`List<MessageHandler>`
BasicMessageHandlerChain.`getHandlers()`
Get the ordered list of message handlers which comprise the handler chain.
Method parameters in org.opensaml.messaging.handler.impl with type arguments of type MessageHandler
Modifier and Type
Method
Description
`void`
BasicMessageHandlerChain.`setHandlers(List<MessageHandler> handlers)`
Set the list of message handler chain members.
Constructors in org.opensaml.messaging.handler.impl with parameters of type MessageHandler
Modifier
Constructor
Description
``
`MessageHandlerErrorStrategyAdapter(MessageHandler messageHandler, List<TypedMessageErrorHandler> typedErrorHandlers)`
Constructor.

## Uses of MessageHandler in org.opensaml.messaging.pipeline

Fields in org.opensaml.messaging.pipeline declared as MessageHandler
Modifier and Type
Field
Description
`private MessageHandler`
BasicMessagePipeline.`inboundHandler`
Inbound message handler.
`private MessageHandler`
BasicMessagePipeline.`outboundPayloadHandler`
Outbound payload message handler.
`private MessageHandler`
BasicMessagePipeline.`outboundTransportHandler`
Outbound transport message handler.
Methods in org.opensaml.messaging.pipeline that return MessageHandler
Modifier and Type
Method
Description
`MessageHandler`
BasicMessagePipeline.`getInboundMessageHandler()`
Get the (optional) inbound message handler instance.
`MessageHandler`
MessagePipeline.`getInboundMessageHandler()`
Get the (optional) inbound message handler instance.
`MessageHandler`
BasicMessagePipeline.`getOutboundPayloadMessageHandler()`
Get the (optional) outbound payload message handler instance.
`MessageHandler`
MessagePipeline.`getOutboundPayloadMessageHandler()`
Get the (optional) outbound payload message handler instance.
`MessageHandler`
BasicMessagePipeline.`getOutboundTransportMessageHandler()`
Get the (optional) outbound transport message handler instance.
`MessageHandler`
MessagePipeline.`getOutboundTransportMessageHandler()`
Get the (optional) outbound transport message handler instance.
Methods in org.opensaml.messaging.pipeline with parameters of type MessageHandler
Modifier and Type
Method
Description
`void`
BasicMessagePipeline.`setInboundHandler(MessageHandler handler)`
Set the inbound message handler.
`void`
BasicMessagePipeline.`setOutboundPayloadHandler(MessageHandler handler)`
Set the outbound payload message handler.
`void`
BasicMessagePipeline.`setOutboundTransportHandler(MessageHandler handler)`
Set the outbound transport message handler.

## Uses of MessageHandler in org.opensaml.profile.action

Classes in org.opensaml.profile.action with type parameters of type MessageHandler
Modifier and Type
Class
Description
`class`
`AbstractHandlerDelegatingProfileAction<DelegateType extends MessageHandler>`
Base class for a profile action which just delegates to an instance of `MessageHandler`.
Fields in org.opensaml.profile.action declared as MessageHandler
Modifier and Type
Field
Description
`private DelegateType`
AbstractHandlerDelegatingProfileAction.`delegate`
The message handler delegate.

## Uses of MessageHandler in org.opensaml.profile.action.impl

Fields in org.opensaml.profile.action.impl declared as MessageHandler
Modifier and Type
Field
Description
`private MessageHandler`
EncodeMessage.`messageHandler`
An optional `MessageHandler` instance to be invoked after `MessageEncoder.prepareContext()` and prior to `MessageEncoder.encode()`.
Methods in org.opensaml.profile.action.impl with parameters of type MessageHandler
Modifier and Type
Method
Description
`void`
EncodeMessage.`setMessageHandler(MessageHandler handler)`
The supplied `MessageHandler` will be invoked on the `MessageContext` after `MessageEncoder.prepareContext()`, and prior to invoking `MessageEncoder.encode()`.

## Uses of MessageHandler in org.opensaml.saml.common.binding.impl

Classes in org.opensaml.saml.common.binding.impl that implement MessageHandler
Modifier and Type
Class
Description
`class`
`AddChannelBindingsHeaderHandler`
MessageHandler to add `ChannelBindings` headers to an outgoing SOAP envelope.
`class`
`CheckMessageStatusHandler`
Message handler that raises an exception if a SAML message is a response containing an error status.
`class`
`CheckMessageVersionHandler`
Handler that checks whether a SAML message has an appropriate version.
`class`
`PopulateSignatureSigningParametersHandler`
Handler that resolves and populates `SignatureSigningParameters` on a `SecurityParametersContext` created/accessed via a lookup function, by default as an immediate child context of the target `MessageContext`.
`class`
`SAMLAddAttributeConsumingServiceHandler`
SAML `MessageHandler` that attaches an `AttributeConsumingServiceContext` to the `SAMLMetadataContext` based on the content of an `AuthnRequest` in the message context.
`class`
`SAMLMetadataLookupHandler`
Handler that attempts to locate SAML metadata for a SAML entity, and attaches it as a `SAMLMetadataContext` child of a pre-existing concrete instance of `AbstractSAMLEntityContext`.
`class`
`SAMLOutboundDestinationHandler`
Handler for outbound SAML protocol messages which adds the destination endpoint URL as the 'recipient' attribute to SAML 1 `ResponseAbstractType` messages, or as the 'destination' attribute to `RequestAbstractType` and `StatusResponseType` messages.
`class`
`SAMLProtocolAndRoleHandler`
SAML `MessageHandler` that attaches protocol and role information to a message context via `SAMLProtocolContext` and an instance of `AbstractSAMLEntityContext` objects.
`class`
`SAMLSOAPDecoderBodyHandler`
Body handler impl for use with SAML SOAP message decoders.

## Uses of MessageHandler in org.opensaml.saml.common.binding.security.impl

Classes in org.opensaml.saml.common.binding.security.impl that implement MessageHandler
Modifier and Type
Class
Description
`class`
`BaseSAMLSimpleSignatureSecurityHandler`
Base class for security-oriented message handlers which verify simple "blob" signatures computed over some components of a request.
`class`
`BaseSAMLXMLSignatureSecurityHandler`
Base class for SAML security message handlers which evaluate a signature with a signature trust engine.
`class`
`CheckAndRecordServerTLSEntityAuthenticationtHandler`
Handler implementation that checks and records the result of `HttpClient` server TLS authentication as stored in the @link `HttpClientContext` resolved via strategy function.
`class`
`EndpointURLSchemeSecurityHandler`
Class which verifies that the `Endpoint` to which a message will be delivered contains a valid URL scheme.
`class`
`InResponseToSecurityHandler`
Client-side message handler for validating that the inbound SAML response inResponseTo ID matches the corresponding outbound request ID.
`class`
`MessageLifetimeSecurityHandler`
Security message handler implementation that checks for validity of SAML message issue instant date and time.
`class`
`MessageReplaySecurityHandler`
Security message handler implementation that which checks for replay of SAML messages.
`class`
`ReceivedEndpointSecurityHandler`
Message handler which checks the validity of the SAML protocol message receiver endpoint against requirements indicated in the message.
`class`
`SAMLMDClientCertAuthSecurityHandler`
SAML specialization of `BaseClientCertAuthSecurityHandler` which provides support for X509Credential trust engine validation based on SAML metadata.
`class`
`SAMLOutboundProtocolMessageSigningHandler`
A message handler implementation that signs an outbound SAML protocol message if the message context contains an instance of `SignatureSigningParameters` as determined by `SAMLMessageSecuritySupport.getContextSigningParameters(MessageContext)`.
`class`
`SAMLProtocolMessageXMLSignatureSecurityHandler`
SAML security message handler which validates the signature (if present) on the `SAMLObject` which represents the SAML protocol message being processed.

## Uses of MessageHandler in org.opensaml.saml.saml1.binding.impl

Classes in org.opensaml.saml.saml1.binding.impl that implement MessageHandler
Modifier and Type
Class
Description
`class`
`SAML1ArtifactRequestIssuerHandler`
SAML `MessageHandler` that addresses the SAML 1.x limitation that omitted an Issuer value from protocol messages, for the specific case of artifact resolution requests.

## Uses of MessageHandler in org.opensaml.saml.saml2.binding.impl

Classes in org.opensaml.saml.saml2.binding.impl that implement MessageHandler
Modifier and Type
Class
Description
`class`
`AddConsentToResponseHandler`
MessageHandler to set the Consent attribute on a `StatusResponseType` message.
`class`
`AddECPResponseHeaderHandler`
MessageHandler to add the ECP `Response` header to an outgoing SOAP envelope.
`class`
`AddGeneratedKeyHeaderHandler`
MessageHandler to add the ECP `GeneratedKey` header to an outgoing SOAP envelope.
`class`
`AddRelayStateHeaderHandler`
MessageHandler to add the ECP `RelayState` header to an outgoing SOAP envelope.
`class`
`AddRequestAuthenticatedHeaderHandler`
MessageHandler to add the ECP `RequestAuthenticated` header to an outgoing SOAP envelope.
`class`
`CheckNoPassiveHandler`
Message handler that raises an exception if a SAML message is a response containing the `StatusCode.NO_PASSIVE` status code.
`class`
`ExtractConsentFromRequestHandler`
MessageHandler to get the Consent attribute from a `RequestAbstractType` message.
`class`
`ExtractProxiedRequestersHandler`
MessageHandler to extract the proxied chain of requesters from an `AuthnRequest` message's `Scoping` element.

## Uses of MessageHandler in org.opensaml.saml.saml2.binding.security.impl

Classes in org.opensaml.saml.saml2.binding.security.impl that implement MessageHandler
Modifier and Type
Class
Description
`class`
`ExtractChannelBindingsExtensionsHandler`
MessageHandler to process `ChannelBindings` extensions in an incoming SAML message and save them to a `ChannelBindingsContext` underneath the `MessageContext`.
`class`
`ExtractChannelBindingsHeadersHandler`
MessageHandler to process `ChannelBindings` SOAP header blocks in an incoming SOAP envelope and save them to a `ChannelBindingsContext` underneath the `SOAP11Context`.
`class`
`SAML2AuthnRequestsSignedSecurityHandler`
Message handler implementation that enforces the AuthnRequestsSigned flag of SAML 2 metadata element @{link `SPSSODescriptor`.
`class`
`SAML2HTTPPostSimpleSignSecurityHandler`
Message handler which evaluates simple "blob" signatures according to the SAML 2 HTTP-POST-SimpleSign binding.
`class`
`SAML2HTTPRedirectDeflateSignatureSecurityHandler`
Message handler which evaluates simple "blob" signatures according to the SAML 2 HTTP-Redirect DEFLATE binding.

## Uses of MessageHandler in org.opensaml.saml.saml2.wssecurity.messaging.impl

Classes in org.opensaml.saml.saml2.wssecurity.messaging.impl that implement MessageHandler
Modifier and Type
Class
Description
`class`
`WSSecuritySAML20AssertionTokenSecurityHandler`
A security handler which resolves SAML 2.0 Assertion tokens from a SOAP envelope's wsse:Security header, validates them, and makes them available via via the `WSSecurityContext`.

## Uses of MessageHandler in org.opensaml.security.messaging.impl

Classes in org.opensaml.security.messaging.impl that implement MessageHandler
Modifier and Type
Class
Description
`class`
`BaseClientCertAuthSecurityHandler`
Policy rule that checks if the client cert used to authenticate the request is valid and trusted.
`class`
`BaseTrustEngineSecurityHandler<TokenType>`
Base rule which uses a trust engine to evaluate a token extracted from the request or message.
`class`
`PopulateHttpClientSecurityParametersHandler`
Handler that resolves and populates `HttpClientSecurityParameters` on a `HttpClientSecurityContext` created/accessed via a lookup function, by default as an immediate child context of the target `MessageContext`.

## Uses of MessageHandler in org.opensaml.soap.client.soap11.decoder.http.impl

Fields in org.opensaml.soap.client.soap11.decoder.http.impl declared as MessageHandler
Modifier and Type
Field
Description
`private MessageHandler`
HttpClientResponseSOAP11Decoder.`bodyHandler`
Message handler to use in processing the message body.
Methods in org.opensaml.soap.client.soap11.decoder.http.impl that return MessageHandler
Modifier and Type
Method
Description
`MessageHandler`
HttpClientResponseSOAP11Decoder.`getBodyHandler()`
Get the configured body handler MessageHandler.
Methods in org.opensaml.soap.client.soap11.decoder.http.impl with parameters of type MessageHandler
Modifier and Type
Method
Description
`void`
HttpClientResponseSOAP11Decoder.`setBodyHandler(MessageHandler newBodyHandler)`
Set the configured body handler MessageHandler.

## Uses of MessageHandler in org.opensaml.soap.common

Subinterfaces of MessageHandler in org.opensaml.soap.common
Modifier and Type
Interface
Description
`interface`
`SOAPHandler`
Interface for `MessageHandler`s that are specific to SOAP message processing.

## Uses of MessageHandler in org.opensaml.soap.messaging

Classes in org.opensaml.soap.messaging that implement MessageHandler
Modifier and Type
Class
Description
`class`
`AbstractHeaderGeneratingMessageHandler`
Abstract base class for message handlers that generate SOAP headers.

## Uses of MessageHandler in org.opensaml.soap.soap11.decoder.http.impl

Classes in org.opensaml.soap.soap11.decoder.http.impl that implement MessageHandler
Modifier and Type
Class
Description
`class`
`EnvelopeBodyHandler`
A body handler for use with `HTTPSOAP11Decoder` that populates the context message with the SOAP Envelope.
`class`
`SimplePayloadBodyHandler`
A body handler for use with `HTTPSOAP11Decoder` that populates the context message with the payload from the SOAP Envelope Body.
Fields in org.opensaml.soap.soap11.decoder.http.impl declared as MessageHandler
Modifier and Type
Field
Description
`private MessageHandler`
HTTPSOAP11Decoder.`bodyHandler`
Message handler to use in processing the message body.
Methods in org.opensaml.soap.soap11.decoder.http.impl that return MessageHandler
Modifier and Type
Method
Description
`MessageHandler`
HTTPSOAP11Decoder.`getBodyHandler()`
Get the configured body handler MessageHandler.
Methods in org.opensaml.soap.soap11.decoder.http.impl with parameters of type MessageHandler
Modifier and Type
Method
Description
`void`
HTTPSOAP11Decoder.`setBodyHandler(MessageHandler newBodyHandler)`
Set the configured body handler MessageHandler.

## Uses of MessageHandler in org.opensaml.soap.wsaddressing.messaging.impl

Classes in org.opensaml.soap.wsaddressing.messaging.impl that implement MessageHandler
Modifier and Type
Class
Description
`class`
`AddActionHandler`
Handler implementation that adds a wsa:Action header to the outbound SOAP envelope.
`class`
`AddMessageIDHandler`
Handler implementation that adds a wsa:MessageID header to the outbound SOAP envelope.
`class`
`AddRelatesToHandler`
Handler implementation that adds a wsa:RelatesTo header to the outbound SOAP envelope.
`class`
`ExtractMessageIDHandler`
Handler implementation that handles wsa:MessageID header on the inbound SOAP envelope.
`class`
`ValidateActionHandler`
Handler implementation that checks a wsa:Action header against an expected value.

## Uses of MessageHandler in org.opensaml.soap.wssecurity.messaging.impl

Classes in org.opensaml.soap.wssecurity.messaging.impl that implement MessageHandler
Modifier and Type
Class
Description
`class`
`AddTimestampHandler`
Handler implementation that adds a wsse:Timestamp header to the wsse:Security header of the outbound SOAP envelope.

## Uses of MessageHandler in org.opensaml.xmlsec.messaging.impl

Classes in org.opensaml.xmlsec.messaging.impl that implement MessageHandler
Modifier and Type
Class
Description
`class`
`PopulateSignatureValidationParametersHandler`
Handler that resolves and populates `SignatureValidationParameters` on a `SecurityParametersContext` created/accessed via a lookup function, by default as an immediate child context of the target `MessageContext`.