com.ibm.websphere.jmx.connector.rest
Interface ConnectorSettings
- public interface ConnectorSettings
- 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
- 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)
orJMXConnector.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://<host>:<port>/IBMJMXConnectorREST"); JMXConnector connector = JMXConnectorFactory.newJMXConnector(url, environment); connector.connect(environment);
Field Summary
Modifier and Type | Field and Description |
---|---|
|
CERTIFICATE_AUTHENTICATION
Indicates that the
JMXConnector.CREDENTIALS will be handled by SSL certificate based authentication.
|
|
CUSTOM_SSLSOCKETFACTORY
Indicates that all JMX connections will use the specified SSLSocketFactory
|
|
DISABLE_HOSTNAME_VERIFICATION
Boolean setting that when enabled disables hostname verification on the client connections.
|
|
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.
|
|
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.
|
|
NOTIFICATION_FETCH_INTERVAL
Integer setting for the amount of time in milliseconds that the client waits before making a new request to fetch notifications.
|
|
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.
|
|
NOTIFICATION_READ_TIMEOUT
Integer setting for the read timeout in milliseconds for notification fetching.
|
|
READ_TIMEOUT
Integer setting for the read timeout in milliseconds for all client communications with the server, except notification fetching.
|
|
SERVER_FAILOVER_INTERVAL
Integer setting for the amount of time in milliseconds that the client waits between checks that the server is still available.
|
|
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.
|
|
WLM_ENDPOINTS
Work Load Management Endpoints
|
Field Detail
DISABLE_HOSTNAME_VERIFICATION
- static final java.lang.String DISABLE_HOSTNAME_VERIFICATION
NOTIFICATION_DELIVERY_INTERVAL
- static final java.lang.String NOTIFICATION_DELIVERY_INTERVAL
NOTIFICATION_INBOX_EXPIRY
- static final java.lang.String NOTIFICATION_INBOX_EXPIRY
NOTIFICATION_FETCH_INTERVAL
- static final java.lang.String NOTIFICATION_FETCH_INTERVAL
READ_TIMEOUT
- static final java.lang.String READ_TIMEOUT
NOTIFICATION_READ_TIMEOUT
- static final java.lang.String NOTIFICATION_READ_TIMEOUT
SERVER_FAILOVER_INTERVAL
- static final java.lang.String SERVER_FAILOVER_INTERVAL
ConnectorSettings.NOTIFICATION_FETCH_INTERVAL
whenever there are notification listeners registered with this client.
MAX_SERVER_WAIT_TIME
- static final java.lang.String MAX_SERVER_WAIT_TIME
SERVER_STATUS_POLLING_INTERVAL
- static final java.lang.String SERVER_STATUS_POLLING_INTERVAL
CERTIFICATE_AUTHENTICATION
- static final java.lang.String CERTIFICATE_AUTHENTICATION
JMXConnector.CREDENTIALS
will be handled by SSL certificate based authentication.
CUSTOM_SSLSOCKETFACTORY
- static final java.lang.String CUSTOM_SSLSOCKETFACTORY
WLM_ENDPOINTS
- static final java.lang.String WLM_ENDPOINTS
Work Load Management Endpoints
List of Strings setting to indicate which endpoints, in addition to the host and port in theJMXServiceURL
, are valid for
establishing a connection. An endpoint is defined as "host:port".
When the work load management endpoint list is set, the initial
connection is made using one of the endpoints in the complete set of
available endpoints. The complete set of endpoints is the host and port
specified to the JMXServiceURL
as well as the contents of the
work load management endpoint list.
This property is only supported in the programmatic JMX environment.
List<String> endpoints = new ArrayList<String> endpoints.add("<host2>:<port>"); HashMapThe example code would establish the avialable endpoint set as host:port and host2:port.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.WLM_ENDPOINTS, endpoints); JMXServiceURL url = new JMXServiceURL("service:jmx:rest://<host>:<port>/IBMJMXConnectorREST"); JMXConnector connector = JMXConnectorFactory.newJMXConnector(url, environment); connector.connect(environment);
No ordering guarantees are made regarding which endpoint is ultimately used for the connection, but all endpoints will be tried in order to establish a connection. Only when all endpoints in the complete set are inaccessible is a connection considered to be unobtainable.
Fail-over retry will occur if the invoked operation could not be started. If the connection is lost during an operation, no retry will be done so as to not issue the same command twice. In other words, if we loose the connection before the operation can report success, an IOException will be thrown and the operation will not be re-tried.