com.sap.smp.client.supportability

Interface E2ETraceTransaction

public interface E2ETraceTransaction

End-To-End trace transaction. Instances of this type are thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	E2ETraceTransaction.TransactionStatus Status of the Transaction.

Method Summary

Modifier and Type	Method and Description
void	endStep(E2ETraceStep step) Deprecated. This API is not necessary as it's essentially the same as step.endStep(). Kept only to be compatible with initial API specs.
void	endTransaction() Ends the transaction including its active step, if there's one.
E2ETraceStep	getActiveStep() Returns the active E2ETraceStep for the given transaction or null if there's no active step at the time of invocation
java.lang.String	getBTX() Retrieves the Business Transaction XML (BTX) belonging to this transaction.
E2ETraceTransaction.TransactionStatus	getStatus() Returns the status of the transaction.
E2ETraceStep	startStep() Creates and starts a new E2ETraceStep in the context of this transaction.

Method Detail

endTransaction

void endTransaction()

Ends the transaction including its active step, if there's one. At the point of calling this API, all belonging steps are expected to be stopped already. If this is not the case, no exceptions are raised but the BTX will not contain the result of the unfinished step.

getBTX

java.lang.String getBTX()
                 throws E2ETraceException

Retrieves the Business Transaction XML (BTX) belonging to this transaction. Note that in case the transaction is still running then it's first closed using endTransaction().

Returns:

generated BTX, always non-null

Throws:

E2ETraceException - if the generation of the BTX has been failed

getActiveStep

E2ETraceStep getActiveStep()

Returns the active E2ETraceStep for the given transaction or null if there's no active step at the time of invocation

Returns:

active trace step or null if there's no active one presently

startStep

E2ETraceStep startStep()

Creates and starts a new E2ETraceStep in the context of this transaction. In case the transaction has already ended then null is returned. In case there's a currently running step, it ends that, starts a new one and returns it.

Note that even if a non-null trace step is returned it might still be invalidated by other threads if the enclosing transaction is ended. In this case the information collected by that trace step instance (including all its requests) will not make it into the BTX.

Returns:

newly started trace step or null if this transaction has already ended

endStep

@Deprecated
void endStep(E2ETraceStep step)

Deprecated. This API is not necessary as it's essentially the same as step.endStep(). Kept only to be compatible with initial API specs.

Ends the specified step. Does nothing in case the argument is null.

Parameters:

step - the trace step, can be null

getStatus

E2ETraceTransaction.TransactionStatus getStatus()

Returns the status of the transaction.

Returns:

status the status, always non-null