com.ibm.websphere.jmx.connector.rest

Interface ConnectorSettings

All known implementing classes:
ClientProvider

  1. public interface ConnectorSettings
Provides constants for connection settings of the Liberty profile JMX REST connector client. The settings can be adjusted in 2 ways:

  1. Globally, by setting a system property with the desired value. For example, to set READ_TIMEOUT to 2 minutes (120000 milliseconds), use the Java option:

    -Dcom.ibm.ws.jmx.connector.client.rest.readTimeout=120000
  2. On a per connection basis, by adding an entry to the environment Map parameter of the JMXConnectorFactory.newJMXConnector(javax.management.remote.JMXServiceURL, java.util.Map) or JMXConnector.connect(java.util.Map) method.

     HashMap environment = new HashMap();
     environment.put("jmx.remote.protocol.provider.pkgs", "com.ibm.ws.jmx.connector.client");
     environment.put(JMXConnector.CREDENTIALS, new String[] { "bob", "bobpassword" });
     environment.put(ConnectorSettings.MAX_SERVER_WAIT_TIME, 120000);
     
     JMXServiceURL url = new JMXServiceURL("service:jmx:rest://:/IBMJMXConnectorREST");
     JMXConnector connector = JMXConnectorFactory.newJMXConnector(url, environment);
     connector.connect(environment);
     

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
DISABLE_HOSTNAME_VERIFICATION
Boolean setting that when enabled disables hostname verification on the client connections.
  1. static
  2. java.lang.String
MAX_SERVER_WAIT_TIME
Integer setting for the amount of time in milliseconds that the client waits for the server to become available before the JMX connection fails and a new connection must be created.
  1. static
  2. java.lang.String
NOTIFICATION_DELIVERY_INTERVAL
Integer setting for the maximum amount of time in milliseconds that the server waits for new notifications before responding to a request for notifications from the client.
  1. static
  2. java.lang.String
NOTIFICATION_INBOX_EXPIRY
Integer setting for the amount of time in milliseconds that the server waits before discarding notification registrations if the client has not checked for new notifications.
  1. static
  2. java.lang.String
NOTIFICATION_READ_TIMEOUT
Integer setting for the read timeout in milliseconds for notification fetching.
  1. static
  2. java.lang.String
READ_TIMEOUT
Integer setting for the read timeout in milliseconds for all client communications with the server, except notification fetching.
  1. static
  2. java.lang.String
SERVER_STATUS_POLLING_INTERVAL
Integer setting for the amount of time in milliseconds that the client waits between checks that the server is available again when MAX_SERVER_WAIT_TIME is non-zero.

Field Detail

DISABLE_HOSTNAME_VERIFICATION

  1. static final java.lang.String DISABLE_HOSTNAME_VERIFICATION
Boolean setting that when enabled disables hostname verification on the client connections. This can be useful for environments where the hostname used does not match the one specified in the server certificate.
See Also:

NOTIFICATION_DELIVERY_INTERVAL

  1. static final java.lang.String NOTIFICATION_DELIVERY_INTERVAL
Integer setting for the maximum amount of time in milliseconds that the server waits for new notifications before responding to a request for notifications from the client. A larger value results in better notification delivery times because less time is spent establishing new connections. Normally it is not necessary to adjust this value.
See Also:

NOTIFICATION_INBOX_EXPIRY

  1. static final java.lang.String NOTIFICATION_INBOX_EXPIRY
Integer setting for the amount of time in milliseconds that the server waits before discarding notification registrations if the client has not checked for new notifications. Normally it is not necessary to adjust this value.
See Also:

READ_TIMEOUT

  1. static final java.lang.String READ_TIMEOUT
Integer setting for the read timeout in milliseconds for all client communications with the server, except notification fetching. Adjust this value if the client throws read timeout exceptions because of a slow connection or client or server process.
See Also:

NOTIFICATION_READ_TIMEOUT

  1. static final java.lang.String NOTIFICATION_READ_TIMEOUT
Integer setting for the read timeout in milliseconds for notification fetching. Because the server might wait up to NOTIFICATION_DELIVERY_INTERVAL before responding, this value must be somewhat larger, though normally it is not necessary to adjust this value.
See Also:

MAX_SERVER_WAIT_TIME

  1. static final java.lang.String MAX_SERVER_WAIT_TIME
Integer setting for the amount of time in milliseconds that the client waits for the server to become available before the JMX connection fails and a new connection must be created. If the connection is restored, any previous notification listeners are registered again. To disable this behavior, set the value to zero.
See Also:

SERVER_STATUS_POLLING_INTERVAL

  1. static final java.lang.String SERVER_STATUS_POLLING_INTERVAL
Integer setting for the amount of time in milliseconds that the client waits between checks that the server is available again when MAX_SERVER_WAIT_TIME is non-zero. Normally it is not necessary to adjust this value.
See Also: