com.sonicsw.esb.mgmtapi
Class ESBAPIFactory

java.lang.Object
  com.sonicsw.esb.mgmtapi.ESBAPIFactory

public class ESBAPIFactory
extends java.lang.Object

A factory for ESBAPI instances. Instances of the factory are created using createESBAPIFactory(). Parameters set of factory instances are applied to ESBAPI instances created using the factory. Once created, an ESBAPI instance is immediately connected to the domain and is ready to be used.

Method Summary

ESBAPI	createAPI(java.lang.String domain, java.lang.String url, java.lang.String user, java.lang.String password) Create and connect an instance of an ESBAPI to the identified domain
static ESBAPIFactory	createESBAPIFactory() Create an instance of the ESBAPIFactory, with default values.
void	setConnectionListener(IConnectionListener listener) Set the connection listener ESBAPI instances that will be created by this factory (does not affect already created instances.
void	setRequestTimeout(long timeout) Set the request timeout for all ESBAPI instances that will be created by this factory (does not affect already created instances.

Methods inherited from class java.lang.Object

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

Method Detail

createESBAPIFactory

public static ESBAPIFactory createESBAPIFactory()

Create an instance of the ESBAPIFactory, with default values.

Returns:

an instance of ESBAPIFactory

setRequestTimeout

public void setRequestTimeout(long timeout)

Set the request timeout for all ESBAPI instances that will be created by this factory (does not affect already created instances.

Parameters:

timeout - - timeout in milliseconds.

setConnectionListener

public void setConnectionListener(IConnectionListener listener)

Set the connection listener ESBAPI instances that will be created by this factory (does not affect already created instances.

Parameters:

listener - - a listener to be notified about connection events.

createAPI

public ESBAPI createAPI(java.lang.String domain,
                        java.lang.String url,
                        java.lang.String user,
                        java.lang.String password)

Create and connect an instance of an ESBAPI to the identified domain

Parameters:

domain - - the domain name to which a connection is being established

url - - the URL to be used - either a broker connection or the location of a ds.xml

user - - the user name to authenticate with

password - - the password to authenticate with

Returns:

a fully connected instance of an ESBAPI