ICF 1.5.20.21

Install Java RCS

The Java remote connector server (RCS) requires Java 11 or later, and is supported on any platform on which Java runs. Exact memory, disk space and CPU requirements will vary on the connectors used and how many connectors are run.

You can also deploy Java RCS in a Docker container.

Install a Java RCS on Unix/Linux

  1. Download and extract the Java RCS from the ForgeRock BackStage download site.

  2. Change to the openicf directory:

    cd /path/to/openicf
  3. Review the ConnectorServer.properties file in the /path/to/openicf/conf directory, and adjust it to suit your deployment. For a complete list of properties in that file, refer to RCS Properties.

    • In server mode, the RCS uses a connectorserver.key property to authenticate the connection. The default value of the key is a hashed value of the string changeit. You cannot set this property directly in the configuration file. To change its value, use the command ConnectorServer.sh /setKey. This example sets the key value to Passw0rd:

      /path/to/openicf/bin/ConnectorServer.sh /setKey Passw0rd
      Key has been successfully updated.

      In client mode, this is not necessary and can be skipped. For more information about the differences between client mode and server mode, refer to Configure a Remote Connector Server (RCS).

  4. Start the Java RCS:

    /path/to/openicf/bin/ConnectorServer.sh /run

    By default, the RCS is now running and listening on port 8759.

    Log files are available in the /path/to/openicf/logs directory.

    ls logs/
    Connector.log  ConnectorServer.log  ConnectorServerTrace.log
  5. To stop the Java RCS, press CTRL+C or q in the terminal where you started the server.

Install a Java RCS on Windows

  1. Download and extract the Java RCS from the ForgeRock BackStage download site.

  2. In a Command Prompt window, change to the openicf directory:

    C:\> cd C:\path\to\openicf
  3. Review the ConnectorServer.properties file in the \path\to\openicf\conf directory, and adjust it to suit your deployment. For a complete list of properties in that file, refer to RCS Properties.

    • In server mode, the RCS uses a connectorserver.key property to authenticate the connection. The default value of the key is a hashed value of the string changeit. You cannot set this property directly in the configuration file. To change its value, use the ConnectorServer.bat /setKey command. This example sets the key value to Passw0rd:

      c:\path\to\openicf> bin\ConnectorServer.bat /setKey Passw0rd
      Key has been successfully updated.

      In client mode, this is not necessary and can be skipped. For more information about the differences between client mode and server mode, refer to Configure a Remote Connector Server (RCS).

  4. You can either run the Java RCS as a Windows service or start and stop it from the command line.

    1. To install the Java RCS as a Windows service, run the following command:

      c:\path\to\openicf> bin\ConnectorServer.bat /install

      If you install the RCS as a Windows service, you can use the Microsoft Services Console to start, stop, and restart the service. The Java Connector Service is named OpenICFConnectorServerJava.

      To uninstall the Java RCS as a Windows service, run the following command:

      c:\path\to\openicf> bin\ConnectorServer.bat /uninstall
    2. To start the Java RCS from the command line, enter the following command:

      c:\path\to\openicf> bin\ConnectorServer.bat /run
  5. The RCS is now running, and listening on port 8759, by default.

    Log files are available in the \path\to\openicf\logs directory.

  6. To stop the Java RCS, press CTRL+C.

Copyright © 2010-2024 ForgeRock, all rights reserved.