Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Specify Java Options for a Controller or Agent

Info

The examples below examples make use of the -Xms128m -Xmx500m Java options that which are used to specify heap memory requirements.

Do not feel tempted to apply the values from the below examples that which are used for explanation purposes only.

...

For Unix, the JAVA_OPTIONS environment variable can be set before running the Controller or Agent start script like thisas follows:

  • From the Unix command line or from the Controller instance start script the controller_<instance>.sh script:

    Code Block
    languagebash
    titleUnix example to run the Controller start script with Java options
    # Set Java options before running the Controller start script
    export JAVA_OPTIONS="-Xms128m -Xmx500m"
    ./controller.sh start
    
    # Alternatively set Java options when running the Controller start script
    ./controller.sh start --java-options="-Xms128m -Xmx500m"
    
    # For use with a Controller daemon add this line to the Controller instance start script controller_<instance>.sh
    export JAVA_OPTIONS="-Xms128m -Xmx500m"
  • From the Unix command line or from the Agent instance start script agent_4445.sh  start script (assuming that port 4445 is used for the Agent):

    Code Block
    languagebash
    titleUnix example to run the Agent start script with Java options
    # Set Java options before running the Agent start script
    export JAVA_OPTIONS="-Xms128m -Xmx500m"
    ./agent.sh start
    
    # Alternatively set Java options when running the Agent start script
    ./agent.sh start --java-options="-Xms128m -Xmx500m"
    
    # For use with an Agent daemon add this line to the Agent instance start script agent_<port>.sh
    export JAVA_OPTIONS="-Xms128m -Xmx500m"
  • Alternatively the JAVA_OPTIONS environment variable can be set with:

...

For Windows, the JAVA_OPTIONS environment variable can be set before running the Controller or Agent start script like thisas follows

  • From the Windows command line or from the Controller instance start script controller_<instance>.cmd start script:

    Code Block
    languagebash
    titleWindows example to run the Controller start script with Java options
    @rem Set Java options before running the Controller start script
    set JAVA_OPTIONS="-Xms128m -Xmx500m"
    .\controller.cmd start
    
    @rem Alternatively set Java options when running the Controller start script
    .\controller.cmd start --java-options="-Xms128m -Xmx500m"
    
    @rem For use with a Controller Windows Service add this line to the Controller instance start script controller_<instance>.cmd
    set JAVA_OPTIONS="-Xms128m -Xmx500m"
  • From the Windows command line or from the Agent instance start script agent_4445.cmd  start script (assuming that port 4445 is used for the Agent):

    Code Block
    languagebash
    titleWindows example to run the Agent instance start script with Java options
    @rem Set Java options before running the Agent start script from the command line
    set JAVA_OPTIONS="-Xms128m -Xmx500m"
    .\agent.cmd start
    
    @rem Alternatively set Java options when running the Agent start script
    .\agent.cmd start --java-options="-Xms128m -Xmx500m"
    
    @rem For use with an Agent Windows Service add this line to the Agent instance start script agent_<port>.cmd
    set JAVA_OPTIONS="-Xms128m -Xmx500m"
  • Alternatively, when operating the Controller or Agent as a Windows Service then from the .\service directory of the installation run
    • for a Controller: js7_controller_<controller-id>w.exe
      • where <controller-id> corresponds to the Controller ID the Controller has been installed forwith.
      • Example: C:\Program Files\sos-berlin.com\js7\controller\my-controller\service\js7_controller_mycontrollerw.exe
    • for an Agent: js7_agent_<port>w.exe
      • where <port> corresponds to the port that the Agent is operated forwith.
      • Example: C:\Program Files\sos-berlin.com\js7\agent_4445\service\js7_agent_4445w.exe
    • This brings up a utility that allows Java options to be specified:



    • Note: The Controller or Agent Windows Service has to be restarted to apply changes to Java options.

Specify Java Options for JOC Cockpit

Info

The below examples make examples below use of the -Xms128m -Xmx500m Java options that are used to specify heap memory requirements.

Do not feel tempted to apply the values from the below examples that examples below which are used for explanation purposes only.

...

For Unix the JAVA_OPTIONS environment variable can be set before running the Jetty start script like thisas follows:

  • The Jetty start script is available from the installation directory  /opt/sos-berlin.com/js7/joc/jetty/bin/jetty.sh or a location specified during installation:

    Code Block
    languagebash
    titleUnix example to run the Jetty start script with Java options
    # Set Java options before running the Jetty start script
    export JAVA_OPTIONS="-Xms128m -Xmx500m"
    ./jetty.sh start
  • When running the JOC Cockpit as a daemon then the following line can be added to the $HOME/.jocrc file of the JOC Cockpit run-time account. This file is created by the installer , and it is used if it exists and is executable. The $HOME directory is identified from the /etc/passwd file during installation.

    Code Block
    languagebash
    titleUnix example to use $HOME/.jocrc with Java options
    export JAVA_OPTIONS="-Xms128m -Xmx500m"
  • When running the JOC Cockpit as a daemon then the  /etc/default/joc file can be created (requires root permission) by the user. This file is not created by the installer , and it will be used if it exists and is executable. This file will not be used if the $HOME/.jocrc file is present , see as described above.

    Code Block
    languagebash
    titleUnix example to use /etc/default/joc with Java options
    export JAVA_OPTIONS="-Xms128m -Xmx500m"
  • Alternatively the JAVA_OPTIONS environment variable can be set with:

...

For Windows, the JAVA_OPTIONS environment variable can be set before running the JOC Cockpit start script like this: 

  • Only when JOC Cockpit is not installed as Windows Service then the start script The C:\Program Files\sos-berlin.com\js7\joc\jetty\bin\jetty.cmd cmd start script is only available when the JOC Cockpit is not installed as a Windows Service.

    Code Block
    languagebash
    titleWindows example to run the JOC Cockpit start script with Java options
    @rem Set Java options before running the JOC Cockpit start script
    set JAVA_OPTIONS="-Xms128m -Xmx500m"
    .\jetty.cmd start
  • When operating the JOC Cockpit as a Windows Service then from the the installation .\service directory of the installation run:
    • for JOC Cockpit: js7_jocw.exe
      • Example: C:\Program Files\sos-berlin.com\js7\joc\service\js7_jocw.exe
    • This brings up a utility that allows Java options to be specified:



    • Note: The JOC Cockpit Windows Service has to be restarted to apply changes to Java options.

...