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

Class MessageLifetimeSecurityHandler

java.lang.Object

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

org.opensaml.messaging.handler.AbstractMessageHandler

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

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 MessageLifetimeSecurityHandler
extends org.opensaml.messaging.handler.AbstractMessageHandler

Security message handler implementation that checks for validity of SAML message issue instant date and time.

Field Summary

Fields

Modifier and Type	Field and Description
private long	clockSkew Clock skew - milliseconds before a lower time bound, or after an upper time bound, to consider still acceptable Default value: 3 minutes.
private Logger	log Class logger.
private long	messageLifetime Amount of time in milliseconds for which a message is valid after it is issued.
private boolean	requiredRule Whether this rule is required to be met.

Constructor Summary

Constructors

Constructor and Description
MessageLifetimeSecurityHandler() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	doInvoke(org.opensaml.messaging.context.MessageContext messageContext)
long	getClockSkew() Get the clock skew.
long	getMessageLifetime() Gets the amount of time, in milliseconds, for which a message is valid.
boolean	isRequiredRule() Gets whether this rule is required to be met.
void	setClockSkew(long skew) Set the clock skew.
void	setMessageLifetime(long lifetime) Sets the amount of time, in milliseconds, for which a message is valid.
void	setRequiredRule(boolean required) Sets whether this rule is required to be met.

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 Logger log

Class logger.

clockSkew

@Duration
@NonNegative
private long clockSkew

Clock skew - milliseconds before a lower time bound, or after an upper time bound, to consider still acceptable Default value: 3 minutes.

messageLifetime

@Duration
@NonNegative
private long messageLifetime

Amount of time in milliseconds for which a message is valid after it is issued. Default value: 3 minutes

requiredRule

private boolean requiredRule

Whether this rule is required to be met.

Constructor Detail

MessageLifetimeSecurityHandler

public MessageLifetimeSecurityHandler()

Constructor.

Method Detail

getClockSkew

@NonNegative
@Duration
public long getClockSkew()

Get the clock skew.

Returns:

the clock skew

setClockSkew

@Duration
public void setClockSkew(@Duration@NonNegative
                         long skew)

Set the clock skew.

Parameters:

skew - clock skew to set

getMessageLifetime

@NonNegative
@Duration
public long getMessageLifetime()

Gets the amount of time, in milliseconds, for which a message is valid.

Returns:

amount of time, in milliseconds, for which a message is valid

setMessageLifetime

@Duration
public void setMessageLifetime(@Duration@NonNegative
                               long lifetime)

Sets the amount of time, in milliseconds, for which a message is valid.

Parameters:

lifetime - amount of time, in milliseconds, for which a message is valid

isRequiredRule

public boolean isRequiredRule()

Gets whether this rule is required to be met.

Returns:

whether this rule is required to be met

setRequiredRule

public void setRequiredRule(boolean required)

Sets whether this rule is required to be met.

Parameters:

required - whether this rule is required to be met

doInvoke

public 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