# Uses of Class
org.opensaml.messaging.handler.MessageHandlerException

Packages that use MessageHandlerException
Package
Description
org.opensaml.messaging.handler
Interfaces and classes for message context handlers.
org.opensaml.messaging.handler.impl
Implementations of message context handlers.
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.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 MessageHandlerException in org.opensaml.messaging.handler

Methods in org.opensaml.messaging.handler that throw MessageHandlerException
Modifier and Type
Method
Description
`protected abstract void`
AbstractMessageHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected boolean`
AbstractMessageHandler.`doPreInvoke(MessageContext messageContext)`
Called prior to execution, handlers may override this method to perform pre-processing for a request.
`void`
AbstractMessageHandler.`invoke(MessageContext messageContext)`
Invoke the handler on the specified message context.
`void`
MessageHandler.`invoke(MessageContext messageContext)`
Invoke the handler on the specified message context.

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

Methods in org.opensaml.messaging.handler.impl that throw MessageHandlerException
Modifier and Type
Method
Description
`void`
BasicMessageHandlerChain.`doInvoke(MessageContext msgContext)`
Performs the handler logic.
`protected void`
CheckExpectedIssuer.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
CheckMandatoryAuthentication.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
CheckMandatoryIssuer.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
FunctionMessageHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
HttpServletRequestValidationHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
MessageHandlerErrorStrategyAdapter.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
SchemaValidateXMLMessage.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected boolean`
AbstractMessageChannelSecurity.`doPreInvoke(MessageContext messageContext)`
Called prior to execution, handlers may override this method to perform pre-processing for a request.
`protected boolean`
SchemaValidateXMLMessage.`doPreInvoke(MessageContext messageContext)`
Called prior to execution, handlers may override this method to perform pre-processing for a request.
`protected boolean`
URLEvaluatingMessageChannelSecurity.`doPreInvoke(MessageContext messageContext)`
Called prior to execution, handlers may override this method to perform pre-processing for a request.

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

Methods in org.opensaml.saml.common.binding.impl that throw MessageHandlerException
Modifier and Type
Method
Description
`private AttributeConsumingService`
SAMLAddAttributeConsumingServiceHandler.`attributeConsumingServiceFromRequestedAttributes()`
Generate an `AttributeConsumingService` from the `RequestedAttributes`.
`protected void`
AddChannelBindingsHeaderHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
CheckMessageStatusHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
CheckMessageVersionHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
PopulateSignatureSigningParametersHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
SAMLAddAttributeConsumingServiceHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
SAMLMetadataLookupHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
SAMLOutboundDestinationHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
SAMLProtocolAndRoleHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
SAMLSOAPDecoderBodyHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected boolean`
AddChannelBindingsHeaderHandler.`doPreInvoke(MessageContext messageContext)`
Called prior to execution, handlers may override this method to perform pre-processing for a request.
`protected boolean`
PopulateSignatureSigningParametersHandler.`doPreInvoke(MessageContext messageContext)`
Called prior to execution, handlers may override this method to perform pre-processing for a request.
`protected boolean`
SAMLAddAttributeConsumingServiceHandler.`doPreInvoke(MessageContext messageContext)`
Called prior to execution, handlers may override this method to perform pre-processing for a request.

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

Methods in org.opensaml.saml.common.binding.security.impl that throw MessageHandlerException
Modifier and Type
Method
Description
`protected CriteriaSet`
BaseSAMLSimpleSignatureSecurityHandler.`buildCriteriaSet(String entityID, MessageContext messageContext)`
Build a criteria set suitable for input to the trust engine.
`protected CriteriaSet`
BaseSAMLXMLSignatureSecurityHandler.`buildCriteriaSet(String entityID, MessageContext messageContext)`
Subclasses are required to implement this method to build a criteria set for the trust engine according to trust engine and application-specific needs.
`protected CriteriaSet`
SAMLMDClientCertAuthSecurityHandler.`buildCriteriaSet(String entityID, MessageContext messageContext)`
Subclasses are required to implement this method to build a criteria set for the trust engine according to trust engine and application-specific needs.
`protected void`
ReceivedEndpointSecurityHandler.`checkEndpointURI(MessageContext messageContext, URIComparator comparator)`
Check the validity of the SAML protocol message receiver endpoint against requirements indicated in the message.
`protected String`
BaseSAMLSimpleSignatureSecurityHandler.`deriveSignerEntityID(MessageContext messageContext)`
Derive the signer's entity ID from the message context.
`private void`
BaseSAMLSimpleSignatureSecurityHandler.`doEvaluate(byte[] signature, byte[] signedContent, String algorithmURI, MessageContext messageContext)`
Evaluate the simple signature based on information in the request and/or message context.
`protected void`
SAMLProtocolMessageXMLSignatureSecurityHandler.`doEvaluate(Signature signature, SignableSAMLObject signableObject, MessageContext messageContext)`
Perform cryptographic validation and trust evaluation on the Signature token using the configured Signature trust engine.
`protected void`
BaseSAMLSimpleSignatureSecurityHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
CheckAndRecordServerTLSEntityAuthenticationtHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
EndpointURLSchemeSecurityHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
InResponseToSecurityHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`void`
MessageLifetimeSecurityHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
MessageReplaySecurityHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
ReceivedEndpointSecurityHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
SAMLOutboundProtocolMessageSigningHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`void`
SAMLProtocolMessageXMLSignatureSecurityHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected boolean`
BaseSAMLSimpleSignatureSecurityHandler.`doPreInvoke(MessageContext messageContext)`
Called prior to execution, handlers may override this method to perform pre-processing for a request.
`protected boolean`
BaseSAMLXMLSignatureSecurityHandler.`doPreInvoke(MessageContext messageContext)`
Called prior to execution, handlers may override this method to perform pre-processing for a request.
`protected List<Credential>`
BaseSAMLSimpleSignatureSecurityHandler.`getRequestCredentials(MessageContext messageContext)`
Extract any candidate validation credentials from the request and/or message context.
`protected byte[]`
BaseSAMLSimpleSignatureSecurityHandler.`getSignature()`
Extract the signature value from the request, in the form suitable for input into `SignatureTrustEngine.validate(byte[], byte[], String, CriteriaSet, Credential)`.
`protected String`
BaseSAMLSimpleSignatureSecurityHandler.`getSignatureAlgorithm()`
Extract the signature algorithm URI value from the request.
`protected byte[]`
BaseSAMLSimpleSignatureSecurityHandler.`getSignedContent(MessageContext messageContext)`
Get the content over which to validate the signature, in the form suitable for input into `SignatureTrustEngine.validate(byte[], byte[], String, CriteriaSet, Credential)`.
`protected void`
SAMLProtocolMessageXMLSignatureSecurityHandler.`performPrevalidation(Signature signature)`
Perform pre-validation on the Signature token.
`protected abstract boolean`
BaseSAMLSimpleSignatureSecurityHandler.`ruleHandles(MessageContext messageContext)`
Determine whether the rule should handle the request, based on the unwrapped HTTP servlet request and/or message context.
`protected boolean`
BaseSAMLSimpleSignatureSecurityHandler.`validateSignature(byte[] signature, byte[] signedContent, String algorithmURI, CriteriaSet criteriaSet, List<Credential> candidateCredentials)`
Validate the simple signature.

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

