Package org.opensaml.messaging.handler.impl

Class SchemaValidateXMLMessage

java.lang.Object

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

org.opensaml.messaging.handler.AbstractMessageHandler

org.opensaml.messaging.handler.impl.SchemaValidateXMLMessage

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, MessageHandler

public class SchemaValidateXMLMessage
extends AbstractMessageHandler

A handler that schema validates an XML-based message.

Precondition:

MessageContext.getMessage().getDOM() != null

Field Summary

Fields

Modifier and Type	Field	Description
private org.slf4j.Logger	log	Class logger.
private XMLObject	message	The message to validate.
private Schema	validationSchema	Schema used to validate incoming messages.

Constructor Summary

Constructors

Constructor	Description
SchemaValidateXMLMessage(Schema schema)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doInvoke(MessageContext messageContext)	Performs the handler logic.
protected boolean	doPreInvoke(MessageContext messageContext)	Called prior to execution, handlers may override this method to perform pre-processing for a request.
Schema	getValidationSchema()	Gets the schema used to validate incoming messages.

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

doPostInvoke, doPostInvoke, getActivationCondition, getLogPrefix, invoke, setActivationCondition

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 org.slf4j.Logger log

Class logger.

validationSchema

@Nonnull
private final Schema validationSchema

Schema used to validate incoming messages.

message

@Nullable
private XMLObject message

The message to validate.

Constructor Detail

SchemaValidateXMLMessage

public SchemaValidateXMLMessage(@Nonnull
                                Schema schema)

Constructor.

Parameters:

schema - schema used to validate incoming messages

Method Detail

getValidationSchema

@Nonnull
public Schema getValidationSchema()

Gets the schema used to validate incoming messages.

Returns:

schema used to validate incoming messages, not null after action is initialized

doPreInvoke

protected boolean doPreInvoke(@Nonnull
                              MessageContext messageContext)
                       throws MessageHandlerException

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

The default impl applies the Predicate set via the AbstractMessageHandler.setActivationCondition(Predicate).

If false is returned, execution will not proceed.

Subclasses which override this method should generally invoke the super version of this method first, so that the activation condition will be applied up front, and immediately return false if the super version returns false. This avoids unnecessary execution of the remaining pre-invocation code if the handler ultimately will not execute.

Overrides:

doPreInvoke in class AbstractMessageHandler

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 void doInvoke(@Nonnull
                        MessageContext messageContext)
                 throws MessageHandlerException

Performs the handler logic.

Specified by:

doInvoke in class AbstractMessageHandler

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