org.hawkular.btm.client.api

Interface SessionManager

public interface SessionManager

This interface represents the business transaction collector's session manager.

Author:

gbrown

Method Summary

Modifier and Type	Method and Description
boolean	activate(String uri) 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 business transaction fragment.
boolean	activate(String uri, 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 business transaction fragment.
void	assertComplete() This method asserts that the current thread of execution is complete.
void	completeLink(String id) This method completes the link between the current thread of execution and another associated with the supplied id.
void	initiateLink(String id) This method initiates a link between this thread of execution and another one based on the supplied id.
boolean	isActive() This method determines if there is an active session associated with this thread of execution.
boolean	isLinkActive(String id) This method identifies whether a link 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	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 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 business transaction 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 will be checked against any filters that have been configured. If the URI passes, then the instrumentation rule will be permitted to proceed and create the Consumer node in the business transaction fragment.

Parameters:

uri - The URI

id - The id

Returns:

Whether the fragment is already, or can be, active

activate

boolean activate(String uri)

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 business transaction fragment. If the fragment is not currently active, then the URI 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 business transaction fragment.

Parameters:

uri - The URI

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

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 business transaction 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

initiateLink

void initiateLink(String id)

This method initiates a link between this thread of execution and another one based on the supplied id.

Parameters:

id - The id

isLinkActive

boolean isLinkActive(String id)

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

Parameters:

id - The id

Returns:

Whether the link is active

completeLink

void completeLink(String id)

This method completes the link between the current thread of execution and another associated with the supplied id. The association with the target thread will be maintained until either the target thread completes, or this method is called again with a different id.

Parameters:

id - The id associated with the target thread of execution

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.

assertComplete

void assertComplete()

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