org.opensaml.soap.wssecurity.messaging.impl

Class AddTimestampHandler

java.lang.Object

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

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

org.opensaml.soap.messaging.AbstractHeaderGeneratingMessageHandler

org.opensaml.soap.wssecurity.messaging.impl.AddTimestampHandler

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 AddTimestampHandler
extends AbstractHeaderGeneratingMessageHandler

Handler implementation that adds a wsse:Timestamp header to the wsse:Security header of the outbound SOAP envelope.

Field Summary

Fields

Modifier and Type	Field and Description
private org.opensaml.messaging.context.navigate.ContextDataLookupFunction<org.opensaml.messaging.context.MessageContext,DateTime>	createdLookup Context lookup function for the Created time.
private DateTime	createdValue The effective Created value to use.
private org.opensaml.messaging.context.navigate.ContextDataLookupFunction<org.opensaml.messaging.context.MessageContext,DateTime>	expiresLookup Context lookup function for the Expires time.
private Long	expiresOffsetFromCreated Parameter indicating the offset from Created, in milliseconds, used to calculate the Expires time, if no Expires value is explicitly supplied via the other supported mechanisms.
private DateTime	expiresValue The effective Expires value to use.
private Logger	log Logger.
private boolean	useCurrentTimeAsDefaultCreated Flag indicating whether to use the current time as the Created time, if no value is explicitly supplied by the other supported mechanisms.

Constructor Summary

Constructors

Constructor and Description
AddTimestampHandler()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doInvoke(org.opensaml.messaging.context.MessageContext messageContext)
protected boolean	doPreInvoke(org.opensaml.messaging.context.MessageContext messageContext)
org.opensaml.messaging.context.navigate.ContextDataLookupFunction<org.opensaml.messaging.context.MessageContext,DateTime>	getCreatedLookup() Get the context lookup function for the Created time.
protected DateTime	getCreatedValue(org.opensaml.messaging.context.MessageContext messageContext) Get the Created value.
org.opensaml.messaging.context.navigate.ContextDataLookupFunction<org.opensaml.messaging.context.MessageContext,DateTime>	getExpiresLookup() Get the context lookup function for the Expires time.
Long	getExpiresOffsetFromCreated() Get the parameter indicating the offset from Created, in milliseconds, used to calculate the Expires time, if no Expires value is explicitly supplied via the other supported mechanisms.
protected DateTime	getExpiresValue(org.opensaml.messaging.context.MessageContext messageContext, DateTime created) Get the Expires value.
boolean	isUseCurrentTimeAsDefaultCreated() Get the flag indicating whether to use the current time as the Created time, if no value is explicitly supplied by the other supported mechanisms.
void	setCreatedLookup(org.opensaml.messaging.context.navigate.ContextDataLookupFunction<org.opensaml.messaging.context.MessageContext,DateTime> lookup) Set the context lookup function for the Created time.
void	setExpiresLookup(org.opensaml.messaging.context.navigate.ContextDataLookupFunction<org.opensaml.messaging.context.MessageContext,DateTime> lookup) Set the context lookup function for the Expires time.
void	setExpiresOffsetFromCreated(Long value) Set the parameter indicating the offset from Created, in milliseconds, used to calculate the Expires time, if no Expires value is explicitly supplied via the other supported mechanisms.
void	setUseCurrentTimeAsDefaultCreated(boolean flag) Set the flag indicating whether to use the current time as the Created time, if no value is explicitly supplied by the other supported mechanisms.

Methods inherited from class org.opensaml.soap.messaging.AbstractHeaderGeneratingMessageHandler

decorateGeneratedHeader, getEffectiveTargetNode, isEffectiveMustUnderstand, setMustUnderstand, setMustUnderstandStrategy, setTargetNode, setTargetNodeStrategy

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

private Logger log

Logger.

createdLookup

private org.opensaml.messaging.context.navigate.ContextDataLookupFunction<org.opensaml.messaging.context.MessageContext,DateTime> createdLookup

Context lookup function for the Created time.

