Kieker 1.5

kieker.common.record.controlflow
Class OperationExecutionRecord

java.lang.Object
  extended by kieker.common.record.AbstractMonitoringRecord
      extended by kieker.common.record.controlflow.OperationExecutionRecord
All Implemented Interfaces:
Serializable, Comparable<IMonitoringRecord>, IMonitoringRecord, IMonitoringRecord.Factory

public final class OperationExecutionRecord
extends AbstractMonitoringRecord
implements IMonitoringRecord.Factory

String variables must not be null.

Author:
Andre van Hoorn, Jan Waller
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface kieker.common.record.IMonitoringRecord
IMonitoringRecord.Factory
 
Field Summary
static int NO_EOI_ESS
          Constant to be used if no eoi or ess required.
static String NO_HOSTNAME
          Constant to be used if no hostname required.
static String NO_SESSION_ID
          Constant to be used if no session ID required.
static long NO_TIMESTAMP
          Constant to be used if no timestamp required.
static long NO_TRACEID
          Constant to be used if no trace ID required.
 
Constructor Summary
OperationExecutionRecord()
          Deprecated. will be removed in Kieker 1.6
OperationExecutionRecord(Object[] values)
           
OperationExecutionRecord(String componentName, String methodName, long traceId)
          Deprecated. will be removed in Kieker 1.6
OperationExecutionRecord(String componentName, String opName, long tin, long tout)
          Deprecated. will be removed in Kieker 1.6
OperationExecutionRecord(String componentName, String opName, long traceId, long tin, long tout)
          Deprecated. will be removed in Kieker 1.6
OperationExecutionRecord(String operationSignature, String sessionId, long traceId, long tin, long tout, String hostname, int eoi, int ess)
          Creates a new OperationExecutionRecord with the given parameters.
OperationExecutionRecord(String componentName, String opName, String sessionId, long traceId, long tin, long tout)
          Deprecated. will be removed in Kieker 1.6
OperationExecutionRecord(String componentName, String opName, String sessionId, long traceId, long tin, long tout, String vnName, int eoi, int ess)
          Deprecated. will be removed in Kieker 1.6
 
Method Summary
 String getClassName()
          Deprecated. will be removed in Kieker 1.6
 int getEoi()
           
 int getEss()
           
 int getExperimentId()
          Deprecated. Will be removed in 1.6
 String getHostname()
           
 String getOperationName()
          Deprecated. will be removed in Kieker 1.6
 String getOperationSignature()
           
 Object getRetVal()
          Deprecated. remove in Kieker 1.6
 String getSessionId()
           
 long getTin()
           
 long getTout()
           
 long getTraceId()
           
 Class<?>[] getValueTypes()
           
 void initFromArray(Object[] values)
          Deprecated. 
 boolean isEntryPoint()
          Deprecated. remove in Kieker 1.6
 void setClassName(String className)
          Deprecated. will be removed in Kieker 1.6. Also, this class will become immutable in Kieker 1.6.
 void setEntryPoint(boolean entryPoint)
          Deprecated. remove in Kieker 1.6
 void setEoi(int eoi)
          Deprecated. this class will become immutable in Kieker 1.6
 void setEss(int ess)
          Deprecated. this class will become immutable in Kieker 1.6
 void setExperimentId(int experimentId)
          Deprecated. this class will become immutable in Kieker 1.6
 void setHostname(String hostname)
          Deprecated. this class will become immutable in Kieker 1.6
 void setOperationName(String operationName)
          Deprecated. will be removed in Kieker 1.6. Also, this class will become immutable in Kieker 1.6.
 void setOperationSignature(String operationSignature)
          Deprecated. this class will become immutable in Kieker 1.6 A string can, for example, be created using ClassOperationSignaturePair.toOperationSignatureString().
 void setRetVal(Object retVal)
          Deprecated. remove in Kieker 1.6
 void setSessionId(String sessionId)
          Deprecated. this class will become immutable in Kieker 1.6
 void setTin(long tin)
          Deprecated. this class will become immutable in Kieker 1.6
 void setTout(long tout)
          Deprecated. this class will become immutable in Kieker 1.6
 void setTraceId(long traceId)
          Deprecated. this class will become immutable in Kieker 1.6
 Object[] toArray()
           
 
