com.sun.slamd.example
Class CombinedAddAndDelRateJobClass

java.lang.Object
  java.lang.Thread
      com.sun.slamd.job.JobClass
          com.sun.slamd.example.CombinedAddAndDelRateJobClass

All Implemented Interfaces:

java.lang.Runnable

public class CombinedAddAndDelRateJobClass

extends JobClass

This class implements a SLAMD job class for performing repeated add and delete operations against an LDAP directory server. It works by first performing the add operations, waits for some specified interval, and then will delete the entries that it has just added. All of the configuration for this job thread can be provided through parameters.

Field Summary

static char[]	ALPHABET The characters that are available for use in the randomly-generated values.
static java.lang.String[]	DEFAULT_ATTR_NAMES The default set of attributes to include in the entries that are generated.
static java.lang.String[]	OBJECTCLASS_VALUES The default set of objectclass values to create.
static java.lang.String	SSL_KEY_PASSWORD_PROPERTY The system property used to specify the password for the JSSE key store.
static java.lang.String	SSL_KEY_STORE_PROPERTY The system property used to specify the location of the JSSE key store.
static java.lang.String	SSL_TRUST_PASSWORD_PROPERTY The system property used to specify the password for the JSSE trust store.
static java.lang.String	SSL_TRUST_STORE_PROPERTY The system property used to specify the location of the JSSE trust store.
static java.lang.String	STAT_TRACKER_ADD_COUNT The display name for the stat tracker that will be used to track the number of adds performed.
static java.lang.String	STAT_TRACKER_ADD_RESULT The display name for the stat tracker that will be used to track the result codes of the add operations.
static java.lang.String	STAT_TRACKER_ADD_TIME The display name for the stat tracker that will be used to track the time required to perform each add.
static java.lang.String	STAT_TRACKER_ADD_TOTAL The display name for the stat tracker that will be used to accumulate the total number of adds performed.
static java.lang.String	STAT_TRACKER_DEL_COUNT The display name for the stat tracker that will be used to track the number of deletes performed.
static java.lang.String	STAT_TRACKER_DEL_RESULT The display name for the stat tracker that will be used to track the result codes of the delete operations.
static java.lang.String	STAT_TRACKER_DEL_TIME The display name for the stat tracker that will be used to track the time required to perform each delete.
static java.lang.String	STAT_TRACKER_DEL_TOTAL The display name for the stat tracker that will be used to accumulate the total number of deletes performed.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

CombinedAddAndDelRateJobClass()
The default constructor used to create a new instance of the job thread.

Method Summary

netscape.ldap.LDAPEntry	createEntry() Creates a randomly-generated LDAP entry to be added to the directory.
void	destroy() Attempts to force this thread to exit by closing the connection to the directory server and setting it to null.
void	finalizeClient() Performs any per-client finalization that should be done for this job.
java.lang.String	getDNToDelete() Retrieves the DN of the next entry to be deleted.
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 customizeable 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.
int	overrideNumClients() Overrides the number of clients that may be used for this job to ensure that only a single client will be used.
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.
void	validateJobInfo(int numClients, int threadsPerClient, int threadStartupDelay, java.util.Date startTime, java.util.Date stopTime, int duration, int collectionInterval, ParameterList parameters) Provides a means of validating the information used to schedule the job, including the scheduling information and list of parameters.

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, overrideThreadsPerClient, run, setClientNumber, setClientSideJob, setThreadNumber, shouldStop, stackTraceToString, startJob, stopAndWait, stopJob, stopRequested, writeVerbose

Methods inherited from class java.lang.Thread

activeCount, checkAccess, countStackFrames, currentThread, dumpStack, enumerate, getContextClassLoader, getName, getPriority, getThreadGroup, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setName, setPriority, 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

SSL_KEY_STORE_PROPERTY

public static final java.lang.String SSL_KEY_STORE_PROPERTY

The system property used to specify the location of the JSSE key store.

See Also:

Constant Field Values

SSL_KEY_PASSWORD_PROPERTY

public static final java.lang.String SSL_KEY_PASSWORD_PROPERTY

The system property used to specify the password for the JSSE key store.

See Also:

Constant Field Values

SSL_TRUST_STORE_PROPERTY

public static final java.lang.String SSL_TRUST_STORE_PROPERTY