Methods in org.opensaml.saml.saml1.binding.impl that throw MessageHandlerException
Modifier and Type
Method
Description
`protected void`
SAML1ArtifactRequestIssuerHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.

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

Methods in org.opensaml.saml.saml2.binding.impl that throw MessageHandlerException
Modifier and Type
Method
Description
`protected void`
AddConsentToResponseHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
AddECPResponseHeaderHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
AddGeneratedKeyHeaderHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
AddRelayStateHeaderHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
AddRequestAuthenticatedHeaderHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
CheckNoPassiveHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
ExtractConsentFromRequestHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
ExtractProxiedRequestersHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected boolean`
AddECPResponseHeaderHandler.`doPreInvoke(MessageContext messageContext)`
Called prior to execution, handlers may override this method to perform pre-processing for a request.
`protected boolean`
AddGeneratedKeyHeaderHandler.`doPreInvoke(MessageContext messageContext)`
Called prior to execution, handlers may override this method to perform pre-processing for a request.
`protected boolean`
AddRelayStateHeaderHandler.`doPreInvoke(MessageContext messageContext)`
Called prior to execution, handlers may override this method to perform pre-processing for a request.
`protected boolean`
AddRequestAuthenticatedHeaderHandler.`doPreInvoke(MessageContext messageContext)`
Called prior to execution, handlers may override this method to perform pre-processing for a request.

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

Methods in org.opensaml.saml.saml2.binding.security.impl that throw MessageHandlerException
Modifier and Type
Method
Description
`protected void`
ExtractChannelBindingsExtensionsHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
ExtractChannelBindingsHeadersHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`void`
SAML2AuthnRequestsSignedSecurityHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected boolean`
ExtractChannelBindingsExtensionsHandler.`doPreInvoke(MessageContext messageContext)`
Called prior to execution, handlers may override this method to perform pre-processing for a request.
`protected List<Credential>`
SAML2HTTPPostSimpleSignSecurityHandler.`getRequestCredentials(MessageContext samlContext)`
Extract any candidate validation credentials from the request and/or message context.
`protected boolean`
SAML2HTTPRedirectDeflateSignatureSecurityHandler.`ruleHandles(MessageContext messageContext)`
Determine whether the rule should handle the request, based on the unwrapped HTTP servlet request and/or message context.

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

Methods in org.opensaml.saml.saml2.wssecurity.messaging.impl that throw MessageHandlerException
Modifier and Type
Method
Description
`protected ValidationContext`
WSSecuritySAML20AssertionTokenSecurityHandler.`buildValidationContext(MessageContext messageContext, Assertion assertion)`
Build the Assertion ValidationContext.
`protected void`
WSSecuritySAML20AssertionTokenSecurityHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
WSSecuritySAML20AssertionTokenSecurityHandler.`processResult(ValidationContext validationContext, ValidationResult validationResult, SAML20AssertionToken token, MessageContext messageContext)`
Process the result of the token validation.

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