Methods inherited from class kieker.common.record.AbstractMonitoringRecord
checkArray, classForName, compareTo, createFromArray, createFromStringArray, equals, fromStringArrayToTypedArray, getLoggingTimestamp, hashCode, setLoggingTimestamp, toString, typesForClass
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

NO_HOSTNAME

public static final String NO_HOSTNAME
Constant to be used if no hostname required.

See Also:
Constant Field Values

NO_SESSION_ID

public static final String NO_SESSION_ID
Constant to be used if no session ID required.

See Also:
Constant Field Values

NO_TRACEID

public static final long NO_TRACEID
Constant to be used if no trace ID required.

See Also:
Constant Field Values

NO_TIMESTAMP

public static final long NO_TIMESTAMP
Constant to be used if no timestamp required.

See Also:
Constant Field Values

NO_EOI_ESS

public static final int NO_EOI_ESS
Constant to be used if no eoi or ess required.

See Also:
Constant Field Values
Constructor Detail

OperationExecutionRecord

@Deprecated
public OperationExecutionRecord()
Deprecated. will be removed in Kieker 1.6

Returns an instance of OperationExecutionRecord. The member variables are initialized that way that only actually used variables must be updated.


OperationExecutionRecord

public OperationExecutionRecord(String operationSignature,
                                String sessionId,
                                long traceId,
                                long tin,
                                long tout,
                                String hostname,
                                int eoi,
                                int ess)
Creates a new OperationExecutionRecord with the given parameters. The fields getRetVal() is set to null; isEntryPoint() is set to false.

Parameters:
operationSignature - an operation string, as defined in ClassOperationSignaturePair.splitOperationSignatureStr(String); must not be null.
sessionId - the session ID; must not be null, use NO_SESSION_ID if no session ID desired.
traceId - the trace ID; use NO_TRACEID if no trace ID desired.
tin - the execution start timestamp; use NO_TIMESTAMP if no timestamp desired.
tout - the execution stop timestamp; use NO_TIMESTAMP if no timestamp desired.
hostname - the host name; must not be null, use NO_HOSTNAME if no host name desired.
eoi - the execution order index (eoi); use NO_EOI_ESS if no eoi desired.
ess - the execution order index (ess); use NO_EOI_ESS if no ess desired.

OperationExecutionRecord

@Deprecated
public OperationExecutionRecord(String componentName,
                                           String methodName,
                                           long traceId)
Deprecated. will be removed in Kieker 1.6

Parameters:
componentName -
methodName -
traceId -

OperationExecutionRecord

@Deprecated
public OperationExecutionRecord(String componentName,
                                           String opName,
                                           long traceId,
                                           long tin,
                                           long tout)
Deprecated. will be removed in Kieker 1.6

Parameters:
componentName -
opName -
traceId -
tin -
tout -

OperationExecutionRecord

@Deprecated
public OperationExecutionRecord(String componentName,
                                           String opName,
                                           long tin,
                                           long tout)
Deprecated. will be removed in Kieker 1.6

Parameters:
componentName -
opName -
tin -
tout -

OperationExecutionRecord

@Deprecated
public OperationExecutionRecord(String componentName,
                                           String opName,
                                           String sessionId,
                                           long traceId,
                                           long tin,
                                           long tout)
Deprecated. will be removed in Kieker 1.6

Parameters:
componentName -
opName -
sessionId -
traceId -
tin -
tout -

OperationExecutionRecord

@Deprecated
public OperationExecutionRecord(String componentName,
                                           String opName,
                                           String sessionId,
                                           long traceId,
                                           long tin,
                                           long tout,
                                           String vnName,
                                           int eoi,
                                           int ess)
Deprecated. will be removed in Kieker 1.6

Parameters:
componentName -
opName -
sessionId -
traceId -
tin -
tout -
vnName -
eoi -
ess -

