org.opensaml.saml.common.binding.security.impl

Class MessageReplaySecurityHandler

java.lang.Object

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

org.opensaml.messaging.handler.AbstractMessageHandler

org.opensaml.saml.common.binding.security.impl.MessageReplaySecurityHandler

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

public class MessageReplaySecurityHandler
extends AbstractMessageHandler

Security message handler implementation that which checks for replay of SAML messages.

Field Summary

Fields

Modifier and Type	Field and Description
private long	expires Time in milliseconds to expire cache entries.
private org.slf4j.Logger	log Logger.
private ReplayCache	replayCache Message replay cache instance to use.
private boolean	requiredRule Whether this rule is required to be met.

Constructor Summary

Constructors

Constructor and Description
MessageReplaySecurityHandler() Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	doInitialize()
protected void	doInvoke(MessageContext messageContext) Performs the handler logic.
long	getExpires() Gets the lifetime in milliseconds of replay entries.
ReplayCache	getReplayCache() Get the replay cache instance to use.
void	setExpires(long exp) Sets the lifetime in seconds of replay entries.
void	setReplayCache(ReplayCache cache) Set the replay cache instance to use.
void	setRequiredRule(boolean flag) Set whether this rule is required to be met.

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

doPostInvoke, doPostInvoke, doPreInvoke, getLogPrefix, invoke

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, 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

Logger.

replayCache

@NonnullAfterInit
private ReplayCache replayCache

Message replay cache instance to use.

requiredRule

private boolean requiredRule

Whether this rule is required to be met.

expires

@Duration
 @NonNegative
private long expires

Time in milliseconds to expire cache entries. Default value: (180)

Constructor Detail

MessageReplaySecurityHandler

public MessageReplaySecurityHandler()

Constructor.

Method Detail

getReplayCache

@NonnullAfterInit
public ReplayCache getReplayCache()

Get the replay cache instance to use.

Returns:

Returns the replayCache.

setReplayCache

public void setReplayCache(@Nonnull
                           ReplayCache cache)

Set the replay cache instance to use.

Parameters:

cache - The replayCache to set.

setRequiredRule

public void setRequiredRule(boolean flag)

Set whether this rule is required to be met.

Parameters:

flag - flag to set

getExpires

@NonNegative
public long getExpires()

Gets the lifetime in milliseconds of replay entries.

Returns:

lifetime in milliseconds of entries

setExpires

public void setExpires(@Duration @NonNegative
                       long exp)

Sets the lifetime in seconds of replay entries.

Parameters:

exp - lifetime in seconds of entries

doInitialize

protected void doInitialize()
                     throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Overrides:

doInitialize in class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException

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