expiresLookup

private org.opensaml.messaging.context.navigate.ContextDataLookupFunction<org.opensaml.messaging.context.MessageContext,DateTime> expiresLookup

Context lookup function for the Expires time.

useCurrentTimeAsDefaultCreated

private boolean useCurrentTimeAsDefaultCreated

Flag indicating whether to use the current time as the Created time, if no value is explicitly supplied by the other supported mechanisms.

expiresOffsetFromCreated

private Long expiresOffsetFromCreated

Parameter indicating the offset from Created, in milliseconds, used to calculate the Expires time, if no Expires value is explicitly supplied via the other supported mechanisms.

createdValue

private DateTime createdValue

The effective Created value to use.

expiresValue

private DateTime expiresValue

The effective Expires value to use.

Constructor Detail

AddTimestampHandler

public AddTimestampHandler()

Method Detail

getCreatedLookup

@Nullable
public org.opensaml.messaging.context.navigate.ContextDataLookupFunction<org.opensaml.messaging.context.MessageContext,DateTime> getCreatedLookup()

Get the context lookup function for the Created time.

Returns:

the lookup function

setCreatedLookup

public void setCreatedLookup(@Nullable
                    org.opensaml.messaging.context.navigate.ContextDataLookupFunction<org.opensaml.messaging.context.MessageContext,DateTime> lookup)

Set the context lookup function for the Created time.

Parameters:

lookup - the lookup function

getExpiresLookup

@Nullable
public org.opensaml.messaging.context.navigate.ContextDataLookupFunction<org.opensaml.messaging.context.MessageContext,DateTime> getExpiresLookup()

Get the context lookup function for the Expires time.

Returns:

the lookup function

setExpiresLookup

public void setExpiresLookup(@Nullable
                    org.opensaml.messaging.context.navigate.ContextDataLookupFunction<org.opensaml.messaging.context.MessageContext,DateTime> lookup)

Set the context lookup function for the Expires time.

Parameters:

lookup - the lookup function

isUseCurrentTimeAsDefaultCreated

public boolean isUseCurrentTimeAsDefaultCreated()

Get the flag indicating whether to use the current time as the Created time, if no value is explicitly supplied by the other supported mechanisms.

Returns:

true if should use current time, false if not

setUseCurrentTimeAsDefaultCreated

public void setUseCurrentTimeAsDefaultCreated(boolean flag)

Set the flag indicating whether to use the current time as the Created time, if no value is explicitly supplied by the other supported mechanisms.

Parameters:

flag - true if should use currnet time, false if not

getExpiresOffsetFromCreated

@Nullable
public Long getExpiresOffsetFromCreated()

Get the parameter indicating the offset from Created, in milliseconds, used to calculate the Expires time, if no Expires value is explicitly supplied via the other supported mechanisms.

Returns:

the expires offset, or null

setExpiresOffsetFromCreated

public void setExpiresOffsetFromCreated(@Nullable
                               Long value)

Set the parameter indicating the offset from Created, in milliseconds, used to calculate the Expires time, if no Expires value is explicitly supplied via the other supported mechanisms.

Parameters:

value - the expires off set, or null

doPreInvoke

protected boolean doPreInvoke(@Nonnull
                  org.opensaml.messaging.context.MessageContext messageContext)
                       throws org.opensaml.messaging.handler.MessageHandlerException

Overrides:

doPreInvoke in class AbstractHeaderGeneratingMessageHandler

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

getCreatedValue

@Nullable
protected DateTime getCreatedValue(@Nonnull
                                org.opensaml.messaging.context.MessageContext messageContext)

Get the Created value.

Parameters:

messageContext - the current message context

Returns:

the effective Created DateTime value to use

getExpiresValue

@Nullable
protected DateTime getExpiresValue(@Nonnull
                                org.opensaml.messaging.context.MessageContext messageContext,
                                @Nullable
                                DateTime created)

Get the Expires value.

Parameters:

messageContext - the current message context

created - the created value, if any

Returns:

the effective Expires DateTime value to use