org.hawkular.btm.api.model.btxn

Class CorrelationIdentifier

java.lang.Object

org.hawkular.btm.api.model.btxn.CorrelationIdentifier

public class CorrelationIdentifier
extends Object

This class represents a Correlation Identifier. These identifies are used to link information generated by multiple systems involved in the execution of a business transaction instance.

Author:

gbrown

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CorrelationIdentifier.Scope This enumerated value represents the scope of the correlation identifier.

Constructor Summary

Constructors

Constructor and Description
CorrelationIdentifier()
CorrelationIdentifier(CorrelationIdentifier.Scope scope, String value)
CorrelationIdentifier(CorrelationIdentifier.Scope scope, String value, int duration)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getDuration()
CorrelationIdentifier.Scope	getScope()
String	getValue()
int	hashCode()
protected static boolean	isOverlap(long baseTime1, int duration1, long baseTime2, int duration2) This method determines whether there is an overlap between the time periods represented by the two base times and their durations.
boolean	match(long thisBaseTime, CorrelationIdentifier cid, long cidBaseTime) This method determines whether the supplied correlation identifier, associated with a base time, matches this correlation identifier associated with its own base time.
void	setDuration(int duration)
void	setScope(CorrelationIdentifier.Scope scope)
void	setValue(String value)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CorrelationIdentifier

public CorrelationIdentifier()

CorrelationIdentifier

public CorrelationIdentifier(CorrelationIdentifier.Scope scope,
                             String value)

CorrelationIdentifier

public CorrelationIdentifier(CorrelationIdentifier.Scope scope,
                             String value,
                             int duration)

Method Detail

getValue

public String getValue()

Returns:

the value

setValue

public void setValue(String value)

Parameters:

value - the value to set

getScope

public CorrelationIdentifier.Scope getScope()

Returns:

the scope

setScope

public void setScope(CorrelationIdentifier.Scope scope)

Parameters:

scope - the scope to set

getDuration

public int getDuration()

Returns:

the duration

setDuration

public void setDuration(int duration)

Parameters:

duration - the duration to set

match

public boolean match(long thisBaseTime,
                     CorrelationIdentifier cid,
                     long cidBaseTime)

This method determines whether the supplied correlation identifier, associated with a base time, matches this correlation identifier associated with its own base time.

Parameters:

thisBaseTime - This correlation id's base time

cid - The correlation id to match against

cidBaseTime - The base time of the correlation id to match

Returns:

Whether the correlation id matches

isOverlap

protected static boolean isOverlap(long baseTime1,
                                   int duration1,
                                   long baseTime2,
                                   int duration2)

This method determines whether there is an overlap between the time periods represented by the two base times and their durations.

Parameters:

baseTime1 - Base time 1

duration1 - Duration 1

baseTime2 - Base time 2

duration2 - Duration 2

Returns:

Whether there is an overlap

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object