org.jets3t.servlets.gatekeeper
Class TransactionIdProvider
java.lang.Object
org.jets3t.servlets.gatekeeper.TransactionIdProvider
- Direct Known Subclasses:
- DefaultTransactionIdProvider, ExternalUuidProvider
public abstract class TransactionIdProvider
- extends java.lang.Object
Provides a transaction ID that uniquely identifies a Gatekeeper transaction - that is, a request
and response interaction.
A transaction ID could be based on a user's session ID (available in the client information),
come from a database sequence, or any other mechanism that is likely to generate unique IDs.
- Author:
- James Murty
Constructor Summary |
TransactionIdProvider(javax.servlet.ServletConfig servletConfig)
Constructs a TransactionIdProvider. |
Method Summary |
abstract java.lang.String |
getTransactionId(GatekeeperMessage requestMessage,
ClientInformation clientInformation)
Returns a transaction ID to uniquely identify the Gatekeeper transaction - if transaction
tracking is not required this method can return an empty string. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
TransactionIdProvider
public TransactionIdProvider(javax.servlet.ServletConfig servletConfig)
throws javax.servlet.ServletException
- Constructs a TransactionIdProvider.
- Parameters:
servletConfig
-
- Throws:
javax.servlet.ServletException
getTransactionId
public abstract java.lang.String getTransactionId(GatekeeperMessage requestMessage,
ClientInformation clientInformation)
- Returns a transaction ID to uniquely identify the Gatekeeper transaction - if transaction
tracking is not required this method can return an empty string.
- Parameters:
requestMessage
- clientInformation
-
- Returns:
- an ID unique to this transaction.