com.ibm.websphere.management
Interface AdminClient

public interface AdminClient

The AdminClientImpl is a concrete Java class to provide the client side APIs to the remote AdminService. It delegates all the calls to the server side JMX connector through the local AdminServiceProxy. The implemented AdminServiceProxy uses a specific transport to communication the JMX connector. The currently supported transports include SOAP and RMI.

Most of APIs here are mapped from those defined in JMX MBeanServer interface, but not all MBeanServer APIs are contained in the AdminClientImpl.

The methods mapped from the javax.management.MBeanServer include

In a single-sever environment, the behavior for these methods is exactly the same as that defined in JMX specification because there is only one MBeanServer involved. However, in a multi-node enrivonment, it's very important to beware the existence of MBean request routing. Most methods which take the complete javax.management.ObjectName as a paramemter may be routed to the downstream process if the AdminClientImpl connects to the managing process such as the cell manager and node agent. The methods which take no parameters are only applicable to the local MBeanServer; for example, if the getMBeanCount method is called when connected to the cell manager, it will return only the MBean count for the cellmgr MBeanServer, not the MBean count for the whole cell.

Routing is always in a top-down fashion; that is, from the cellmgr to the node agent to the managed process. The routing decision is based on the "node" and "process" properties in the ObjectName; the cellmgr routes requests to the downstream node agents based on the "node" property, while each node agent routes to the processes sitting in that node based on the "process" property. If the corresponding routing property is not present (for example, no "node" property when the cellmgr is determining where to route the method), the method will be executed locally.

Note that queryNames is a little special: it accepts an ObjectName which may contain wildcard characters (known as an ObjectName pattern). If a pattern is used and the corresponding routing property is not found, the query will go across all downstream nodes. For example, if the ObjectName "*:node=DefaultNode,*" is used while connected to the cellmgr, the query will go across all managed processes which are in the DefaultNode. A special case of this is queryNames(null, null), which will allow the query to run on all downstream processes (the same as the pattern "*:*"). Note that if an ObjectName pattern is not given, the query will not be routed if the routing properties are not present, like other methods.

For the JMX event support, AdminClientImpl supports the distributed event notification which is not specified in the current JMX specification. The semantics here is slightly different from that from the JMX MBeanServer. For details, look at the javadoc for LocalEventNotifier .

In case that a call to the AdminClientImpl can not reach the server, a ConnectorNotAvailabeException is thrown and the AdminClientImpl is marked as "down". If the server is back online later on, the reconnect method can be called to bring the AdminClientImpl back "up".

Enable security in the base server.

For SOAP based AdminClient, the users need to specifiy the "username" and "password" and explicitly set "securityEnabled" as "true". Some other properties are also required in order to make a SSL connection, these properties can be either specified as a Java system properties or passed as paramemters when invoking AdminClientFactory.createAdminClient(Properties). These properties include

The javax.net.ssl.trustStore and javax.net.ssl.keyStore are mandatory, the passwords for these two stores are required only when the stores are key protected.

An exmample to make a secure SOAP based AdminClient: 


    	Properties props = new Properties();    	
   	props.setProperty(AdminClient.CONNECTOR_HOST, "localhost");
   	props.setProperty(AdminClient.CONNECTOR_PORT, "8880");
   	props.setProperty(AdminClient.CONNECTOR_TYPE, AdminClient.CONNECTOR_TYPE_SOAP);
   	props.setProperty(AdminClient.CONNECTOR_SECURITY_ENABLED, "true");
   	props.setProperty(AdminClient.USERNAME, "test2");
   	props.setProperty(AdminClient.PASSWORD, "user24test");
      props.setProperty("javax.net.ssl.trustStore", "C:/WebSphere/AppServer/etc/DummyClientTrustFile.jks");
		props.setProperty("javax.net.ssl.keyStore", "C:/WebSphere/AppServer/etc/DummyClientKeyFile.jks");
		props.setProperty("javax.net.ssl.trustStorePassword", "WebAS");
		props.setProperty("javax.net.ssl.keyStorePassword", "WebAS");
   	AdminClient client = AdminClientFactory.createAdminClient(props);

To make a secure RMI based AdminClient is a little easier because you can rely on existing "com.ibm.CORBA.ConfigURL" which normal points to a property file, for instance, $WAS_ROOT/properties/sas.client.properites. There are a couple different ways to specify the login username and password and it's determined by "com.ibm.CORBA.loginSource" in "com.ibm.CORBA.ConfigURL". For programmatic login, you can set "com.ibm.CORBA.loginSource" as "none" and then provide your username/password when you create a AdminClient using AdminClientFactory.

For example, 

      Properties props = new Properties();
     	props.setProperty(AdminClient.CONNECTOR_HOST, "localhost");
   	props.setProperty(AdminClient.CONNECTOR_PORT, "2809");
   	props.setProperty(AdminClient.CONNECTOR_TYPE, AdminClient.CONNECTOR_TYPE_RMI);
   	props.setProperty(AdminClient.CONNECTOR_SECURITY_ENABLED, "true");
   	props.setProperty(AdminClient.USERNAME, "test");
   	props.setProperty(AdminClient.PASSWORD, "user4test");
 		AdminClient client = AdminClientFactory.createAdminClient(props);

Field Summary
static java.lang.String CONNECTOR_HOST
          The name of the property which defines the host name with which the connector is communicating.
static java.lang.String CONNECTOR_PORT
          The name of the property which defines the port number with which the connector is communicating.
static java.lang.String CONNECTOR_SECURITY_ENABLED
          To indicate the SOAP connector with SSL enabled.
static java.lang.String CONNECTOR_SOAP_CONFIG
          The property name for SOAP ConfigURL whose value should be a soap client props file.
static java.lang.String CONNECTOR_SOAP_REQUEST_TIMEOUT
          The property name whose value should be the timeout for a SOAP request.
static java.lang.String CONNECTOR_TYPE
          The name of the property which defines the type of the connector.
static java.lang.String CONNECTOR_TYPE_JMS
          The connector type which communicates via JMS.
static java.lang.String CONNECTOR_TYPE_RMI
          The connector type which communicates via RMI.
static java.lang.String CONNECTOR_TYPE_SOAP
          The connector type which communicates via SOAP.
static java.lang.String[] CONNECTOR_TYPES
          A list of all the valid connector types.
static java.lang.String PASSWORD
           
static java.lang.String PROTOCOL_ADAPTOR_TYPE_SNMP
          The protocol adaptor type which communicates via SNMP.
static java.lang.String USERNAME
          The username and password when security is enabled
 
Method Summary
 void addNotificationListener(javax.management.ObjectName name, javax.management.NotificationListener listener, javax.management.NotificationFilter filter, java.lang.Object handback)
          Adds a listener to exactly one MBean.
 void addNotificationListenerExtended(javax.management.ObjectName name, javax.management.NotificationListener listener, javax.management.NotificationFilter filter, java.lang.Object handback)
          Adds a listener to multiple MBeans.
 java.lang.Object getAttribute(javax.management.ObjectName name, java.lang.String attribute)
           
 javax.management.AttributeList getAttributes(javax.management.ObjectName name, java.lang.String[] attributes)
           
 java.util.Properties getConnectorProperties()
          Return a list of properties which describe the connector.
 java.lang.String getDefaultDomain()
           
 java.lang.String getDomainName()
           
 java.lang.Integer getMBeanCount()
           
 javax.management.MBeanInfo getMBeanInfo(javax.management.ObjectName name)
           
 javax.management.ObjectName getServerMBean()
          Obtain the ObjectName for the MBean representing the server which this client connects to
 java.lang.String getType()
          Returns the type of connector being used by this AdminClient.
 java.lang.Object invoke(javax.management.ObjectName name, java.lang.String operationName, java.lang.Object[] params, java.lang.String[] signature)
           
 Session isAlive()
           
 boolean isInstanceOf(javax.management.ObjectName name, java.lang.String className)
           
 boolean isRegistered(javax.management.ObjectName name)
           
 java.util.Set queryNames(javax.management.ObjectName name, javax.management.QueryExp query)
           
 void removeNotificationListener(javax.management.ObjectName name, javax.management.NotificationListener listener)
          Removes a listener from exactly one MBean.
 void removeNotificationListenerExtended(javax.management.NotificationListener listener)
          Deprecated. as of 5.0.1, use removeNotificationListenerExtended(ObjectName,NotificationListener)
 void removeNotificationListenerExtended(javax.management.ObjectName name, javax.management.NotificationListener listener)
          Removes a listener from multiple MBeans.
 void setAttribute(javax.management.ObjectName name, javax.management.Attribute attribute)
           
 javax.management.AttributeList setAttributes(javax.management.ObjectName name, javax.management.AttributeList attributes)
           
 

