org.marketcetera.saclient.rpc

Class RpcSAClientImpl

java.lang.Object

org.marketcetera.saclient.AbstractSAClient

org.marketcetera.saclient.rpc.RpcSAClientImpl

All Implemented Interfaces:

EmitterAdapter, SAClient, org.springframework.context.Lifecycle

public class RpcSAClientImpl
extends AbstractSAClient

Provides an RPC implementation of SAClient.

Since:

$Release$

Version:

$Id$

Author:

Colin DuPlantis

Field Summary

Fields inherited from class org.marketcetera.saclient.AbstractSAClient

parameters, running

Method Summary

Methods

Modifier and Type	Method and Description
ModuleURN	createStrategy(CreateStrategyParameters inParameters) Creates a new strategy module using the given strategy creation parameters.
void	delete(ModuleURN inURN) Deletes the module instance having the supplied URN.
protected void	doStart()
protected void	doStop()
ContextClassProvider	getContextClassProvider() Get the contextClassProvider value.
List<ModuleURN>	getInstances(ModuleURN inProviderURN) Returns the list of module instances available.
ModuleInfo	getModuleInfo(ModuleURN inURN) Returns the module information for the module instance with the supplied URN.
Map<String,Object>	getProperties(ModuleURN inURN) Fetches all the available properties of the module with the supplied URN.
List<ModuleURN>	getProviders() Returns the list of providers available.
CreateStrategyParameters	getStrategyCreateParms(ModuleURN inURN) Fetches the strategy creation parameters (including the strategy script) for the strategy with the supplied URN.
void	sendData(Object inData) Sends the given object to the Strategy Agent where registered listeners will receive it.
void	setContextClassProvider(ContextClassProvider inContextClassProvider) Sets the contextClassProvider value.
Map<String,Object>	setProperties(ModuleURN inURN, Map<String,Object> inProperties) Sets the supplied properties of the module.
void	start(ModuleURN inURN) Starts the module instance having the supplied URN.
void	stop(ModuleURN inURN) Stops the module instance having the supplied URN.

Methods inherited from class org.marketcetera.saclient.AbstractSAClient

addConnectionStatusListener, addDataReceiver, close, connectionStatusChanged, failIfClosed, failIfDisconnected, getParameters, isRunning, receiveData, removeConnectionStatusListener, removeDataReciever, start, stop, wrapRemoteFailure

Methods inherited from class java.lang.Object

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

Method Detail

getProviders

public List<ModuleURN> getProviders()
                             throws ConnectionException

Description copied from interface: SAClient

Returns the list of providers available.

If no providers are available this list is empty.

Returns:

the list of providers available.

Throws:

ConnectionException - if there were errors completing the operation.

getInstances

public List<ModuleURN> getInstances(ModuleURN inProviderURN)
                             throws ConnectionException

Description copied from interface: SAClient

Returns the list of module instances available.

If no instances are found, an empty list is returned.

Parameters:

inProviderURN - the URN of the provider whose instances should be returned. If null, all available instances are returned.

Returns:

the list of module instances available.

Throws:

ConnectionException - if there were errors completing the operation.

getModuleInfo

public ModuleInfo getModuleInfo(ModuleURN inURN)
                         throws ConnectionException

Description copied from interface: SAClient

Returns the module information for the module instance with the supplied URN.

Parameters:

inURN - the module instance URN. Cannot be null.

Returns:

the module info.

Throws:

ConnectionException - if there were errors completing the operation.

start

public void start(ModuleURN inURN)
           throws ConnectionException

Description copied from interface: SAClient

Starts the module instance having the supplied URN.

Only strategy module instances can be started. Attempts to start modules that are not strategy modules will fail.

Parameters:

inURN - the URN of the module that needs to be started. Cannot be null.

Throws:

ConnectionException - if there were errors completing the operation.

stop

public void stop(ModuleURN inURN)
          throws ConnectionException

Description copied from interface: SAClient

Stops the module instance having the supplied URN.

