com.appdynamics.agent.api

Interface Transaction

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

NoOpTransaction

public interface Transaction
extends java.io.Closeable

Interface that defines how the consumer of the agent API can interact with transactions.

Start originating transactions through AppdynamicsAgent.startTransaction(String, String, String, boolean).

Start asynchronous segments through AppdynamicsAgent.startSegment(Object).

Method Summary

Modifier and Type	Method and Description
void	close() Ends the transaction by invoking end().
void	collectData(java.lang.String key, java.lang.String value, java.util.Set<DataScope> dataScopes) Collects data to add to a snapshot or consumption by analytics.
void	end() Ends the current transaction (and the current segment this is called from).
void	endSegment() Declares the end of the segment running on the current thread.
java.util.Map<java.lang.String,java.lang.String>	getEumMetadata() Gets a map of EUM headers for this transaction.
java.lang.String	getUniqueIdentifier() Gets the unique identifier for this transaction.
boolean	isAsyncTransaction() Informs whether the transaction is asynchronous in nature
void	markAsError(java.lang.String errorMessage) Marks the current transaction with User Experience Error and appends the provided message.
void	markHandoff(java.lang.Object commonObject) Declares the start of an asynchronous handoff.
ExitCall	startExitCall(java.util.Map<java.lang.String,java.lang.String> uniquePropertiesIdentifier, java.lang.String displayName, boolean async) Deprecated. use startExitCall(java.util.Map, java.lang.String, java.lang.String, boolean) instead.
ExitCall	startExitCall(java.util.Map<java.lang.String,java.lang.String> uniquePropertiesIdentifier, java.lang.String displayName, java.lang.String exitType, boolean async) Declares the start of an exit call.
ExitCall	startExitCall(java.lang.String uniquePropertiesIdentifier, java.lang.String displayName, boolean async) Deprecated. use startExitCall(java.lang.String, java.lang.String, java.lang.String, boolean) instead.
ExitCall	startExitCall(java.lang.String uniquePropertiesIdentifier, java.lang.String displayName, java.lang.String exitType, boolean async) Declares the start of an exit call.

Method Detail

end

void end()

Ends the current transaction (and the current segment this is called from). This can be invoked on a different thread than the transaction was started on.

startExitCall

@Deprecated
ExitCall startExitCall(java.lang.String uniquePropertiesIdentifier,
                                   java.lang.String displayName,
                                   boolean async)

Deprecated. use startExitCall(java.lang.String, java.lang.String, java.lang.String, boolean) instead.

Declares the start of a custom exit call. Add this call in a place where control is leaving the current process, either in a synchronous or asynchronous fashion.

Note: This returns a no-op ExitCall if called when an exit call already exists, or if it is otherwise unable to start a new exit call.

Parameters:

uniquePropertiesIdentifier - A String unique to this exit call (can be the same between requests)

displayName - The display name of exit call

async - Specifies if the exit call is asynchronous

Returns:

an ExitCall object to represent the exit call

startExitCall

ExitCall startExitCall(java.lang.String uniquePropertiesIdentifier,
                       java.lang.String displayName,
                       java.lang.String exitType,
                       boolean async)

Declares the start of an exit call. Add this call in a place where control is leaving the current process, either in a synchronous or asynchronous fashion.

Note: This returns a no-op ExitCall if called when an exit call already exists, or if it is otherwise unable to start a new exit call.

Parameters:

uniquePropertiesIdentifier - A String unique to this exit call (can be the same between requests)

displayName - The display name of exit call

exitType - Specifies the exit type. If this is null, then it is treated as a custom exit. For supported types, refer ExitTypes. For example, HTTP.

async - Specifies if the exit call is asynchronous

Returns:

an ExitCall object to represent the exit call

startExitCall

@Deprecated
ExitCall startExitCall(java.util.Map<java.lang.String,java.lang.String> uniquePropertiesIdentifier,
                                   java.lang.String displayName,
                                   boolean async)

Deprecated. use startExitCall(java.util.Map, java.lang.String, java.lang.String, boolean) instead.

Declares the start of a custom exit call. Add this call in a place where control is leaving the current process, either in a synchronous or asynchronous fashion.

Note: This returns a no-op ExitCall if called when an exit call already exists, or if it is otherwise unable to start a new exit call.

Parameters:

uniquePropertiesIdentifier - A map of key/value pairs used to aggregate exit calls together to the same place

displayName - The display name of exit call

async - Specifies if the exit call is asynchronous

Returns:

an ExitCall object to represent the exit call

startExitCall

ExitCall startExitCall(java.util.Map<java.lang.String,java.lang.String> uniquePropertiesIdentifier,
                       java.lang.String displayName,
                       java.lang.String exitType,
                       boolean async)

Declares the start of an exit call. Add this call in a place where control is leaving the current process, either in a synchronous or asynchronous fashion.

Note: This returns a no-op IExitCall if called when an exit call already exists, or if it is otherwise unable to start a new exit call.

Parameters:

uniquePropertiesIdentifier - A map of key/value pairs used to aggregate exit calls together to the same place

displayName - The display name of exit call

exitType - Specifies the exit type. If this is null, then it is treated as a custom exit. For supported types, refer ExitTypes. For example, HTTP.

async - Specifies if the exit call is asynchronous

Returns:

an ExitCall object to represent the exit call

markHandoff

void markHandoff(java.lang.Object commonObject)

Declares the start of an asynchronous handoff. This method works in tandem with AppdynamicsAgent.startSegment(Object) to stitch asynchronous segments together.

Ensure that the common object provided is unique to the asynchronous handoff for each request.

Parameters:

commonObject - A unique common object to link the start and execution of the asynchronous handoff.

markAsError

void markAsError(java.lang.String errorMessage)

Marks the current transaction with User Experience Error and appends the provided message.

Parameters:

errorMessage - The message to associate with the error object created.

endSegment

void endSegment()

Declares the end of the segment running on the current thread. For an asynchronous transaction, invoking in the transaction start thread takes care of ending the originating segment on the same thread.

getUniqueIdentifier

java.lang.String getUniqueIdentifier()

Gets the unique identifier for this transaction.

Returns:

The String UUID for this transaction, or null if there is no transaction

isAsyncTransaction

boolean isAsyncTransaction()

Informs whether the transaction is asynchronous in nature

Returns:

The boolean value indicating its mode

close

void close()

Ends the transaction by invoking end(). Useful in try-with-resources constructs. Overrides the thrown exception from parent interface because this close() handling does not throw any exception. For a synchronous transaction, this calls the end method, but for an asynchronous transaction it calls the endSegment() which in turn takes care of ending the originating segment on the transaction start thread.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

collectData

void collectData(java.lang.String key,
                 java.lang.String value,
                 java.util.Set<DataScope> dataScopes)

Collects data to add to a snapshot or consumption by analytics. This method is analogous to a data collector configured from the UI. If the same key is collected multiple times, the values are aggregated in an array of Strings.

Parameters:

key - The String key

value - The String value

dataScopes - A set of DataScopes specifying everywhere the data must be added

getEumMetadata

java.util.Map<java.lang.String,java.lang.String> getEumMetadata()

Gets a map of EUM headers for this transaction. This method works only after the end() method is called. The map entries are in the format [key = "ADRUM_#", value = "value"]

Returns:

A Map containing all EUM headers for this transaction