com.sun.slamd.example
Class WeightedModRateWithReplicaLatencyJobClass

java.lang.Object
  java.lang.Thread
      com.sun.slamd.job.JobClass
          com.sun.slamd.example.ReplicaLatencyCheckJobClass
              com.sun.slamd.example.WeightedModRateWithReplicaLatencyJobClass

All Implemented Interfaces:

java.lang.Runnable

public class WeightedModRateWithReplicaLatencyJobClass
extends ReplicaLatencyCheckJobClass

This class implements a SLAMD job class for performing repeated modifications against an LDAP directory server. All of the configuration for this job thread can be provided through parameters.

Author:

Neil A. Wilson

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

static char[]	ALPHABET The characters that are available for use in the randomly-generated values.
static java.lang.String	STAT_TRACKER_CATEGORIZED_LATENCY The display name for the stat tracker that will be used to categorize the replication latencies.
static java.lang.String	STAT_TRACKER_EXCEPTIONS_CAUGHT The display name for the stat tracker that will be used to track the number of exceptions caught.
static java.lang.String	STAT_TRACKER_MOD_1_COUNT The display name for the stat tracker that will be used to track the number of the first kind of modifications performed.
static java.lang.String	STAT_TRACKER_MOD_1_TIME The display name for the stat tracker that will be used to track the time required to perform the first kind of modification.
static java.lang.String	STAT_TRACKER_MOD_2_COUNT The display name for the stat tracker that will be used to track the number of the second kind of modifications performed.
static java.lang.String	STAT_TRACKER_MOD_2_TIME The display name for the stat tracker that will be used to track the time required to perform the second kind of modification.
static java.lang.String	STAT_TRACKER_MOD_CATEGORIES The display name of the stat tracker that will be used to categorize the types of modifications performed.
static java.lang.String	STAT_TRACKER_MOD_OVERALL_COUNT The display name for the stat tracker that will be used to track the number of either kind of modifications performed.
static java.lang.String	STAT_TRACKER_MOD_OVERALL_TIME The display name for the stat tracker that will be used to track the time required to perform either kind of modification.
static java.lang.String	STAT_TRACKER_REPLICA_LATENCY The display name for the stat tracker that will be used to track the replication latency.

Fields inherited from class com.sun.slamd.example.ReplicaLatencyCheckJobClass

latencyCategories, latencyCheckMutex, latencyTime

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

WeightedModRateWithReplicaLatencyJobClass()
The default constructor used to create a new instance of the search thread.

Method Summary

void	destroy() Attempts to force this thread to exit by closing the connection to the directory server and setting it to null.
void	finalizeClient() Ensures that the master and replica check threads are properly stopped.
java.lang.String	getJobCategoryName() Retrieves the name of the category in which this job class exists.
java.lang.String	getJobDescription() Retrieves a description of the job performed by this job thread.
java.lang.String	getJobName() Retrieves the name of the job performed by this job thread.
ParameterList	getParameterStubs() Retrieve a parameter list that can be used to determine all of the customizable options that are available for this job.
java.lang.String	getRandomString(int length) Retrieves a string containing the specified number of randomly-chosen characters.
StatTracker[]	getStatTrackers() Retrieves the stat trackers that are maintained for this job thread.
StatTracker[]	getStatTrackerStubs(java.lang.String clientID, java.lang.String threadID, int collectionInterval) Retrieves the set of stat trackers that will be maintained by this job class.
void	initializeClient(java.lang.String clientID, ParameterList parameters) Initializes all of the instance variables that correspond to job parameters.
void	initializeThread(java.lang.String clientID, java.lang.String threadID, int collectionInterval, ParameterList parameters) Initializes this job thread to be used to actually run the job on the client.
boolean	providesParameterTest() Indicates whether this job class implements logic that makes it possible to test the validity of job parameters before scheduling the job for execution (e.g., to see if the server is reachable using the information provided).
void	runJob() Perform the work of this job thread by establishing the connection(s) to the directory server and issuing all the appropriate queries.
boolean	testJobParameters(ParameterList parameters, java.util.ArrayList outputMessages) Provides a means of testing the provided job parameters to determine whether they are valid (e.g., to see if the server is reachable) before scheduling the job for execution.

Methods inherited from class com.sun.slamd.job.JobClass

