com.bankframe.services.trace
Class TimingPoint

java.lang.Object
  com.bankframe.services.trace.TimingPoint

Direct Known Subclasses:

NullTimingPoint

public class TimingPoint

extends java.lang.Object

This class is a TimingPoint. It is used in order to time events or actions within Eontec code. A Timing point records the start time, object and also a subsytem in which the timing point occur The timing point is recorded by calling the record method which will pass the timing point onto a utility class that will then process it

Field Summary

long	id The generated id associated with the timing point
java.lang.Object	request An object that represents request conditions when the timing point is created
java.lang.Object	response An object that represents response conditions when the timing point is exited

Constructor Summary

TimingPoint()
TimingPoint Constructor

TimingPoint(boolean createTimingPointId)

TimingPoint(int majorType, java.lang.String typeString, java.lang.Object request)
Deprecated. To be replaced by TimimngPointFactory.getTimingPoint

TimingPoint(long before, int majorType, java.lang.String typeString, java.lang.Object request)
Deprecated. To be replaced by TimimngPointFactory.getTimingPoint

TimingPoint(long startTime, java.lang.String name, java.lang.String subsystem, java.lang.String typeString, java.lang.Object request)
Deprecated. To be replaced by TimimngPointFactory.getTimingPoint

TimingPoint(java.lang.String name, java.lang.String subsystem, java.lang.String typeString, java.lang.Object request)
Deprecated. To be replaced by TimimngPointFactory.getTimingPoint

Method Summary

void	exit(java.lang.Object response) This method exits the timing poing and records the response object
long	getElapsedTime() This method returns the number of milliseconds elapsed since this timing began and finished.
long	getEndTime() This method will get the time at which this timing point was stopped.
int	getMajorType() This method gets the major type of this timing point
TimingPointProperties	getProperties()
long	getStartTime() This method will return the timing at which this timing point was started
java.lang.String	getSubsystem() This method gets the major type of this timing point
int	getType() This method gets the type of this timing point
java.lang.String	getUniqueName() This method will return the name of this timing point
java.lang.String	getUser() This method will return the name of the MCA user associated with the request that created this timing point
void	setProperties(TimingPointProperties properties)
DataPacket	toDataPacket() Convienience method for converting the timing point into a DataPacket
java.lang.String	toString() This method return a string description of the Timing Point This is a comma delimited string that can be analysed using external tools

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

request

public java.lang.Object request

An object that represents request conditions when the timing point is created

response

public java.lang.Object response

An object that represents response conditions when the timing point is exited

id

public long id

The generated id associated with the timing point

Constructor Detail

TimingPoint

public TimingPoint()

TimingPoint Constructor

TimingPoint

public TimingPoint(boolean createTimingPointId)

TimingPoint

public TimingPoint(java.lang.String name,
                   java.lang.String subsystem,
                   java.lang.String typeString,
                   java.lang.Object request)

Deprecated. To be replaced by TimimngPointFactory.getTimingPoint

TimingPoint Constructor

Parameters:

subsystem - The subsystem in which this TP is running

typeString - Extra information about the TP

request - The object in which this TP was started

TimingPoint

public TimingPoint(long startTime,
                   java.lang.String name,
                   java.lang.String subsystem,
                   java.lang.String typeString,
                   java.lang.Object request)

Deprecated. To be replaced by TimimngPointFactory.getTimingPoint

TimingPoint Constructor

Parameters:

startTime - The time at which this TP started

subsystem - The subsystem in which this TP is running

typeString - Extra information about the TP

request - The object in which this TP was started

TimingPoint

public TimingPoint(int majorType,
                   java.lang.String typeString,
                   java.lang.Object request)

Deprecated. To be replaced by TimimngPointFactory.getTimingPoint

TimingPoint Constructor

Parameters:

majorType -

typeString -

request -

TimingPoint

public TimingPoint(long before,
                   int majorType,
                   java.lang.String typeString,
                   java.lang.Object request)

Deprecated. To be replaced by TimimngPointFactory.getTimingPoint

TimingPoint Constructor

Parameters:

before -

majorType -

typeString -

request -

Method Detail

setProperties

public void setProperties(TimingPointProperties properties)

getProperties

public TimingPointProperties getProperties()

exit

public void exit(java.lang.Object response)

This method exits the timing poing and records the response object

Parameters:

response - the response object

getElapsedTime

public long getElapsedTime()

This method returns the number of milliseconds elapsed since this timing began and finished. If the timing point has not beem completed then this will return the number of milliseconds between now and the start time of the timing poiny

Returns:

a number of milliseconds,

getEndTime

public long getEndTime()

This method will get the time at which this timing point was stopped. If this is -1 then the timing point has not yet been stopped

Returns:

the end time

getStartTime

public long getStartTime()

This method will return the timing at which this timing point was started

Returns:

the start time

getType

public int getType()

This method gets the type of this timing point

Returns:

the type

getSubsystem

public java.lang.String getSubsystem()

This method gets the major type of this timing point

Returns:

the major type

getUniqueName

public java.lang.String getUniqueName()

This method will return the name of this timing point

getUser

public java.lang.String getUser()

This method will return the name of the MCA user associated with the request that created this timing point

Returns:

a user name

toDataPacket

public DataPacket toDataPacket()

Convienience method for converting the timing point into a DataPacket

toString

public java.lang.String toString()

This method return a string description of the Timing Point This is a comma delimited string that can be analysed using external tools

Returns:

a String description

See Also:

Object.toString()

getMajorType

public int getMajorType()

This method gets the major type of this timing point

Returns:

the major type