org.hawkular.btm.client.manager

Class RuleHelper

java.lang.Object

org.jboss.byteman.rule.helper.Helper

org.hawkular.btm.client.manager.RuleHelper

All Implemented Interfaces:

SessionManager

public class RuleHelper
extends org.jboss.byteman.rule.helper.Helper
implements SessionManager

This class provides utility functions for use in byteman conditions.

Author:

gbrown

Field Summary

Fields inherited from class org.jboss.byteman.rule.helper.Helper

rule

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RuleHelper(org.jboss.byteman.rule.Rule rule)

Method Summary

Modifier and Type	Method and Description
boolean	activate(String uri)
boolean	activate(String uri, String id)
void	appendInBuffer(Object obj, byte[] data, int offset, int len, boolean close) This method appends data to the buffer associated with the supplied object.
void	appendOutBuffer(Object obj, byte[] data, int offset, int len, boolean close) This method appends data to the buffer associated with the supplied object.
void	assertComplete()
<T> T	cast(Object obj, Class<T> clz) This method casts the supplied object to the nominated class.
BusinessTransactionCollector	collector() This method returns the business transaction collector.
void	completeCorrelation(String id)
void	correlate(String id)
ArrayBuilder	createArrayBuilder() This method creates a new parameter array builder.
InputStream	createInInputStream(InputStream is) This method returns an instrumented proxy input stream, to wrap the supplied output stream, which will record the written data.
OutputStream	createInOutputStream(OutputStream os) This method returns an instrumented proxy output stream, to wrap the supplied output stream, which will record the written data.
OutputStream	createInOutputStream(OutputStream os, String linkId) This method returns an instrumented proxy output stream, to wrap the supplied output stream, which will record the written data.
InputStream	createOutInputStream(InputStream is) This method returns an instrumented proxy input stream, to wrap the supplied output stream, which will record the written data.
OutputStream	createOutOutputStream(OutputStream os) This method returns an instrumented proxy output stream, to wrap the supplied output stream, which will record the written data.
OutputStream	createOutOutputStream(OutputStream os, String linkId) This method returns an instrumented proxy output stream, to wrap the supplied output stream, which will record the written data.
String	createUUID() This method creates a unique id.
String	faultDescription(Object fault) This method gets the description of the supplied fault.
String	faultName(Object fault) This method gets the name of the supplied fault.
String	getBusinessTransactionName() This method returns the business transaction name.
protected FaultDescriptor	getFaultDescriptor(Object fault) This method attempts to locate a descriptor for the fault.
Map<String,String>	getHeaders(String type, Object target) This method attempts to provide headers for the supplied target object.
protected HeadersAccessor	getHeadersAccessor(String type) This method returns the headers accessor for the supplied type.
String	getID(String type, Object obj) This method returns an ID associated with the supplied type and object.
String	getRuleName() This method returns the name of the instrumentation rule.
int	hashCode(Object obj) This method returns the hash code for the supplied object.
void	initiateCorrelation(String id)
void	initInBuffer(Object obj) This method initialises a data buffer associated with the supplied object.
void	initOutBuffer(Object obj) This method initialises a data buffer associated with the supplied object.
boolean	isActive()
boolean	isCorrelated(String id)
boolean	isInBufferActive(Object obj) This method determines if there is an active in data buffer for the supplied object.
boolean	isInContentProcessed() This method determines if the in content is processed.
boolean	isInProcessed() This method determines if the in headers or content is processed.
boolean	isInstanceOf(Object obj, Class<?> clz) This method determines whether the supplied object is an instance of the supplied class/interface.
boolean	isOutBufferActive(Object obj) This method determines if there is an active out data buffer for the supplied object.
boolean	isOutContentProcessed() This method determines if the out content is processed.
boolean	isOutProcessed() This method determines if the out headers or content is processed.
void	recordInBuffer(Object obj) This method records the data within a buffer associated with the supplied object.
void	recordOutBuffer(Object obj) This method records the data within a buffer associated with the supplied object.
void	releaseNode(String id)
String	removeSuffix(String original, String suffix) This method removes the supplied suffix (if it exists) in the supplied 'original' string.
void	retainNode(String id)
Node	retrieveNode(String id)
String	simpleClassName(Object obj) This method returns the simple class name of the supplied object.
void	suppress()
String	toString(Object obj) This method returns the string representation of the supplied object.
void	unlink()

Methods inherited from class org.jboss.byteman.rule.helper.Helper