Only strategy module instances can be stopped. Attempts to stop modules that are not strategy modules will fail.

Parameters:

inURN - the URN of the module that needs to be stopped. Cannot be null.

Throws:

ConnectionException - if there were errors completing the operation.

delete

public void delete(ModuleURN inURN)
            throws ConnectionException

Description copied from interface: SAClient

Deletes the module instance having the supplied URN.

Only strategy module instances can be deleted. Attempts to delete modules that are not strategy modules will fail.

Parameters:

inURN - the URN of the module that needs to be deleted. Cannot be null.

Throws:

ConnectionException - if there were errors completing the operation.

getProperties

public Map<String,Object> getProperties(ModuleURN inURN)
                                 throws ConnectionException

Description copied from interface: SAClient

Fetches all the available properties of the module with the supplied URN.

Note that the property values may not be in the same type as is declared on the module's MXBean. The return types are open data types. Refer to the type mapping rules in MXBean documentation to figure out the return type for a particular property type. For example, enum property types are returned as string values.

Parameters:

inURN - the module URN. Cannot be null.

Returns:

All the available properties of that module.

Throws:

ConnectionException - if there were errors completing the operation.

setProperties

public Map<String,Object> setProperties(ModuleURN inURN,
                               Map<String,Object> inProperties)
                                 throws ConnectionException

Description copied from interface: SAClient

Sets the supplied properties of the module.

Only the following properties of strategy module can be set. Attempts to set the properties of a module that is not a strategy module or a strategy module property that is not in this list will fail.

• Parameters
• RoutingOrdersToORS

Note: Be sure to verify the values in the returned map to be sure that each property was set successfully. If there's a failure setting a property, the method doesn't fail. Instead, the value of the property that could not be set is a RemoteProperties instance that has details on the error encountered when setting the property.

Parameters:

inURN - the URN of the module whose properties are being set. Cannot be null.

inProperties - the new property values for the module. Cannot be null.

Returns:

the map of properties that were succesfully updated. In case a particular property could not be updated, the value of that property will contain a RemoteProperties instance that has details on the failure.

Throws:

ConnectionException - if there were errors completing the operation.

createStrategy

public ModuleURN createStrategy(CreateStrategyParameters inParameters)
                         throws ConnectionException

Description copied from interface: SAClient

Creates a new strategy module using the given strategy creation parameters.

Parameters:

inParameters - the strategy creation parameters. Cannot be null.

Returns:

the created module's URN.

Throws:

ConnectionException - if there were errors completing the operation.

getStrategyCreateParms

public CreateStrategyParameters getStrategyCreateParms(ModuleURN inURN)
                                                throws ConnectionException

Description copied from interface: SAClient

Fetches the strategy creation parameters (including the strategy script) for the strategy with the supplied URN.

This method is made available to enable a client to export strategy script contents. It's recommended that SAClient.getProperties(ModuleURN) be used for fetching the current values of strategy properties as SAClient.getStrategyCreateParms(org.marketcetera.module.ModuleURN) may yield stale values for certain strategy attributes like parameters.

Parameters:

inURN - the strategy module instnace URN. Cannot be null.

Returns:

the strategy creation parameters.

Throws:

ConnectionException - if there were errors completing the operation.

sendData

public void sendData(Object inData)
              throws ConnectionException

Description copied from interface: SAClient

Sends the given object to the Strategy Agent where registered listeners will receive it.

Parameters:

inData - an Object value

Throws:

ConnectionException - if there were errors completing the operation.

getContextClassProvider

public ContextClassProvider getContextClassProvider()

Get the contextClassProvider value.

Returns:

a ContextClassProvider value

setContextClassProvider

public void setContextClassProvider(ContextClassProvider inContextClassProvider)

Sets the contextClassProvider value.

Parameters:

inContextClassProvider - a ContextClassProvider value

doStart

protected void doStart()

Overrides:

doStart in class AbstractSAClient

doStop

protected void doStop()

Overrides:

doStop in class AbstractSAClient