Field Detail

CONNECTOR_TYPE

public static final java.lang.String CONNECTOR_TYPE
The name of the property which defines the type of the connector. Valid values are defined as CONNECTOR_TYPE_* static final Strings.

See Also:
Constant Field Values

CONNECTOR_HOST

public static final java.lang.String CONNECTOR_HOST
The name of the property which defines the host name with which the connector is communicating.

See Also:
Constant Field Values

CONNECTOR_PORT

public static final java.lang.String CONNECTOR_PORT
The name of the property which defines the port number with which the connector is communicating.

See Also:
Constant Field Values

CONNECTOR_TYPE_SOAP

public static final java.lang.String CONNECTOR_TYPE_SOAP
The connector type which communicates via SOAP.

See Also:
Constant Field Values

CONNECTOR_TYPE_RMI

public static final java.lang.String CONNECTOR_TYPE_RMI
The connector type which communicates via RMI.

See Also:
Constant Field Values

CONNECTOR_TYPE_JMS

public static final java.lang.String CONNECTOR_TYPE_JMS
The connector type which communicates via JMS.

See Also:
Constant Field Values

PROTOCOL_ADAPTOR_TYPE_SNMP

public static final java.lang.String PROTOCOL_ADAPTOR_TYPE_SNMP
The protocol adaptor type which communicates via SNMP.

See Also:
Constant Field Values

CONNECTOR_TYPES

public static final java.lang.String[] CONNECTOR_TYPES
A list of all the valid connector types.

CONNECTOR_SOAP_CONFIG

public static final java.lang.String CONNECTOR_SOAP_CONFIG
The property name for SOAP ConfigURL whose value should be a soap client props file. In general, "com.ibm.SOAP.ConfigURL" can either specified as a system property or passed as part of paremeters while making a AdminClientFactory.createAdminClient(java.util.Properties) call.

See Also:
Constant Field Values

CONNECTOR_SOAP_REQUEST_TIMEOUT

public static final java.lang.String CONNECTOR_SOAP_REQUEST_TIMEOUT
The property name whose value should be the timeout for a SOAP request. The default value is 180 seconds.

See Also:
Constant Field Values

CONNECTOR_SECURITY_ENABLED

public static final java.lang.String CONNECTOR_SECURITY_ENABLED
To indicate the SOAP connector with SSL enabled.

With SSL enabled, there are additional properties such as "javax.net.ssl.trustStore", "javax.net.ssl.keyStore". If the trustStore or keyStore is password protected, then "javax.net.ssl.trustStorePassword" or "javax.net.ssl.keyStorePassword" should be specified. These properties can either be specified as system properties using java -D options or passed when calling the AdminClientFactory to create the SOAP AdminClient.

See Also:
Constant Field Values

USERNAME

public static final java.lang.String USERNAME
The username and password when security is enabled

See Also:
Constant Field Values

PASSWORD

public static final java.lang.String PASSWORD
See Also:
Constant Field Values
Method Detail

getType

public java.lang.String getType()
Returns the type of connector being used by this AdminClient. Valid types are defined by CONNECTOR_TYPE_* static final Strings.

getConnectorProperties

public java.util.Properties getConnectorProperties()
Return a list of properties which describe the connector.

getServerMBean

public javax.management.ObjectName getServerMBean()
                                           throws ConnectorException
Obtain the ObjectName for the MBean representing the server which this client connects to

ConnectorException

isAlive

public Session isAlive()
                throws ConnectorException
