org.opensaml.messaging.handler.impl

Class SchemaValidateXMLMessage<MessageType extends XMLObject>

java.lang.Object

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

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

org.opensaml.messaging.handler.impl.SchemaValidateXMLMessage<MessageType>

Type Parameters:

MessageType - type of message on which to operate

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>

public class SchemaValidateXMLMessage<MessageType extends XMLObject>
extends AbstractMessageHandler<MessageType>

A handler that schema validates an XML-based message.

Field Summary

Fields

Modifier and Type	Field and Description
private org.slf4j.Logger	log Class logger.
private javax.xml.validation.Schema	validationSchema Schema used to validate incoming messages.

Constructor Summary

Constructors

Constructor and Description
SchemaValidateXMLMessage(javax.xml.validation.Schema schema) Constructor.

Method Summary

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

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

doPostInvoke, doPostInvoke, getLogPrefix, invoke

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

private org.slf4j.Logger log

Class logger.

validationSchema

private final javax.xml.validation.Schema validationSchema

Schema used to validate incoming messages.

Constructor Detail

SchemaValidateXMLMessage

public SchemaValidateXMLMessage(@Nonnull
                                javax.xml.validation.Schema schema)

Constructor.

Parameters:

schema - schema used to validate incoming messages

Method Detail

getValidationSchema

@Nonnull
public javax.xml.validation.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<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.

Overrides:

doPreInvoke in class AbstractMessageHandler<MessageType extends XMLObject>

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<MessageType> messageContext)
                 throws MessageHandlerException

Performs the handler logic.

Specified by:

doInvoke in class AbstractMessageHandler<MessageType extends XMLObject>

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