Package com.pushtechnology.diffusion.api.config

Interface ManagementConfig

All Superinterfaces:
Config
public interface ManagementConfig extends Config
Management Configuration. Enable remote JMX access.
Since:
4.4

  • Method Details

    • setHost

      void setHost(String host) throws ConfigException
      Set the host. This determines the local interface used for the RMI registry and the JMX service.

      By default this is "localhost".

      Parameters:
      host - the host name or IP address.
      Throws:
      ConfigException - if unable to set the property

    • getHost

      String getHost()
      Gets the host.
      Returns:
      host name or IP address.

    • setRegistryPort

      void setRegistryPort(int port) throws ConfigException
      Sets the RMI registry port.

      By default this is set to 1099.

      Parameters:
      port - RMI registry port
      Throws:
      ConfigException - if unable to set the property

    • getRegistryPort

      int getRegistryPort()
      Gets the RMI registry port.
      Returns:
      port number

    • setConnectionPort

      void setConnectionPort(int port) throws ConfigException
      Sets the JMX service port.

      By default this is 1100. If desired, it can be set to the same port number as the RMI registry port.

      Parameters:
      port - the connection port
      Throws:
      ConfigException - if unable to set the property

    • getConnectionPort

      int getConnectionPort()
      Gets the JMX service port.
      Returns:
      connection port

    • setKeystoreConfig

      void setKeystoreConfig(KeyStoreConfig keystoreConfig) throws ConfigException
      Sets the keystore configuration.
      Throws:
      ConfigException

    • getKeystoreConfig

      KeyStoreConfig getKeystoreConfig()
      Returns:
      the keystore configuration

    • setEnabled

      void setEnabled(boolean enabled) throws ConfigException
      Sets whether or not a remote JMX Connector is enabled or not. If not enabled, the JMX MBeans will still be created against the Platform MBean server, but only local process access will be supported.

      By default this is set to false.

      Parameters:
      enabled - true to enable JMX management
      Throws:
      ConfigException - if unable to set the property

    • isEnabled

      boolean isEnabled()
      Whether or not the external JMX Connector is enabled or not.
      Returns:
      true if enabled