ConnectorException

queryNames

public java.util.Set queryNames(javax.management.ObjectName name,
                                javax.management.QueryExp query)
                         throws ConnectorException
ConnectorException

getMBeanCount

public java.lang.Integer getMBeanCount()
                                throws ConnectorException
ConnectorException

getDomainName

public java.lang.String getDomainName()
                               throws ConnectorException
ConnectorException

getDefaultDomain

public java.lang.String getDefaultDomain()
                                  throws ConnectorException
ConnectorException

getMBeanInfo

public javax.management.MBeanInfo getMBeanInfo(javax.management.ObjectName name)
                                        throws javax.management.InstanceNotFoundException,
                                               javax.management.IntrospectionException,
                                               javax.management.ReflectionException,
                                               ConnectorException
javax.management.InstanceNotFoundException
javax.management.IntrospectionException
javax.management.ReflectionException
ConnectorException

isInstanceOf

public boolean isInstanceOf(javax.management.ObjectName name,
                            java.lang.String className)
                     throws javax.management.InstanceNotFoundException,
                            ConnectorException
javax.management.InstanceNotFoundException
ConnectorException

isRegistered

public boolean isRegistered(javax.management.ObjectName name)
                     throws ConnectorException
ConnectorException

getAttribute

public java.lang.Object getAttribute(javax.management.ObjectName name,
                                     java.lang.String attribute)
                              throws javax.management.MBeanException,
                                     javax.management.AttributeNotFoundException,
                                     javax.management.InstanceNotFoundException,
                                     javax.management.ReflectionException,
                                     ConnectorException
javax.management.MBeanException
javax.management.AttributeNotFoundException
javax.management.InstanceNotFoundException
javax.management.ReflectionException
ConnectorException

getAttributes

public javax.management.AttributeList getAttributes(javax.management.ObjectName name,
                                                    java.lang.String[] attributes)
                                             throws javax.management.InstanceNotFoundException,
                                                    javax.management.ReflectionException,
                                                    ConnectorException
javax.management.InstanceNotFoundException
javax.management.ReflectionException
ConnectorException

setAttribute

public void setAttribute(javax.management.ObjectName name,
                         javax.management.Attribute attribute)
                  throws javax.management.InstanceNotFoundException,
                         javax.management.AttributeNotFoundException,
                         javax.management.InvalidAttributeValueException,
                         javax.management.MBeanException,
                         javax.management.ReflectionException,
                         ConnectorException
javax.management.InstanceNotFoundException
javax.management.AttributeNotFoundException
javax.management.InvalidAttributeValueException
javax.management.MBeanException
javax.management.ReflectionException
ConnectorException

setAttributes

public javax.management.AttributeList setAttributes(javax.management.ObjectName name,
                                                    javax.management.AttributeList attributes)
                                             throws javax.management.InstanceNotFoundException,
                                                    javax.management.ReflectionException,
                                                    ConnectorException
javax.management.InstanceNotFoundException
javax.management.ReflectionException
ConnectorException

invoke

public java.lang.Object invoke(javax.management.ObjectName name,
                               java.lang.String operationName,
                               java.lang.Object[] params,
                               java.lang.String[] signature)
                        throws javax.management.InstanceNotFoundException,
                               javax.management.MBeanException,
                               javax.management.ReflectionException,
                               ConnectorException
javax.management.InstanceNotFoundException
javax.management.MBeanException
javax.management.ReflectionException
ConnectorException

addNotificationListener

public void addNotificationListener(javax.management.ObjectName name,
                                    javax.management.NotificationListener listener,
                                    javax.management.NotificationFilter filter,
                                    java.lang.Object handback)
                             throws javax.management.InstanceNotFoundException,
                                    ConnectorException
Adds a listener to exactly one MBean. Behaves identically to the JMX MBeanServer.addNotificationListener, except that it works in a distributed environment. This means that MBeans which are not located on this specific process may have listeners added to it assuming routing information is correct.

