CheckMessageVersionHandler (OpenSAML 4.3.3-SNAPSHOT API)

java.lang.Object
- net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
- - org.opensaml.messaging.handler.AbstractMessageHandler
  - - org.opensaml.saml.common.binding.impl.CheckMessageVersionHandler

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, MessageHandler
```
public class CheckMessageVersionHandler
extends AbstractMessageHandler
```
Handler that checks whether a SAML message has an appropriate version.

Field Summary

Fields
Modifier and Type	Field	Description
`private boolean`	`ignoreMissingOrUnrecognized`	Flag controlling handling of missing or unrecognized messages.
`private org.slf4j.Logger`	`log`	Class logger.

Constructor Summary

Constructors
Constructor Description

CheckMessageVersionHandler()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`doInvoke(MessageContext messageContext)`	Performs the handler logic.
`void`	`setIgnoreMissingOrUnrecognized(boolean flag)`	Set whether to ignore cases where a message does not exist or is not recognized.

Methods inherited from class org.opensaml.messaging.handler.AbstractMessageHandler
doPostInvoke, doPostInvoke, doPreInvoke, 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 final org.slf4j.Logger log
```
    Class logger.
  - ignoreMissingOrUnrecognized
```
private boolean ignoreMissingOrUnrecognized
```
    Flag controlling handling of missing or unrecognized messages.
- Constructor Detail
  - CheckMessageVersionHandler
```
public CheckMessageVersionHandler()
```
- Method Detail
  - setIgnoreMissingOrUnrecognized
```
public void setIgnoreMissingOrUnrecognized(boolean flag)
```
    Set whether to ignore cases where a message does not exist or is not recognized.
    
    Parameters:
    
    flag - flag to set
  - 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