org.hawkular.apm.client.api

Interface SessionManager

public interface SessionManager

This interface represents the trace collector's session manager.

Author:

gbrown

Method Summary

Modifier and Type	Method and Description
boolean	activate(String uri, String operation) This method is a guard condition for instrumentation rules, used to determine whether the invoker should be permitted to create and record a node as part of a trace fragment.
boolean	activate(String uri, String operation, String id) This method is a guard condition for Consumer based instrumentation rules, used to determine whether the invoker should be permitted to create and record a Consumer as part of a trace fragment.
void	assertComplete() This method asserts that the current thread of execution is complete.
void	completeCorrelation(String id, boolean allowSpawn) This method ends the correlation between the current thread of execution and another associated with the supplied id.
void	correlate(String id) This method associates the current thread of execution with the session associated with the supplied correlation id.
void	deactivate() This method deactivates an active session.
Object	getState(Object context, String name, boolean session) This method returns the state associated with the name and optional context.
void	ignoreNode() This method indicates that the current node can be ignored if handled out of order.
void	initiateCorrelation(String id) This method initiates a correlation between this thread of execution and one or more based on the supplied id.
boolean	isActive() This method determines if there is an active session associated with this thread of execution.
boolean	isCorrelated(String id) This method identifies whether a correlation with the supplied id is currently active (i.e.
void	releaseNode(String id) This method indicates that the identified node, for this thread of execution, should be released.
void	retainNode(String id) This method indicates that the current node, for this thread of execution, should be retained temporarily pending further changes.
Node	retrieveNode(String id) This method returns the node associated, for this thread of execution, identified by the supplied id.
void	setState(Object context, String name, Object value, boolean session) This method stores state information associated with the name and optional context.
void	suppress() This method suppressed recording of any child nodes under the current business transaction fragment node.
void	unlink() Unlink the current "linked" thread of execution from the target thread.

Method Detail

activate

boolean activate(String uri,
                 String operation,
                 String id)

This method is a guard condition for Consumer based instrumentation rules, used to determine whether the invoker should be permitted to create and record a Consumer as part of a trace fragment. If the fragment is not currently active, then the id will be check first, and if defined then the function will return true, allowing the Consumer node to be created. If the id is null, then the URI and optional operation will be checked against any filters that have been configured. If the URI and operation passes, then the instrumentation rule will be permitted to proceed and create the Consumer node in the trace fragment.

Parameters:

uri - The URI

operation - The optional operation

id - The id

Returns:

Whether the fragment is already, or can be, active

activate

boolean activate(String uri,
                 String operation)

This method is a guard condition for instrumentation rules, used to determine whether the invoker should be permitted to create and record a node as part of a trace fragment. If the fragment is not currently active, then the URI and optional operation will be checked against any filters that have been configured. If it passes, then the instrumentation rule will be permitted to proceed and create the appropriate node in the trace fragment.

Parameters:

uri - The URI

operation - The optional operation

Returns:

Whether the fragment is already, or can be, active

isActive

boolean isActive()

This method determines if there is an active session associated with this thread of execution.

Returns:

Whether the current thread of execution has an active session

deactivate

void deactivate()

This method deactivates an active session. This will result in the current fragment builder being discarded.

retainNode

void retainNode(String id)

This method indicates that the current node, for this thread of execution, should be retained temporarily pending further changes. IMPORTANT: Make sure the node is released, as otherwise this will prevent the fragment from being completed (and therefore reported).

Parameters:

id - The identifier used to later on to identify the node

releaseNode

void releaseNode(String id)

This method indicates that the identified node, for this thread of execution, should be released. IMPORTANT: It is important that any previously retained node is released before the trace fragment can be considered complete and therefore reported.

Parameters:

id - The identifier used to identify the node

retrieveNode

Node retrieveNode(String id)

This method returns the node associated, for this thread of execution, identified by the supplied id.

Parameters:

id - The identifier used to identify the node

Returns:

The node, or null if not found

initiateCorrelation

void initiateCorrelation(String id)

This method initiates a correlation between this thread of execution and one or more based on the supplied id.

Parameters:

id - The id

isCorrelated

boolean isCorrelated(String id)

This method identifies whether a correlation with the supplied id is currently active (i.e. awaiting completion).

Parameters:

id - The id

Returns:

Whether the correlation is active

correlate

void correlate(String id)

This method associates the current thread of execution with the session associated with the supplied correlation id.

Parameters:

id - The id associated with the target thread of execution

completeCorrelation

void completeCorrelation(String id,
                         boolean allowSpawn)

This method ends the correlation between the current thread of execution and another associated with the supplied id.

Parameters:

id - The id associated with the target thread of execution

allowSpawn - Determine if completing correlation can spawn fragment if required

unlink

void unlink()

Unlink the current "linked" thread of execution from the target thread.

suppress

void suppress()

This method suppressed recording of any child nodes under the current business transaction fragment node.

ignoreNode

void ignoreNode()

This method indicates that the current node can be ignored if handled out of order.

assertComplete

void assertComplete()

This method asserts that the current thread of execution is complete. It has no impact on trace reporting, but is used as a sanity check to ensure the collection is working correctly.

setState

void setState(Object context,
              String name,
              Object value,
              boolean session)

This method stores state information associated with the name and optional context.

Parameters:

context - The optional context

name - The name

value - The value

session - Whether related to session

getState

Object getState(Object context,
                String name,
                boolean session)

This method returns the state associated with the name and optional context.

Parameters:

context - The optional context

name - The name

session - Whether related to session

Returns:

The state, or null if not found