Parameters:
name - the name of the MBean on which the listener should be added.
listener - the listener object which will handle the notifications emitted by the registered MBean
filter - the filter object; if filter is null, no filtering will be performed before handling notifications
handback - the context to be sent to the listener when a notification is emitted
Throws:
javax.management.InstanceNotFoundException - the MBean name provided does not match any of the registered MBeans.
ConnectorException - a communication problem occured adding the listener

addNotificationListenerExtended

public void addNotificationListenerExtended(javax.management.ObjectName name,
                                            javax.management.NotificationListener listener,
                                            javax.management.NotificationFilter filter,
                                            java.lang.Object handback)
                                     throws ConnectorException
Adds a listener to multiple MBeans. Behaves similarly to the addNotificationListener(javax.management.ObjectName, javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object) method, except for the following:
  • The name parameter may include wildcards, and pattern matching is performed as in the queryMBeans method; null is not allowed
  • Listeners added with this method will receive notifications by MBeans registered in the future; i.e. the MBean does not need to be active currently to listen to it.
  • An InstanceNotFoundException is never thrown.

Parameters:
name - a pattern matching zero or more MBeans; notifications from all these MBeans will be routed to the listener
listener - the listener object which will handle the notifications emitted by the registered MBean
filter - the filter object; if filter is null, no filtering will be performed before handling notifications
handback - the context to be sent to the listener when a notification is emitted
Throws:
ConnectorException - a communication problem occured adding the listener

removeNotificationListener

public void removeNotificationListener(javax.management.ObjectName name,
                                       javax.management.NotificationListener listener)
                                throws javax.management.InstanceNotFoundException,
                                       javax.management.ListenerNotFoundException,
                                       ConnectorException
Removes a listener from exactly one MBean. Behaves identically to the JMX MBeanServer.removeNotificationListener, except that it works in a distributed environment. This means that MBeans which are not located on this specific process may have listeners added to it assuming routing information is correct.

This method should not be used to remove listeners added with addNotificationListenerExtended(javax.management.ObjectName, javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object); use removeNotificationListenerExtended(ObjectName,NotificationListener) instead.

Parameters:
name - the name of the MBean on which the listener should be removed
listener - the listener object which will handle the notifications emitted by the registered MBean
Throws:
javax.management.InstanceNotFoundException - the MBean name provided does not match any of the registered MBeans
javax.management.ListenerNotFoundException - the listener is not registered in the MBean
ConnectorException - a communication problem occured adding the listener

removeNotificationListenerExtended

public void removeNotificationListenerExtended(javax.management.NotificationListener listener)
                                        throws javax.management.ListenerNotFoundException,
                                               ConnectorException
Deprecated. as of 5.0.1, use removeNotificationListenerExtended(ObjectName,NotificationListener)

Removes a listener from multiple MBeans. This should be used to remove listeners which were added with addNotificationListenerExtended(javax.management.ObjectName, javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object). Behaves similarly to the removeNotificationListener(javax.management.ObjectName, javax.management.NotificationListener) method, except for the following:
  • All instances of the given listener are removed, even if it is added to multiple MBeans.
  • An InstanceNotFoundException is never thrown.

Parameters:
listener - the listener object which will handle the notifications emitted by the registered MBean
Throws:
javax.management.ListenerNotFoundException - the listener is not registered in the MBean
ConnectorException - a communication problem occured adding the listener

removeNotificationListenerExtended

public void removeNotificationListenerExtended(javax.management.ObjectName name,
                                               javax.management.NotificationListener listener)
                                        throws javax.management.ListenerNotFoundException,
                                               ConnectorException
Removes a listener from multiple MBeans. This should be used to remove listeners which were added with addNotificationListenerExtended(javax.management.ObjectName, javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object). Behaves similarly to the removeNotificationListener(javax.management.ObjectName, javax.management.NotificationListener) method, except for the following:

Parameters:
name - the name of the MBean on which the listener should be removed; this must be the same name as that given during addNotificationListenerExtended (cannot remove listener from subset of MBeans)
listener - the listener object which will handle the notifications emitted by the registered MBean
Throws:
javax.management.ListenerNotFoundException - the listener is not registered in the MBean
ConnectorException - a communication problem occured adding the listener

 

WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.

 

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.