OperationExecutionRecord

public OperationExecutionRecord(Object[] values)
Method Detail

toArray

public final Object[] toArray()
Specified by:
toArray in interface IMonitoringRecord

initFromArray

@Deprecated
public void initFromArray(Object[] values)
Deprecated. 

Specified by:
initFromArray in interface IMonitoringRecord

getValueTypes

public Class<?>[] getValueTypes()
Specified by:
getValueTypes in interface IMonitoringRecord

getExperimentId

@Deprecated
public final int getExperimentId()
Deprecated. Will be removed in 1.6

Returns:
the experimentId

setExperimentId

@Deprecated
public final void setExperimentId(int experimentId)
Deprecated. this class will become immutable in Kieker 1.6

Parameters:
experimentId - the experimentId to set

getHostname

public final String getHostname()
Returns:
the hostname

setHostname

@Deprecated
public final void setHostname(String hostname)
Deprecated. this class will become immutable in Kieker 1.6

Parameters:
hostname - the hostname to set

getOperationSignature

public String getOperationSignature()

setOperationSignature

@Deprecated
public void setOperationSignature(String operationSignature)
Deprecated. this class will become immutable in Kieker 1.6 A string can, for example, be created using ClassOperationSignaturePair.toOperationSignatureString().

Parameters:
operationSignature -

getClassName

@Deprecated
public final String getClassName()
Deprecated. will be removed in Kieker 1.6

Returns:
the className

setClassName

@Deprecated
public final void setClassName(String className)
Deprecated. will be removed in Kieker 1.6. Also, this class will become immutable in Kieker 1.6.

Use setOperationSignature(String) instead.

Parameters:
className - the className to set

getOperationName

@Deprecated
public final String getOperationName()
Deprecated. will be removed in Kieker 1.6

Returns:
the operationName

setOperationName

@Deprecated
public final void setOperationName(String operationName)
Deprecated. will be removed in Kieker 1.6. Also, this class will become immutable in Kieker 1.6.

Use setOperationSignature(String) instead.

Parameters:
operationName - the operationName to set

getSessionId

public final String getSessionId()
Returns:
the sessionId

setSessionId

@Deprecated
public final void setSessionId(String sessionId)
Deprecated. this class will become immutable in Kieker 1.6

Parameters:
sessionId - the sessionId to set

getTraceId

public final long getTraceId()
Returns:
the traceId

setTraceId

@Deprecated
public final void setTraceId(long traceId)
Deprecated. this class will become immutable in Kieker 1.6

Parameters:
traceId - the traceId to set

getTin

public final long getTin()
Returns:
the tin

setTin

@Deprecated
public final void setTin(long tin)
Deprecated. this class will become immutable in Kieker 1.6

Parameters:
tin - the tin to set

getTout

public final long getTout()
Returns:
the tout

setTout

@Deprecated
public final void setTout(long tout)
Deprecated. this class will become immutable in Kieker 1.6

Parameters:
tout - the tout to set

getEoi

public final int getEoi()
Returns:
the eoi

setEoi

@Deprecated
public final void setEoi(int eoi)
Deprecated. this class will become immutable in Kieker 1.6

Parameters:
eoi - the eoi to set

getEss

public final int getEss()
Returns:
the ess

setEss

@Deprecated
public final void setEss(int ess)
Deprecated. this class will become immutable in Kieker 1.6

Parameters:
ess - the ess to set

getRetVal

@Deprecated
public Object getRetVal()
Deprecated. remove in Kieker 1.6


setRetVal

@Deprecated
public void setRetVal(Object retVal)
Deprecated. remove in Kieker 1.6

Parameters:
retVal -

isEntryPoint

@Deprecated
public boolean isEntryPoint()
Deprecated. remove in Kieker 1.6


setEntryPoint

@Deprecated
public void setEntryPoint(boolean entryPoint)
Deprecated. remove in Kieker 1.6

Parameters:
entryPoint -

Kieker 1.5

Copyright 2012 the Kieker Project, http://kieker-monitoring.net