activated, addCountDown, callerCheck, callerEquals, callerEquals, callerEquals, callerEquals, callerEquals, callerEquals, callerEquals, callerEquals, callerEquals, callerMatches, callerMatches, callerMatches, callerMatches, callerMatches, callerMatches, callerMatches, callerMatches, callerMatches, clear, closeTrace, countDown, createCountDown, createCounter, createCounter, createJoin, createRendezvous, createRendezvous, createTimer, deactivated, debug, decrementCounter, delay, deleteCounter, deleteRendezvous, deleteTimer, flag, flagged, formatAllStacks, formatAllStacks, formatAllStacks, formatAllStacks, formatStack, formatStack, formatStack, formatStack, formatStackBetween, formatStackBetween, formatStackBetween, formatStackBetween, formatStackBetween, formatStackBetween, formatStackBetweenMatches, formatStackBetweenMatches, formatStackBetweenMatches, formatStackBetweenMatches, formatStackBetweenMatches, formatStackBetweenMatches, formatStackMatching, formatStackMatching, formatStackMatching, formatStackMatching, formatStackMatching, formatStackMatching, formatStackRange, formatThreadStack, formatThreadStack, formatThreadStack, formatThreadStack, getCountDown, getElapsedTimeFromTimer, getObjectSize, getRendezvous, getStack, incrementCounter, incrementCounter, installed, isCountDown, isJoin, isRendezvous, joinEnlist, joinWait, joinWait, killJVM, killJVM, killThread, matchIndex, openTrace, openTrace, printFrame, printlnFrame, readCounter, readCounter, rendezvous, rendezvous, resetTimer, setTriggering, signalKill, signalKill, signalThrow, signalThrow, signalWake, signalWake, toString, trace, trace, traceAllStacks, traceAllStacks, traceAllStacks, traceAllStacks, traceAllStacks, traceAllStacks, traceClose, traceln, traceln, traceOpen, traceOpen, traceStack, traceStack, traceStack, traceStack, traceStack, traceStack, traceStackBetween, traceStackBetween, traceStackBetween, traceStackBetween, traceStackBetween, traceStackBetween, traceStackBetween, traceStackBetween, traceStackBetween, traceStackBetweenMatches, traceStackBetweenMatches, traceStackBetweenMatches, traceStackBetweenMatches, traceStackBetweenMatches, traceStackBetweenMatches, traceStackBetweenMatches, traceStackBetweenMatches, traceStackBetweenMatches, traceStackMatching, traceStackMatching, traceStackMatching, traceStackMatching, traceStackMatching, traceStackMatching, traceStackMatching, traceStackMatching, traceStackMatching, traceStackRange, traceThreadStack, traceThreadStack, traceThreadStack, traceThreadStack, traceThreadStack, traceThreadStack, triggerIndex, uninstalled, waitFor, waitFor, waiting

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RuleHelper

protected RuleHelper(org.jboss.byteman.rule.Rule rule)

Parameters:

rule -

Method Detail

getRuleName

public String getRuleName()

This method returns the name of the instrumentation rule.

Returns:

The rule name

collector

public BusinessTransactionCollector collector()

This method returns the business transaction collector.

Returns:

The business transaction collector

createUUID

public String createUUID()

This method creates a unique id.

Returns:

The unique id

getID

public String getID(String type,
                    Object obj)

This method returns an ID associated with the supplied type and object.

Parameters:

type - The type represents the use (or context) of the object

obj - The object

Returns:

The id

isInstanceOf

public boolean isInstanceOf(Object obj,
                            Class<?> clz)

This method determines whether the supplied object is an instance of the supplied class/interface.

Parameters:

obj - The object

clz - The class

Returns:

Whether the object is an instance of the class

cast

public <T> T cast(Object obj,
                  Class<T> clz)

This method casts the supplied object to the nominated class. If the object cannot be cast to the provided type, then a null will be returned.

Parameters:

obj - The object

clz - The class to cast to

Returns:

The cast object, or null if the object cannot be cast

simpleClassName

public String simpleClassName(Object obj)

This method returns the simple class name of the supplied object.

Parameters:

obj - The object

Returns:

The simple class name

toString

public String toString(Object obj)

This method returns the string representation of the supplied object.

Parameters:

obj - The object

Returns:

The string representation

hashCode

public int hashCode(Object obj)

This method returns the hash code for the supplied object.

Parameters:

obj - The object

Returns:

The hash code

getFaultDescriptor

protected FaultDescriptor getFaultDescriptor(Object fault)

This method attempts to locate a descriptor for the fault.

Parameters:

fault - The fault

Returns:

The descriptor, or null if not found

faultName

public String faultName(Object fault)

This method gets the name of the supplied fault.

Parameters:

fault - The fault

Returns:

The name

faultDescription

public String faultDescription(Object fault)

This method gets the description of the supplied fault.

Parameters:

fault - The fault

Returns:

The description

removeSuffix

public String removeSuffix(String original,
                           String suffix)

This method removes the supplied suffix (if it exists) in the supplied 'original' string.

Parameters:

original - The original string

suffix - The suffix to remove

Returns:

The modified string

createArrayBuilder

public ArrayBuilder createArrayBuilder()

This method creates a new parameter array builder.

Returns:

The parameter array builder

getHeaders

public Map<String,String> getHeaders(String type,
                                     Object target)

This method attempts to provide headers for the supplied target object.

Parameters:

type - The target type

target - The target instance

Returns:

The header map

getHeadersAccessor

protected HeadersAccessor getHeadersAccessor(String type)

This method returns the headers accessor for the supplied type.

Parameters:

type - The type

Returns:

The headers accessor, or null if not found

activate

public boolean activate(String uri,
                        String id)

Specified by:

activate in interface SessionManager

activate

public boolean activate(String uri)

Specified by:

activate in interface SessionManager

isActive

public boolean isActive()

Specified by:

isActive in interface SessionManager

retainNode

public void retainNode(String id)

Specified by:

retainNode in interface SessionManager

releaseNode

public void releaseNode(String id)

Specified by:

releaseNode in interface SessionManager

retrieveNode

public Node retrieveNode(String id)

Specified by:

retrieveNode in interface SessionManager

initiateCorrelation

public void initiateCorrelation(String id)

Specified by:

initiateCorrelation in interface SessionManager

isCorrelated

public boolean isCorrelated(String id)

Specified by:

isCorrelated in interface SessionManager

correlate

public void correlate(String id)

Specified by:

correlate in interface SessionManager

completeCorrelation

public void completeCorrelation(String id)

Specified by:

completeCorrelation in interface SessionManager

unlink

public void unlink()

Specified by:

unlink in interface SessionManager

suppress

public void suppress()

Specified by:

suppress in interface SessionManager

assertComplete

public void assertComplete()

Specified by:

assertComplete in interface SessionManager

getBusinessTransactionName

public String getBusinessTransactionName()

This method returns the business transaction name.

Returns:

The business transaction name

initInBuffer

public void initInBuffer(Object obj)

This method initialises a data buffer associated with the supplied object.

Parameters:

obj - The object associated with the buffer

isInBufferActive

public boolean isInBufferActive(Object obj)

This method determines if there is an active in data buffer for the supplied object.

Parameters:

obj - The object associated with the buffer

Returns:

Whether there is an active data buffer

appendInBuffer

public void appendInBuffer(Object obj,
                           byte[] data,
                           int offset,
                           int len,
                           boolean close)

This method appends data to the buffer associated with the supplied object.

Parameters:

obj - The object associated with the buffer

data - The data to be appended

offset - The offset of the data

len - The length of data

close - Whether to close the buffer after appending the data

recordInBuffer

public void recordInBuffer(Object obj)

This method records the data within a buffer associated with the supplied object.

Parameters:

obj - The object associated with the buffer

initOutBuffer

public void initOutBuffer(Object obj)

This method initialises a data buffer associated with the supplied object.

Parameters:

obj - The object associated with the buffer

isOutBufferActive

public boolean isOutBufferActive(Object obj)

This method determines if there is an active out data buffer for the supplied object.

Parameters:

obj - The object associated with the buffer

Returns:

Whether there is an active data buffer

appendOutBuffer

public void appendOutBuffer(Object obj,
                            byte[] data,
                            int offset,
                            int len,
                            boolean close)

This method appends data to the buffer associated with the supplied object.

Parameters:

obj - The object associated with the buffer

data - The data to be appended

offset - The offset of the data

len - The length of data

close - Whether to close the buffer after appending the data

recordOutBuffer

public void recordOutBuffer(Object obj)

This method records the data within a buffer associated with the supplied object.

Parameters:

obj - The object associated with the buffer

isInProcessed

public boolean isInProcessed()

This method determines if the in headers or content is processed.

Returns:

Whether the in headers or content is processed

isInContentProcessed

public boolean isInContentProcessed()

This method determines if the in content is processed.

Returns:

Whether the in content is processed

isOutProcessed

public boolean isOutProcessed()

This method determines if the out headers or content is processed.

Returns:

Whether the out headers or content is processed

isOutContentProcessed

public boolean isOutContentProcessed()

This method determines if the out content is processed.

Returns:

Whether the out content is processed

createInOutputStream

public OutputStream createInOutputStream(OutputStream os)

This method returns an instrumented proxy output stream, to wrap the supplied output stream, which will record the written data.

Parameters:

os - The original output stream

Returns:

The instrumented output stream

createInOutputStream

public OutputStream createInOutputStream(OutputStream os,
                                         String linkId)

This method returns an instrumented proxy output stream, to wrap the supplied output stream, which will record the written data. The optional link id can be used to initiate a link with the specified id (and disassociate the business txn from the current thread).

Parameters:

os - The original output stream

linkId - The optional link id

Returns:

The instrumented output stream

createOutOutputStream

public OutputStream createOutOutputStream(OutputStream os)

This method returns an instrumented proxy output stream, to wrap the supplied output stream, which will record the written data.

Parameters:

os - The original output stream

Returns:

The instrumented output stream

createOutOutputStream

public OutputStream createOutOutputStream(OutputStream os,
                                          String linkId)

This method returns an instrumented proxy output stream, to wrap the supplied output stream, which will record the written data. The optional link id can be used to initiate a link with the specified id (and disassociate the business txn from the current thread).

Parameters:

os - The original output stream

linkId - The optional link id

Returns:

The instrumented output stream

createInInputStream

public InputStream createInInputStream(InputStream is)

This method returns an instrumented proxy input stream, to wrap the supplied output stream, which will record the written data.

Parameters:

is - The original input stream

Returns:

The instrumented input stream

createOutInputStream

public InputStream createOutInputStream(InputStream is)

This method returns an instrumented proxy input stream, to wrap the supplied output stream, which will record the written data.

Parameters:

is - The original input stream

Returns:

The instrumented input stream