org.marketcetera.client

Class ClientManager

java.lang.Object

org.marketcetera.client.ClientManager

public final class ClientManager
extends Object

Abstraction that manages the initialization of the Client and provides an easy way to get to its singleton instance.

Since:

1.0.0

Version:

$Id: ClientManager.java 17411 2017-04-28 14:50:38Z colin $

Author:

anshul@marketcetera.com

Constructor Summary

Constructors

Constructor and Description
ClientManager()

Method Summary

Modifier and Type	Method and Description
static void	addClientInitListener(ClientInitListener inClientInitListener) Add the given client listener.
Client	getClient() Get the Client value.
static Client	getInstance() Returns the Client instance after it has been initialized via init(ClientParameters)
ClientParameters	getParameters() Get the parameters value.
static void	init(ClientParameters inParameter) Initializes the connection to the server.
static boolean	isInitialized() Returns true if the client is initialized, false if it's not.
static void	removeClientInitListener(ClientInitListener inClientInitListener) Remove the given client listener.
void	setClient(Client inClient) Sets the Client value.
static void	setClientFactory(ClientFactory inFactory) Sets the ClientFactory to use to create the Client.
void	setParameters(ClientParameters inParameters) Sets the parameters value.
void	start() Validates and starts the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientManager

public ClientManager()

Method Detail

start

@PostConstruct
public void start()

Validates and starts the object.

getParameters

public ClientParameters getParameters()

Get the parameters value.

Returns:

a ClientParameters value

setParameters

public void setParameters(ClientParameters inParameters)

Sets the parameters value.

Parameters:

inParameters - a ClientParameters value

getClient

public Client getClient()

Get the Client value.

Returns:

a Client value

setClient

public void setClient(Client inClient)

Sets the Client value.

Parameters:

inClient - a Client value

init

public static void init(ClientParameters inParameter)
                 throws ConnectionException,
                        ClientInitException

Initializes the connection to the server. The handle to communicate with the server can be obtained via getInstance().

Parameters:

inParameter - The parameters to connect the client. Cannot be null.

Throws:

ConnectionException - if there were errors connecting to the server.

ClientInitException - if the client is already initialized.

setClientFactory

public static void setClientFactory(ClientFactory inFactory)
                             throws ClientInitException

Sets the ClientFactory to use to create the Client.

Parameters:

inFactory - a ClientFactory value

Throws:

ClientInitException - if the client is already initialized.

getInstance

public static Client getInstance()
                          throws ClientInitException

Returns the Client instance after it has been initialized via init(ClientParameters)

Returns:

the client instance to communicate with the server.

Throws:

ClientInitException - if the client is not initialized.

isInitialized

public static boolean isInitialized()

Returns true if the client is initialized, false if it's not.

Returns:

if the client is initialized.

addClientInitListener

public static void addClientInitListener(ClientInitListener inClientInitListener)

Add the given client listener.

Parameters:

inClientInitListener - a ClientInitListener value

removeClientInitListener

public static void removeClientInitListener(ClientInitListener inClientInitListener)

Remove the given client listener.

Parameters:

inClientInitListener - a ClientInitListener value