Interface LocalProcessWorkerKind

All Known Implementing Classes:
DndWorkerKind, EnterpriseWorkerKind, GenericCommandWorkerKind

public interface LocalProcessWorkerKind
WorkerKind for local processes that controls how the LocalProcessWorkerImpl will construct its command line arguments.
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
     
  • Method Summary

    Modifier and Type
    Method
    Description
    If the worker should be launched by a site-specific process rather than being launched directly from the start script, then WorkerKind.<worker-type>.commandPrefix can be set to define the start command.
    boolean
    Some customers have custom artifacts per user, which are passed to the Enterprise start script with the -u, -t, and -r options.
    boolean
    True if temporary dispatcher produced class paths should be included on the command line with -C.
    boolean
    True if -A "name" should be included on the command line.
    boolean
    Does this produce a JVM that requires DHE specific JVM arguments
    boolean
    Does this produce a JVM that requires JVM like arguments
    Create a helper for generating a new command line.
  • Method Details

    • newCommandHelper

      Create a helper for generating a new command line.
      Returns:
      a new command line helper.
    • needsJvmFlags

      boolean needsJvmFlags()
      Does this produce a JVM that requires JVM like arguments
      Returns:
      true if this kind of worker needs JVM arguments
    • needsDheJvmFlags

      boolean needsDheJvmFlags()
      Does this produce a JVM that requires DHE specific JVM arguments
      Returns:
      true if this kind of worker needs DHE specific JVM arguments
    • includeNameArgument

      boolean includeNameArgument()
      True if -A "name" should be included on the command line.
      Returns:
      true if the name argument is included
    • includeExtraClassPaths

      boolean includeExtraClassPaths()
      True if temporary dispatcher produced class paths should be included on the command line with -C.
      Returns:
      true if the dispatcher's temporary classpaths should be included
    • includeArtifactArguments

      boolean includeArtifactArguments()
      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.
      Returns:
      true if -u, -t, and -r options should be included
    • commandPrefix

      List<String> commandPrefix()
      If the worker should be launched by a site-specific process rather than being launched directly from the start script, then WorkerKind.<worker-type>.commandPrefix can be set to define the start command. For example, this can be used to launch workers that use a Kerberos keytab to run as a user, e.g.:

      WorkerKind.<worker-type>.commandPrefix=k5start -f /path/to/krb5.keytab -U -- sh -c

      Returns:
      List of command and args used to launch a worker, or null if the property is not set.