enableRealTimeStats, finalizeJob, finalizeThread, getActiveThreadCount, getClientID, getClientNumber, getClientSideJob, getClientSideParameterStubs, getCollectionInterval, getJobID, getScheduledDuration, getShouldStopTime, getStatReporter, getThreadID, getThreadNumber, indicateCompletedWithErrors, indicateStoppedDueToError, initializeJob, initializeJobThread, isDeprecated, isRunning, logMessage, overrideCollectionInterval, overrideNumClients, overrideThreadsPerClient, run, setClientNumber, setClientSideJob, setThreadNumber, shouldStop, stackTraceToString, startJob, stopAndWait, stopJob, stopRequested, validateJobInfo, writeVerbose

Methods inherited from class java.lang.Thread

activeCount, checkAccess, countStackFrames, currentThread, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

STAT_TRACKER_MOD_1_TIME

public static final java.lang.String STAT_TRACKER_MOD_1_TIME

The display name for the stat tracker that will be used to track the time required to perform the first kind of modification.

See Also:

Constant Field Values

STAT_TRACKER_MOD_2_TIME

public static final java.lang.String STAT_TRACKER_MOD_2_TIME

The display name for the stat tracker that will be used to track the time required to perform the second kind of modification.

See Also:

Constant Field Values

STAT_TRACKER_MOD_OVERALL_TIME

public static final java.lang.String STAT_TRACKER_MOD_OVERALL_TIME

The display name for the stat tracker that will be used to track the time required to perform either kind of modification.

See Also:

Constant Field Values

STAT_TRACKER_MOD_1_COUNT

public static final java.lang.String STAT_TRACKER_MOD_1_COUNT

The display name for the stat tracker that will be used to track the number of the first kind of modifications performed.

See Also:

Constant Field Values

STAT_TRACKER_MOD_2_COUNT

public static final java.lang.String STAT_TRACKER_MOD_2_COUNT

The display name for the stat tracker that will be used to track the number of the second kind of modifications performed.

See Also:

Constant Field Values

STAT_TRACKER_MOD_OVERALL_COUNT

public static final java.lang.String STAT_TRACKER_MOD_OVERALL_COUNT

The display name for the stat tracker that will be used to track the number of either kind of modifications performed.

See Also:

Constant Field Values

STAT_TRACKER_EXCEPTIONS_CAUGHT

public static final java.lang.String STAT_TRACKER_EXCEPTIONS_CAUGHT

The display name for the stat tracker that will be used to track the number of exceptions caught.

See Also:

Constant Field Values

STAT_TRACKER_MOD_CATEGORIES

public static final java.lang.String STAT_TRACKER_MOD_CATEGORIES

The display name of the stat tracker that will be used to categorize the types of modifications performed.

See Also:

Constant Field Values

STAT_TRACKER_REPLICA_LATENCY

public static final java.lang.String STAT_TRACKER_REPLICA_LATENCY

The display name for the stat tracker that will be used to track the replication latency.

See Also:

Constant Field Values

STAT_TRACKER_CATEGORIZED_LATENCY

public static final java.lang.String STAT_TRACKER_CATEGORIZED_LATENCY

The display name for the stat tracker that will be used to categorize the replication latencies.

See Also:

Constant Field Values

ALPHABET

public static final char[] ALPHABET

The characters that are available for use in the randomly-generated values.

Constructor Detail

WeightedModRateWithReplicaLatencyJobClass

public WeightedModRateWithReplicaLatencyJobClass()

The default constructor used to create a new instance of the search thread. The only thing it should do is to invoke the superclass constructor. All other initialization should be performed in the initialize method.

Method Detail

getJobName

public java.lang.String getJobName()

Retrieves the name of the job performed by this job thread.

Specified by:

getJobName in class JobClass

Returns:

The name of the job performed by this job thread.

getJobDescription

public java.lang.String getJobDescription()

Retrieves a description of the job performed by this job thread.

Specified by:

getJobDescription in class JobClass

Returns:

A description of the job performed by this job thread.

getJobCategoryName

public java.lang.String getJobCategoryName()

Retrieves the name of the category in which this job class exists. This is used to help arrange the job classes in the administrative interface.

Overrides:

getJobCategoryName in class JobClass

Returns:

The name of the category in which this job class exists.

getParameterStubs

public ParameterList getParameterStubs()

Retrieve a parameter list that can be used to determine all of the customizable options that are available for this job.

Specified by:

getParameterStubs in class JobClass

Returns:

A parameter list that can be used to determine all of the customizable options that are available for this job.

getStatTrackerStubs

