Package com.illumon.iris.db.tables.remotequery

Class GenericCommandWorkerKind

java.lang.Object

com.illumon.iris.db.tables.remotequery.GenericCommandWorkerKind

All Implemented Interfaces:

LocalProcessWorkerKind, WorkerKind

public class GenericCommandWorkerKind
extends Object
implements WorkerKind, LocalProcessWorkerKind

A worker that executes a supplied command line.

This class is configured through properties that control the basic command line and provide options to the WorkerCommandBuilder through overriding methods to LocalProcessWorkerKind. To add a WorkerKind to the dispatcher, specify a property of the form WorkerKind.class.<i>name</i>=com.illumon.iris.db.tables.remotequery.GenericCommandWorkerKind. The name is used by the dispatcher to select this WorkerKind; and to determine the prefix for other properties. WorkerKind.<i>name</i>.command is required; and is the command (and arguments) that form the base of executed command. Arguments are separated by spaces and may be quoted, it is not possible to pass an empty command line argument (i.e. "").

In addition to the command property; you may specify:

WorkerKind.<i>name</i>.jvm	Is this worker a JVM? If so, the command builder adds appropriate JVM arguments like heap size and property definitions
WorkerKind.<i>name</i>.includeName	Include a -A argument for the name of the process.
WorkerKind.<i>name</i>.includeExtraClassPaths	Include temporary class paths generated by the dispatcher.
WorkerKind.<i>name</i>.includeArtifactArguments	Include -u, -t, and -r arguments for the artifact download script.

Nested Class Summary

Nested classes/interfaces inherited from interface com.illumon.iris.db.tables.remotequery.process.LocalProcessWorkerKind

LocalProcessWorkerKind.CommandHelper

Field Summary

Fields inherited from interface com.illumon.iris.db.tables.remotequery.WorkerKind

DEFAULT

Constructor Summary

Constructors

Constructor	Description
GenericCommandWorkerKind(String name)

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return an optional description of this WorkerKind for use in the UI.
String	getTitle()	Return a string that should be used for drop-down menus in the UI.
String	getWorkerControlTypeForRequest(RemoteProcessingRequest request)	The worker control type required for a particular request.
List<String>	implementedProtocols()	What protocols does this kind of worker implement?
boolean	includeArtifactArguments()	Some customers have custom artifacts per user, which are passed to the Enterprise start script with the -u, -t, and -r options.
boolean	includeExtraClassPaths()	True if temporary dispatcher produced class paths should be included on the command line with -C.
boolean	includeNameArgument()	True if -A "name" should be included on the command line.
boolean	needsDheJvmFlags()	Does this produce a JVM that requires DHE specific JVM arguments
boolean	needsJvmFlags()	Does this produce a JVM that requires JVM like arguments
LocalProcessWorkerKind.CommandHelper	newCommandHelper()	Create a helper for generating a new command line.
Collection<String>	workerControlTypes()	What kind of worker controls could be required for starting these kind of workers?

Methods inherited from class java.lang.Object

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

Constructor Details

GenericCommandWorkerKind

public GenericCommandWorkerKind(String name)

Method Details

workerControlTypes

public Collection<String> workerControlTypes()

Description copied from interface: WorkerKind

What kind of worker controls could be required for starting these kind of workers?

Specified by:

workerControlTypes in interface WorkerKind

Returns:

the desired WorkerControlType

getWorkerControlTypeForRequest

public String getWorkerControlTypeForRequest(RemoteProcessingRequest request)

Description copied from interface: WorkerKind

The worker control type required for a particular request.

Specified by:

getWorkerControlTypeForRequest in interface WorkerKind

Parameters:

request - the request that a worker is being created for

Returns:

the type of worker control for this particular request

implementedProtocols

public List<String> implementedProtocols()

Description copied from interface: WorkerKind

What protocols does this kind of worker implement?

Specified by:

implementedProtocols in interface WorkerKind

Returns:

a list of protocol names that this worker implements

needsJvmFlags

public boolean needsJvmFlags()

Description copied from interface: LocalProcessWorkerKind

Does this produce a JVM that requires JVM like arguments

Specified by:

needsJvmFlags in interface LocalProcessWorkerKind

Returns:

true if this kind of worker needs JVM arguments

needsDheJvmFlags

public boolean needsDheJvmFlags()

Description copied from interface: LocalProcessWorkerKind

Does this produce a JVM that requires DHE specific JVM arguments

Specified by:

needsDheJvmFlags in interface LocalProcessWorkerKind

Returns:

true if this kind of worker needs DHE specific JVM arguments

includeNameArgument

public boolean includeNameArgument()

Description copied from interface: LocalProcessWorkerKind

True if -A "name" should be included on the command line.

Specified by:

includeNameArgument in interface LocalProcessWorkerKind

Returns:

true if the name argument is included

includeExtraClassPaths

public boolean includeExtraClassPaths()

Description copied from interface: LocalProcessWorkerKind

True if temporary dispatcher produced class paths should be included on the command line with -C.

Specified by:

includeExtraClassPaths in interface LocalProcessWorkerKind

Returns:

true if the dispatcher's temporary classpaths should be included

includeArtifactArguments

public boolean includeArtifactArguments()

Description copied from interface: LocalProcessWorkerKind

Some customers have custom artifacts per user, which are passed to the Enterprise start script with the -u, -t, and -r options. True if those options be included in the command.

Specified by:

includeArtifactArguments in interface LocalProcessWorkerKind

Returns:

true if -u, -t, and -r options should be included

newCommandHelper

public LocalProcessWorkerKind.CommandHelper newCommandHelper()

Description copied from interface: LocalProcessWorkerKind

Create a helper for generating a new command line.

Specified by:

newCommandHelper in interface LocalProcessWorkerKind

Returns:

a new command line helper.

getDescription

@Nullable public String getDescription()

Description copied from interface: WorkerKind

Return an optional description of this WorkerKind for use in the UI.

Specified by:

getDescription in interface WorkerKind

Returns:

a description, or null

getTitle

@NotNull public String getTitle()

Description copied from interface: WorkerKind

Return a string that should be used for drop-down menus in the UI.

Specified by:

getTitle in interface WorkerKind

Returns:

the title of the worker