com.novell.zos.toolkit
Class ClientAgentFactory

java.lang.Object
  com.novell.zos.toolkit.ClientAgentFactory

public class ClientAgentFactory
extends Object

Factory pattern used to create new clients for connection to a GMS server.

This is the starting point for Clients to communicate with a GMS server.

Method Summary

static ClientAgent	newCachedClientAgent() Create an instance of a cached ClientAgent used to communicate with a GMS server.
static ClientAgent	newClientAgent(String server) Create an uninitialized instance of an ClientAgent used to communicate with a GMS server.
static ClientAgent	newClientAgent(String server, int portNumber) Create an uninitialized instance of an ClientAgent used to communicate with a GMS server.

Methods inherited from class java.lang.Object

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

Method Detail

newCachedClientAgent

public static ClientAgent newCachedClientAgent()
                                        throws GridException

Create an instance of a cached ClientAgent used to communicate with a GMS server. This uses the (cached) last good connection credentials typically set with a 'matrix login' command.

Returns:

a new initialized ClientAgent

Throws:

GridException - if not logged in

newClientAgent

public static ClientAgent newClientAgent(String server)
                                  throws GridConfigurationException

Create an uninitialized instance of an ClientAgent used to communicate with a GMS server. This bypasses any cached credentials, so login() must be subsequently called with a Credential. This connects on the default communication port (8100).

Parameters:

server - the DNS name or IP address of the GMS server

Returns:

a new uninitialized ClientAgent

Throws:

GridConfigurationException

newClientAgent

public static ClientAgent newClientAgent(String server,
                                         int portNumber)
                                  throws GridConfigurationException

Create an uninitialized instance of an ClientAgent used to communicate with a GMS server. This bypasses any cached credentials, so login() must be subsequently called with a Credential.

Parameters:

server - the DNS name or IP address of the GMS server

portNumber - the port configured for client communications set on the server

Returns:

a new uninitialized ClientAgent

Throws:

GridConfigurationException