Skip navigation links

com.bea.wlevs.management.configuration
Interface RecordPlaybackMBean

public interface RecordPlaybackMBean

extends WebLogicMBean, javax.management.NotificationEmitter

Inner Class Summary

static class

RecordPlaybackMBean.ConfigParameters The name of the event store provider that was used for this recording

Field Summary
static java.lang.String	MBEAN_TYPE

Method Summary
void	configurePlaybackFilter(long startTime, long endTime) Use this to specify the record time filter for events that are to be played back.
void	configurePlaybackStorage(java.lang.String datasetName, java.util.List eventTypes, java.lang.String providerName) Configures the store related parameters of the events that should be played back.
void	configureRecordStorage(java.lang.String datasetName, java.util.List eventTypes, java.lang.String providerName) Configures the storage parameters for recording events at this stage.
java.util.Map	getPlaybackConfiguration() Returns all the configuration values specified for playback in this stage.
java.util.Map	getRecordConfiguration() Returns all the configuration values specified for recording in this stage.
boolean	isPlayingBack() Returns true if events are being played back to this stage.
boolean	isRecording() Returns true if this stage is currently recording events flowing out of the stage.
void	schedulePlayback(long startTime, long endTime, float speed, boolean repeat) Schedules events to be played back to this stage at the specified time.
void	scheduleRecord(long startTime, long endTime) Configures a stage with the time range during which events from from the stage will be recorded.
void	setPlaybackConfiguration(java.util.Map config) Saves the playback configuration values specified.
void	setRecordConfiguration(java.util.Map config) Saves the record configuration values specified.
void	startPlayback() Starts playback on a stage that is already configured with the required playback parameters.
void	startPlayback(long startTime, long endTime, float speed, boolean repeat) Starts playback using the specified filter and speed.
void	startPlaybackUsingSession(java.lang.String sessionName, long recordStartTime, java.util.List eventTypes, float speed, boolean repeat) Starts playing back to this stage using events from the specified recording session.
void	startRecording() Starts recording on a stage that is already configured with the required record parameters.
void	stopPlayback() Stops playback on a stage.
void	stopRecording() Stops recording on a stage.

Methods inherited from interface com.bea.wlevs.management.WebLogicMBean

getName, getObjectName, getType

Methods inherited from interface javax.management.NotificationEmitter

removeNotificationListener

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Field Detail

MBEAN_TYPE

public static final java.lang.String MBEAN_TYPE

Method Detail

startRecording

public void startRecording()
                    throws javax.management.JMException

Starts recording on a stage that is already configured with the required record parameters. If the stage is already recording events, this operation will have no effect. This method makes no changes to the persisted record configurations for the stage.

If the stage is not already configured for recording, this operation will throw an exception.

Throws:

javax.management.JMException - if an unexpected error occurs

stopRecording

public void stopRecording()
                   throws javax.management.JMException

Stops recording on a stage. If the stage is not already configured for recording, this operation will be ignored and an exception will NOT be thrown.

This method makes no changes to the persisted record configurations for the stage.

Throws:

javax.management.JMException - if an unexpected error occurs

isRecording

public boolean isRecording()
                    throws javax.management.JMException

Returns true if this stage is currently recording events flowing out of the stage. This gives more information than just finding out if the stage is configured for recording or not. This returns true if the stage is configured for recording and if it is, at this point in time, recording events.

Returns:

true if the stage is currently recording events flowing out of it; false otherwise.

configureRecordStorage

public void configureRecordStorage(java.lang.String datasetName,
                                   java.util.List eventTypes,
                                   java.lang.String providerName)
                            throws javax.management.JMException

Configures the storage parameters for recording events at this stage. These parameters must be specified before recording may be scheduled on this stage.

Parameters:

datasetName - the dataset name to use when storing events from this stage

eventTypes - the type of events that must be recorded. Only events of these types will be recorded as they pass through the stage.

providerName - the event store provider to use store events. This must be a valid provider, configured in the server configuration file.

Throws:

javax.management.JMException - if an unexpected error occurs

scheduleRecord

public void scheduleRecord(long startTime,
                           long endTime)
                    throws javax.management.JMException

Configures a stage with the time range during which events from from the stage will be recorded. The stage must have been already configured with the other necessary record parameters like data-set name.

Parameters:

startTime - time in milliseconds, after which events from the stage will be recorded. Use -1 to specify no start time.

endTime - time in milliseconds, before which events from the stage will be recorded. Use -1 to specify no end time.

Throws:

javax.management.JMException - if an unexpected error occurs

getRecordConfiguration

public java.util.Map getRecordConfiguration()
                                     throws javax.management.JMException

Returns all the configuration values specified for recording in this stage.

Returns:

Map<String, Object> of configuration parameter name to value. The parameter names and value formats are described in RecordPlaybackParameters.

Throws:

javax.management.JMException -

setRecordConfiguration

public void setRecordConfiguration(java.util.Map config)
                            throws javax.management.JMException

Saves the record configuration values specified.

Parameters:

config - Map of record configuration parameters. The format of the parameters must be the same as specified in getRecordConfiguation.

startPlayback

public void startPlayback()
                   throws javax.management.JMException

Starts playback on a stage that is already configured with the required playback parameters. This method makes no changes to the persisted playback configurations for the stage.

If the stage is not already configured for playback, this operation will throw an exception.

Throws:

javax.management.JMException - if an unexpected error occurs

startPlaybackUsingSession