public StatTracker[] getStatTrackerStubs(java.lang.String clientID,
                                         java.lang.String threadID,
                                         int collectionInterval)

Retrieves the set of stat trackers that will be maintained by this job class. The stat trackers returned by this method do not have to actually contain any statistics -- the display name and stat tracker class should be the only information that callers of this method should rely upon. Note that this list can be different from the list of statistics actually collected by the job in some cases (e.g., if the job may not return all the stat trackers it advertises in all cases, or if the job may return stat trackers that it did not advertise), but it is a possibility that only the stat trackers returned by this method will be accessible for some features in the SLAMD server.

Specified by:

getStatTrackerStubs in class JobClass

Parameters:

clientID - The client ID that should be used for the returned stat trackers.

threadID - The thread ID that should be used for the returned stat trackers.

collectionInterval - The collection interval that should be used for the returned stat trackers.

Returns:

The set of stat trackers that will be maintained by this job class.

getStatTrackers

public StatTracker[] getStatTrackers()

Retrieves the stat trackers that are maintained for this job thread.

Specified by:

getStatTrackers in class JobClass

Returns:

The stat trackers that are maintained for this job thread.

providesParameterTest

public boolean providesParameterTest()

Indicates whether this job class implements logic that makes it possible to test the validity of job parameters before scheduling the job for execution (e.g., to see if the server is reachable using the information provided).

Overrides:

providesParameterTest in class JobClass

Returns:

true if this job provides a means of testing the job parameters, or false if not.

testJobParameters

public boolean testJobParameters(ParameterList parameters,
                                 java.util.ArrayList outputMessages)

Provides a means of testing the provided job parameters to determine whether they are valid (e.g., to see if the server is reachable) before scheduling the job for execution. This method will be executed by the SLAMD server system itself and not by any of the clients.

Overrides:

testJobParameters in class JobClass

Parameters:

parameters - The job parameters to be tested.

outputMessages - The lines of output that were generated as part of the testing process. Each line of output should be added to this list as a separate string, and empty strings (but not null values) are allowed to provide separation between different messages. No formatting should be provided for these messages, however, since they may be displayed in either an HTML or plain text interface.

Returns:

true if the test completed successfully, or false if not. Note that even if the test did not complete successfully, the user will be presented with a warning but will still be allowed to schedule the job using the provided parameters. This is necessary because the parameters may still be valid even if the server couldn't validate them at the time the job was scheduled (e.g., if the server wasn't running or could not be reached by the SLAMD server even though it could be by the clients).

initializeClient

public void initializeClient(java.lang.String clientID,
                             ParameterList parameters)
                      throws UnableToRunException

Initializes all of the instance variables that correspond to job parameters.

Overrides:

initializeClient in class JobClass

Parameters:

clientID - The client ID for the current client.

parameters - The set of parameters that have been defined for this job.

Throws:

UnableToRunException - If any part of the initialization fails.

initializeThread

public void initializeThread(java.lang.String clientID,
                             java.lang.String threadID,
                             int collectionInterval,
                             ParameterList parameters)
                      throws UnableToRunException

Initializes this job thread to be used to actually run the job on the client. The provided parameter list should be processed to customize the behavior of this job thread, and any other initialization that needs to be done in order for the job to run should be performed here as well.

Specified by:

initializeThread in class JobClass

Parameters:

clientID - The client ID for this job thread.

threadID - The thread ID for this job thread.

collectionInterval - The length of time in seconds to use as the statistics collection interval.

parameters - The set of parameters provided to this job that can be used to customize its behavior.

Throws:

UnableToRunException - If a problem occurs that prevents the thread from being able to run properly.

runJob

public void runJob()

Perform the work of this job thread by establishing the connection(s) to the directory server and issuing all the appropriate queries. The job will continue until the specified number of iterations have been performed, the stop time has been reached, the maximum duration has been reached, or the SLAMD server indicates that a stop has been requested.

Specified by:

runJob in class JobClass

destroy

public void destroy()

Attempts to force this thread to exit by closing the connection to the directory server and setting it to null.

Overrides:

destroy in class JobClass

finalizeClient

public void finalizeClient()

Ensures that the master and replica check threads are properly stopped.

Overrides:

finalizeClient in class JobClass

getRandomString

public java.lang.String getRandomString(int length)

Retrieves a string containing the specified number of randomly-chosen characters.

Parameters:

length - The number of characters to include in the string.

Returns:

A string containing the specified number of randomly-chosen characters.