Interface CollectiveValidationMBean
-
public interface CollectiveValidationMBean
CollectiveValidationMBean defines the administrative interface that allows users to test configured RXA and SSL connection settings for a given collective member, controller, or host.The ObjectName for this MBean is "WebSphere:feature=collectiveController,type=CollectiveValidation,name=CollectiveValidation".
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
OBJECT_NAME
A String representing theObjectName
that this MBean maps to.static java.lang.String
RESP_TEST_CONN_HOST_KEY
Response map key containing the outcome of the connection attempt to the host.static java.lang.String
RESP_TEST_CONN_SSL_KEY
Response map key containing the outcome of the secure JMX connection attempt to the collective participant.static java.lang.String
RESP_TEST_CONN_SUCCESS_VALUE
Response map value returned when both the RXA and JMX connections to the host and collective participant respectively are successful.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Map<java.lang.String,java.lang.Object>
testConnection(java.lang.String hostName)
Tests the connection to the specified host by establishing a RXA connection.java.util.Map<java.lang.String,java.lang.Object>
testConnection(java.lang.String hostName, java.lang.String wlpUsrDir, java.lang.String serverName)
Tests the connection to the collective participant's host by establishing an RXA connection and the connection to the collective participant by establishing a secure JMX connection.
-
-
-
Field Detail
-
OBJECT_NAME
static final java.lang.String OBJECT_NAME
A String representing theObjectName
that this MBean maps to.- See Also:
- Constant Field Values
-
RESP_TEST_CONN_HOST_KEY
static final java.lang.String RESP_TEST_CONN_HOST_KEY
Response map key containing the outcome of the connection attempt to the host.- See Also:
- Constant Field Values
-
RESP_TEST_CONN_SSL_KEY
static final java.lang.String RESP_TEST_CONN_SSL_KEY
Response map key containing the outcome of the secure JMX connection attempt to the collective participant.- See Also:
- Constant Field Values
-
RESP_TEST_CONN_SUCCESS_VALUE
static final java.lang.String RESP_TEST_CONN_SUCCESS_VALUE
Response map value returned when both the RXA and JMX connections to the host and collective participant respectively are successful.- See Also:
- Constant Field Values
-
-
Method Detail
-
testConnection
java.util.Map<java.lang.String,java.lang.Object> testConnection(java.lang.String hostName)
Tests the connection to the specified host by establishing a RXA connection.- Parameters:
hostName
- The host name of the server. Must not benull
or an empty string. This host name should match the host name set to the defaultHostName variable for the server's server.xml- Returns:
- A map containing response data.
-
testConnection
java.util.Map<java.lang.String,java.lang.Object> testConnection(java.lang.String hostName, java.lang.String wlpUsrDir, java.lang.String serverName)
Tests the connection to the collective participant's host by establishing an RXA connection and the connection to the collective participant by establishing a secure JMX connection.- Parameters:
hostName
- The host name of the server. Must not benull
or an empty string. This host name should match the host name set to the defaultHostName variable for the server's server.xmlwlpUsrDir
- The canonical path for the user directory of server. This should match the WLP_USER_DIR environment variable for the server. Must not benull
or an empty string. Must not have a trailing slash. Must not be encoded.serverName
- The server name. Must not benull
or an empty string.- Returns:
- A map containing response data.
-
-