com.ibm.websphere.management

Class AdminClientFactory

java.lang.Object

com.ibm.websphere.management.AdminClientFactory

public abstract class AdminClientFactory
extends java.lang.Object

The AdminClientFactory allows you to create a concrete AdminClient based on the properties provided; keys for the properties are in the AdminClient class.

The AdminClient is the client-side interface to reach the server side JMX connector which in turn invokes the AdminService methods; supported AdminClient types are SOAP and RMI.

The required properties for SOAP/RMI based AdminClient are the host name and port number, which are defined as AdminClient.CONNECTOR_HOST and AdminClient.CONNECTOR_PORT. The port for SOAP connector is defined within the serverindex.xml of the server your client connects to. In a single server environment, the default value with the installation is "8880"; in a distributed environment, the port varies according to the specific configuration. The port for RMI connector is the same as the naming bootstrap port which is defined in the node serverindex.xml file. The default value in a single server environment is "2809".

Below is an example to create a SOAP based AdminClient:

        java.util.Properties props = new java.util.Properties();
        props.setProperty(AdminClient.CONNECTOR_TYPE, AdminClient.CONNECTOR_TYPE_SOAP);
        props.setProperty(AdminClient.CONNECTOR_HOST, "ahost.ibm.com");
        props.setProperty(AdminClient.CONNECTOR_PORT, "8880");
        AdminClient client = AdminClientFactory.createAdminClient(props);
   

Constructor Summary

Constructors

Constructor and Description
AdminClientFactory()

Method Summary

Methods

Modifier and Type	Method and Description
static AdminClient	createAdminClient(java.util.Properties props) Creates an AdminClient to communicate with a remote AdminService.
static javax.security.auth.Subject	jaas_login(java.lang.String authTarget, java.lang.String loginSource, java.lang.String user, java.lang.String password, java.lang.String realm, java.lang.String krb5Ccache, java.lang.String krb5Config)
static void	setKrbConfigProp(java.lang.String krb5Config)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AdminClientFactory

public AdminClientFactory()

Method Detail

createAdminClient

public static AdminClient createAdminClient(java.util.Properties props)
                                     throws ConnectorException

Creates an AdminClient to communicate with a remote AdminService.

Parameters:

props - a set of properties to define the AdminClient

Returns:

an AdminClient connected to a remote AdminService

Throws:

InvalidAdminClientTypeException - if an unrecognized connector type is given

ConnectorException - if the AdminClient cannot be created for any other reason

jaas_login

public static javax.security.auth.Subject jaas_login(java.lang.String authTarget,
                                     java.lang.String loginSource,
                                     java.lang.String user,
                                     java.lang.String password,
                                     java.lang.String realm,
                                     java.lang.String krb5Ccache,
                                     java.lang.String krb5Config)
                                              throws WSLoginFailedException

Throws:

WSLoginFailedException

setKrbConfigProp

public static void setKrbConfigProp(java.lang.String krb5Config)