Skip navigation links

com.stellent.cis.client.command
Interface ICommandClient

All Superinterfaces:

ICommandApplication, ICommandBeanContext

public interface ICommandClient

extends ICommandApplication

The interface which defines how a client connects with the SCS Command layer. This is the entry point for all clients using the command layer. The connection methods use the given input to retrieve the configuration information that tells the client how to configure the local command layer for operation. In instances where the client is remote, the configuration is only partial with the bulk of the command operations occurring on the hosted SCS Command Layer. In standalone modes, all operations are done locally. To actually connect to an existing command layer, or use the local command layer in standalone operation, use the CISApplicationFactory

See Also:

CISApplicationFactory

Method Summary

void	connect(ICommandClientConfig clientConfig) Connect to the server using the provided configuration.
ICommandClientConfig	getClientConfig()
java.lang.String	getConnectionDescription()
boolean	isConnected()

Methods inherited from interface com.stellent.cis.client.command.ICommandApplication

getApplicationConfig, getCommandFacade, getStartTime, getVersion, isInitialized

Methods inherited from interface com.stellent.cis.client.command.ICommandBeanContext

containsBean, getAllBeansOfType, getApplicationResource, getBean, getBean, getMessage, getParentContext, publishEvent

Method Detail

connect

void connect(ICommandClientConfig clientConfig)
             throws CommandException

Connect to the server using the provided configuration. First checks the JVM to see if the command server is in the same instance, next checks if EJB is enabled, and finally if RMI is enabled. If none succeed, an exception is thrown.

Parameters:

clientConfig - the config object for the command layer communication

Throws:

CommandException

isConnected

boolean isConnected()

Returns:

true if this object is connected, false otherwise

getConnectionDescription

java.lang.String getConnectionDescription()

Returns:

a descriptive string describing how the client is connected

getClientConfig

ICommandClientConfig getClientConfig()

Returns:

the configuration object used to configure this client

Skip navigation links