Methods in org.opensaml.security.messaging.impl that throw MessageHandlerException
Modifier and Type
Method
Description
`protected CriteriaSet`
BaseClientCertAuthSecurityHandler.`buildCriteriaSet(String entityID, MessageContext messageContext)`
Subclasses are required to implement this method to build a criteria set for the trust engine according to trust engine and application-specific needs.
`protected abstract CriteriaSet`
BaseTrustEngineSecurityHandler.`buildCriteriaSet(String entityID, MessageContext messageContext)`
Subclasses are required to implement this method to build a criteria set for the trust engine according to trust engine and application-specific needs.
`protected void`
BaseClientCertAuthSecurityHandler.`doEvaluate(X509Credential requestCredential, MessageContext messageContext)`
Evaluate the request credential.
`protected void`
BaseClientCertAuthSecurityHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
PopulateHttpClientSecurityParametersHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected boolean`
BaseClientCertAuthSecurityHandler.`doPreInvoke(MessageContext messageContext)`
Called prior to execution, handlers may override this method to perform pre-processing for a request.
`protected boolean`
BaseTrustEngineSecurityHandler.`doPreInvoke(MessageContext messageContext)`
Called prior to execution, handlers may override this method to perform pre-processing for a request.
`protected boolean`
PopulateHttpClientSecurityParametersHandler.`doPreInvoke(MessageContext messageContext)`
Called prior to execution, handlers may override this method to perform pre-processing for a request.
`protected boolean`
BaseTrustEngineSecurityHandler.`evaluate(TokenType token, String entityID, MessageContext messageContext)`
Evaluate the token using the configured trust engine against criteria built using the specified candidate issuer entity ID and message context information.
`protected boolean`
BaseTrustEngineSecurityHandler.`evaluate(TokenType token, CriteriaSet criteriaSet)`
Evaluate the token against the specified criteria using the configured trust engine.
`protected String`
BaseClientCertAuthSecurityHandler.`evaluateCertificateNameDerivedPresenters(X509Credential requestCredential, MessageContext messageContext)`
Evaluate candidate presenter entity ID's which may be derived from the request credential's entity certificate according to the options supplied via `CertificateNameOptions`.
`protected String`
BaseClientCertAuthSecurityHandler.`evaluateDerivedPresenters(X509Credential requestCredential, MessageContext messageContext)`
Evaluate any candidate presenter entity ID's which may be derived from the credential or other message context information.
`protected String`
BaseClientCertAuthSecurityHandler.`evaluateSubjectAltNames(X509Credential requestCredential, MessageContext messageContext)`
Evaluate the presenter entity ID as derived from the cert subject alternative names specified by types enumerated in `CertificateNameOptions.getSubjectAltNames()`.
`protected String`
BaseClientCertAuthSecurityHandler.`evaluateSubjectCommonName(X509Credential requestCredential, MessageContext messageContext)`
Evaluate the presenter entity ID as derived from the cert subject common name (CN).
`protected String`
BaseClientCertAuthSecurityHandler.`evaluateSubjectDN(X509Credential requestCredential, MessageContext messageContext)`
Evaluate the presenter entity ID as derived from the cert subject DN.

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

Methods in org.opensaml.soap.messaging that throw MessageHandlerException
Modifier and Type
Method
Description
`protected boolean`
AbstractHeaderGeneratingMessageHandler.`doPreInvoke(MessageContext messageContext)`
Called prior to execution, handlers may override this method to perform pre-processing for a request.

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

Methods in org.opensaml.soap.soap11.decoder.http.impl that throw MessageHandlerException
Modifier and Type
Method
Description
`protected void`
EnvelopeBodyHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
SimplePayloadBodyHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.

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

Methods in org.opensaml.soap.wsaddressing.messaging.impl that throw MessageHandlerException
Modifier and Type
Method
Description
`protected void`
AddActionHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
AddMessageIDHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
AddRelatesToHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
ExtractMessageIDHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected void`
ValidateActionHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected boolean`
AddActionHandler.`doPreInvoke(MessageContext messageContext)`
Called prior to execution, handlers may override this method to perform pre-processing for a request.
`protected boolean`
AddRelatesToHandler.`doPreInvoke(MessageContext messageContext)`
Called prior to execution, handlers may override this method to perform pre-processing for a request.
`protected boolean`
ValidateActionHandler.`doPreInvoke(MessageContext messageContext)`
Called prior to execution, handlers may override this method to perform pre-processing for a request.

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

Methods in org.opensaml.soap.wssecurity.messaging.impl that throw MessageHandlerException
Modifier and Type
Method
Description
`protected void`
AddTimestampHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.
`protected boolean`
AddTimestampHandler.`doPreInvoke(MessageContext messageContext)`
Called prior to execution, handlers may override this method to perform pre-processing for a request.

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

Methods in org.opensaml.xmlsec.messaging.impl that throw MessageHandlerException
Modifier and Type
Method
Description
`protected void`
PopulateSignatureValidationParametersHandler.`doInvoke(MessageContext messageContext)`
Performs the handler logic.