Package de.uplanet.lucy.server.auxiliaries

Class TanCallable

java.lang.Object

de.uplanet.lucy.server.auxiliaries.TanCallable

@VelocityVariable("Tan")
@VelocityCallable("singleton")
public final class TanCallable
extends Object

Constructor Summary

Constructors

Constructor	Description
TanCallable()

Method Summary

Modifier and Type	Method	Description
String	createTan(ISession p_session)	Create a transaction number in the scope of the given session.
String	getContextTan(de.uplanet.lucy.server.IProcessingContext p_ctx)	Get the transaction number from the processing context.
boolean	hasContextTan(de.uplanet.lucy.server.IProcessingContext p_ctx)	Check if the processing context contains a transaction number.
void	invalidateTan(ISession p_session, String p_strTan)	Invalidate the given transaction number in the scope of the given session.
void	invalidateTanAtCommitTransaction(ISession p_session, String p_strTan)	Invalidate the given transaction number in the scope of the given session when the transaction is committed.
boolean	isValidTan(ISession p_session, String p_strTan)	Check if the given transaction number is valid in the scope of the given session.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TanCallable

public TanCallable()

Method Detail

hasContextTan

public boolean hasContextTan(de.uplanet.lucy.server.IProcessingContext p_ctx)

Check if the processing context contains a transaction number.

Parameters:

p_ctx - The processing context.

Returns:

true if the processing context contains a transaction number, or false otherwise.

getContextTan

public String getContextTan(de.uplanet.lucy.server.IProcessingContext p_ctx)

Get the transaction number from the processing context.

Parameters:

p_ctx - The processing context.

Returns:

The transaction number, or null if the processing context does not contain a transaction number.

createTan

public String createTan(ISession p_session)

Create a transaction number in the scope of the given session.

Parameters:

p_session - The session.

Returns:

A new transaction number.

isValidTan

public boolean isValidTan(ISession p_session,
                          String p_strTan)

Check if the given transaction number is valid in the scope of the given session.

Parameters:

p_session - The session.

Returns:

true if the given transaction number is valid, or false otherwise.

invalidateTan

public void invalidateTan(ISession p_session,
                          String p_strTan)

Invalidate the given transaction number in the scope of the given session.

Parameters:

p_session - The session.

p_strTan - The transaction number to be invalidated.

invalidateTanAtCommitTransaction

public void invalidateTanAtCommitTransaction(ISession p_session,
                                             String p_strTan)

Invalidate the given transaction number in the scope of the given session when the transaction is committed.

It is not an error if the given transaction number is not in the scope of the given session when the transaction is committed.

Parameters:

p_session - The session.

p_strTan - The transaction number to be invalidated.