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 final String
    A String representing the ObjectName that this MBean maps to.
    static final String
    Response map key containing the outcome of the connection attempt to the host.
    static final String
    Response map key containing the outcome of the secure JMX connection attempt to the collective participant.
    static final String
    Response map value returned when both the RXA and JMX connections to the host and collective participant respectively are successful.
  • Method Summary

    Modifier and Type
    Method
    Description
    Tests the connection to the specified host by establishing a RXA connection.
    testConnection(String hostName, String wlpUsrDir, 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 Details

    • OBJECT_NAME

      static final String OBJECT_NAME
      A String representing the ObjectName that this MBean maps to.
      See Also:
    • RESP_TEST_CONN_HOST_KEY

      static final String RESP_TEST_CONN_HOST_KEY
      Response map key containing the outcome of the connection attempt to the host.
      See Also:
    • RESP_TEST_CONN_SSL_KEY

      static final String RESP_TEST_CONN_SSL_KEY
      Response map key containing the outcome of the secure JMX connection attempt to the collective participant.
      See Also:
    • RESP_TEST_CONN_SUCCESS_VALUE

      static final 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:
  • Method Details

    • testConnection

      Map<String,Object> testConnection(String hostName)
      Tests the connection to the specified host by establishing a RXA connection.
      Parameters:
      hostName - The host name of the server. Must not be null 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

      Map<String,Object> testConnection(String hostName, String wlpUsrDir, 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 be null or an empty string. This host name should match the host name set to the defaultHostName variable for the server's server.xml
      wlpUsrDir - The canonical path for the user directory of server. This should match the WLP_USER_DIR environment variable for the server. Must not be null or an empty string. Must not have a trailing slash. Must not be encoded.
      serverName - The server name. Must not be null or an empty string.
      Returns:
      A map containing response data.