SchemaValidateXMLMessage (OpenSAML :: Messaging Implementations 4.0.0 API)

java.lang.Object
- net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
- - org.opensaml.messaging.handler.AbstractMessageHandler
  - - org.opensaml.messaging.handler.impl.SchemaValidateXMLMessage

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, org.opensaml.messaging.handler.MessageHandler
```
public class SchemaValidateXMLMessage
extends org.opensaml.messaging.handler.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 org.opensaml.core.xml.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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`doInvoke(org.opensaml.messaging.context.MessageContext messageContext)`
`protected boolean`	`doPreInvoke(org.opensaml.messaging.context.MessageContext messageContext)`
`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 org.opensaml.core.xml.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
                              org.opensaml.messaging.context.MessageContext messageContext)
                       throws org.opensaml.messaging.handler.MessageHandlerException
```
  Overrides:
  
  doPreInvoke in class org.opensaml.messaging.handler.AbstractMessageHandler
  
  Throws:
  
  org.opensaml.messaging.handler.MessageHandlerException
- doInvoke
```
protected void doInvoke(@Nonnull
                        org.opensaml.messaging.context.MessageContext messageContext)
                 throws org.opensaml.messaging.handler.MessageHandlerException
```
  Specified by:
  
  doInvoke in class org.opensaml.messaging.handler.AbstractMessageHandler
  
  Throws:
  
  org.opensaml.messaging.handler.MessageHandlerException