The system property used to specify the location of the JSSE trust store.

See Also:

Constant Field Values

SSL_TRUST_PASSWORD_PROPERTY

public static final java.lang.String SSL_TRUST_PASSWORD_PROPERTY

The system property used to specify the password for the JSSE trust store.

See Also:

Constant Field Values

STAT_TRACKER_ADD_TIME

public static final java.lang.String STAT_TRACKER_ADD_TIME

The display name for the stat tracker that will be used to track the time required to perform each add.

See Also:

Constant Field Values

STAT_TRACKER_ADD_COUNT

public static final java.lang.String STAT_TRACKER_ADD_COUNT

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

See Also:

Constant Field Values

STAT_TRACKER_ADD_RESULT

public static final java.lang.String STAT_TRACKER_ADD_RESULT

The display name for the stat tracker that will be used to track the result codes of the add operations.

See Also:

Constant Field Values

STAT_TRACKER_ADD_TOTAL

public static final java.lang.String STAT_TRACKER_ADD_TOTAL

The display name for the stat tracker that will be used to accumulate the total number of adds performed.

See Also:

Constant Field Values

STAT_TRACKER_DEL_TIME

public static final java.lang.String STAT_TRACKER_DEL_TIME

The display name for the stat tracker that will be used to track the time required to perform each delete.

See Also:

Constant Field Values

STAT_TRACKER_DEL_COUNT

public static final java.lang.String STAT_TRACKER_DEL_COUNT

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

See Also:

Constant Field Values

STAT_TRACKER_DEL_RESULT

public static final java.lang.String STAT_TRACKER_DEL_RESULT

The display name for the stat tracker that will be used to track the result codes of the delete operations.

See Also:

Constant Field Values

STAT_TRACKER_DEL_TOTAL

public static final java.lang.String STAT_TRACKER_DEL_TOTAL

The display name for the stat tracker that will be used to accumulate the total number of deletes performed.

See Also:

Constant Field Values

ALPHABET

public static final char[] ALPHABET

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

DEFAULT_ATTR_NAMES

public static final java.lang.String[] DEFAULT_ATTR_NAMES

The default set of attributes to include in the entries that are generated.

OBJECTCLASS_VALUES

public static final java.lang.String[] OBJECTCLASS_VALUES

The default set of objectclass values to create.

Constructor Detail

CombinedAddAndDelRateJobClass

public CombinedAddAndDelRateJobClass()

The default constructor used to create a new instance of the job 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.

overrideNumClients

public int overrideNumClients()

Overrides the number of clients that may be used for this job to ensure that only a single client will be used.

Overrides:

overrideNumClients in class JobClass

Returns:

The number of clients that will always be used for this job.

getParameterStubs

public ParameterList getParameterStubs()

Retrieve a parameter list that can be used to determine all of the customizeable 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 customizeable 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.

validateJobInfo

public void validateJobInfo(int numClients,
                            int threadsPerClient,
                            int threadStartupDelay,
                            java.util.Date startTime,
                            java.util.Date stopTime,
                            int duration,
                            int collectionInterval,
                            ParameterList parameters)
                     throws InvalidValueException

Provides a means of validating the information used to schedule the job, including the scheduling information and list of parameters.

Overrides:

validateJobInfo in class JobClass

Parameters:

numClients - The number of clients that should be used to run the job.

threadsPerClient - The number of threads that should be created on each client to run the job.

threadStartupDelay - The delay in milliseconds that should be used when starting the client threads.

startTime - The time that the job should start running.

stopTime - The time that the job should stop running.

duration - The maximum length of time in seconds that the job should be allowed to run.

collectionInterval - The collection interval that should be used when gathering statistics for the job.

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

Throws:

InvalidValueException - If the provided information is not appropriate for running this job.

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()

Performs any per-client finalization that should be done for this job. In this case, it checks to see if we need to clean up any tombstones that may still exist in the server.

Overrides:

finalizeClient in class JobClass

createEntry

public netscape.ldap.LDAPEntry createEntry()

Creates a randomly-generated LDAP entry to be added to the directory.

Returns:

The randomly-generated entry.

getDNToDelete

public java.lang.String getDNToDelete()

Retrieves the DN of the next entry to be deleted.

Returns:

The DN of the entry to be deleted, or null if all entries have been processed.

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.