public void startPlaybackUsingSession(java.lang.String sessionName,
                                      long recordStartTime,
                                      java.util.List eventTypes,
                                      float speed,
                                      boolean repeat)
                               throws javax.management.JMException

Starts playing back to this stage using events from the specified recording session.

Parameters:

sessionName - name of the session whose events are to be played back. This along with the recordStartTime identifies the session.

recordStartTime - the time at which this session started recording. This along with the sessionName identifies the session.

eventTypes - if only certain event types that were recorded should be played back, specify those event types here. If all the event types should be played back, leave this null.

speed - the speed at which the events should be played back. A value of 1.0 will play back at the same speed that the events were received, 2.0 will play back at double the speed, 0.5 at half the speed and so on.

repeat - specifies whether playback should keep looping through the events after all the events are played back. True value will playback forever until it is stopped explicitly.

startPlayback

public void startPlayback(long startTime,
                          long endTime,
                          float speed,
                          boolean repeat)
                   throws javax.management.JMException

Starts playback using the specified filter and speed. The parameters specified will be saved on the stage configuration. The stage must be already configured with the required playback configuration paramters like dataset name.

If the stage is not already configured for playback, this operation will throw an exception.

Parameters:

startTime - time in milliseconds, at which events must start playing back to this stage. Use -1 to specify no startTime.

endTime - time in milliseconds, at which events must stop playing back to this stage. Use -1 to specify no stopTime.

speed - float indicating the speed at which the events should be played back. Only positive values greater than 0 are allowed here. A value of 1 will play the events back at the same rate that they came in. A value lesser than 1 will play the events at a rate that is 'speed' times slower. Similarly, value greater than 1 will play the events at a rate that is 'speed' times faster.

repeat - boolean indicating if playback should loop back to the first event once all the events in the specified time range have been played back. If this is true, events will be played back from the first event and will continue looping back until playback is disabled. If this is false, events satisfying the range will be played back once and playback will stop.

Throws:

java.lang.IllegalArgumentException - if any of the parameter values are invalid. For example, a value <=0 for speed

javax.management.JMException - if an unexpected error occurs

stopPlayback

public void stopPlayback()
                  throws javax.management.JMException

Stops playback on a stage. If the stage is not already configured for playback, this operation will be ignored and an exception will NOT be thrown.

This method makes no changes to the persisted configurations for the stage.

Throws:

javax.management.JMException - if an unexpected error occurs

isPlayingBack

public boolean isPlayingBack()
                      throws javax.management.JMException

Returns true if events are being played back to this stage. This gives more information than just finding out if the stage is configured for playback or not. This returns true if the stage is configured for playback and if events are being played back to the stage at this point in time.

Returns:

true if events are being played to the stage currently; false otherwise.

configurePlaybackStorage

public void configurePlaybackStorage(java.lang.String datasetName,
                                     java.util.List eventTypes,
                                     java.lang.String providerName)
                              throws javax.management.JMException

Configures the store related parameters of the events that should be played back.

Parameters:

datasetName - the dataset name of the events that should be played back

eventTypes - list with the type of events, as defined in the Event Type Repository, that should be played back

providerName - the event store provider to use to get the events. This must be a valid provider, configured in the server configuration file.

Throws:

javax.management.JMException - if an unexpected error occurs

configurePlaybackFilter

public void configurePlaybackFilter(long startTime,
                                    long endTime)
                             throws javax.management.JMException

Use this to specify the record time filter for events that are to be played back.

Parameters:

startTime - the minimum record time metadata value, in milliseconds, for the events to be played back. Use -1, if there should be no minimum record time value.

endTime - the maximum record time metadata value, in milliseconds, for the events to be played back. Use -1, if there should be no maximum record time value.

Throws:

javax.management.JMException - if an unexpected error occurs

schedulePlayback

public void schedulePlayback(long startTime,
                             long endTime,
                             float speed,
                             boolean repeat)
                      throws javax.management.JMException

Schedules events to be played back to this stage at the specified time.

Parameters:

startTime - time in milliseconds, at which events must start playing back to this stage. Use -1 to specify no startTime.

endTime - time in milliseconds, at which events must stop playing back to this stage. Use -1 to specify no stopTime.

speed - float indicating the speed at which the events should be played back. Only positive values greater than 0 are allowed here. A value of 1 will play the events back at the same rate that they came in. A value lesser than 1 will play the events at a rate that is 'speed' times slower. Similarly, value greater than 1 will play the events at a rate that is 'speed' times faster.

repeat - boolean indicating if playback should loop back to the first event once all the events in the specified time range have been played back. If this is true, events will be played back from the first event and will continue looping back until playback is disabled. If this is false, events satisfying the range will be played back once and playback will stop.

Throws:

java.lang.IllegalArgumentException - if any of the parameter values are invalid. For example, a value <=0 for speed

javax.management.JMException - if an unexpected error occurs

getPlaybackConfiguration

public java.util.Map getPlaybackConfiguration()
                                       throws javax.management.JMException

Returns all the configuration values specified for playback in this stage.

Returns:

Map<String, Object> of configuration parameter name to value. The parameter names and value formats are described in RecordPlaybackParameters.

Throws:

javax.management.JMException - if an unexpected error occurs

setPlaybackConfiguration

public void setPlaybackConfiguration(java.util.Map config)
                              throws javax.management.JMException

Saves the playback configuration values specified.

Parameters:

config - Map of record configuration parameters. The format of the parameters must be the same as specified in getPlaybackConfiguation.

Throws:

javax.management.JMException - if an unexpected error occurs