com.jrockit.mc.rjmx.flr
Interface IRecordingDescriptor

All Known Implementing Classes:

RecordingDescriptor

public interface IRecordingDescriptor

Interface that describe a JRockit Flight Recorder recording.

Author:

Marcus Hirt

Nested Class Summary

static class

IRecordingDescriptor.RecordingState Defines the possible states a recording can be in.

Method Summary

IConnectionDescriptor	getConnectionDescriptor() An IConnectionDescriptor that describes the source of this recording.
java.util.Date	getDataEndTime() Returns the data end time for this recording.
java.util.Date	getDataStartTime() Returns the data start time for this recording.
long	getDuration() Returns the duration the recording was created with.
java.lang.Long	getId() Returns the id value of the recording.
long	getMaxAge() Returns the recordings maximum event age.
long	getMaxSize() Returns the recordings maximum size.
java.lang.String	getName() Returns the symbolic name of the recording.
javax.management.ObjectName	getObjectName() Returns the object name used to locate the MBean that is used to manage this recording.
java.util.Map	getOptions() Returns a Map with values that describes the various options in the recording.
java.util.Date	getStartTime() Returns the start time for this recording.
IRecordingDescriptor.RecordingState	getState() Returns the state of the recording when this RecordingDescriptor was created.
boolean	getToDisk() Returns whether the recording is stored to disk.
boolean	isContinuous() Returns the recording was created as continuous or not.

Method Detail

getId

java.lang.Long getId()

Returns the id value of the recording.

Returns:

the id value of the recording.

getName

java.lang.String getName()

Returns the symbolic name of the recording.

Returns:

the symbolic name of the recording.

getState

IRecordingDescriptor.RecordingState getState()

Returns the state of the recording when this RecordingDescriptor was created.

Returns:

the state of the recording when this RecordingDescriptor was created.

getOptions

java.util.Map getOptions()

Returns a Map with values that describes the various options in the recording. Options can, for instance, be duration and destFile.

Returns:

a Map with values that describes the various options in the recording.

getConnectionDescriptor

IConnectionDescriptor getConnectionDescriptor()

An IConnectionDescriptor that describes the source of this recording.

Returns:

a descriptor describing the recording source.

getObjectName

javax.management.ObjectName getObjectName()

Returns the object name used to locate the MBean that is used to manage this recording.

Returns:

the object name used to locate the MBean that is used to manage this recording.

getDataStartTime

java.util.Date getDataStartTime()

Returns the data start time for this recording.

Returns:

the data start time for the recording

getDataEndTime

java.util.Date getDataEndTime()

Returns the data end time for this recording.

Returns:

the data end time for the recording

getStartTime

java.util.Date getStartTime()

Returns the start time for this recording.

Returns:

the start time for this recording, or null if not available

getDuration

long getDuration()

Returns the duration the recording was created with.

Returns:

the duration of the recording in ms (0 means continuous), or -1 if unavailable

isContinuous

boolean isContinuous()

Returns the recording was created as continuous or not.

Returns:

true if the recording was created continuous, or false if not

getToDisk

boolean getToDisk()

Returns whether the recording is stored to disk.

Returns:

true if the recording is stored to disk, false otherwise

getMaxSize

long getMaxSize()

Returns the recordings maximum size.

Returns:

the maximum size of the recording

getMaxAge

long getMaxAge()

Returns the recordings maximum event age.

Returns:

the maximum event age of the recording