org.marketcetera.util.ws.stateful

Class Client

java.lang.Object

org.marketcetera.util.ws.stateless.Node

org.marketcetera.util.ws.stateless.StatelessClient

org.marketcetera.util.ws.stateful.Client

All Implemented Interfaces:

UsesPort

public class Client
extends StatelessClient

A client node for stateful communication. Its (optional) application ID is that of the application which hosts the client. A session starts with login(String,char[]) and ends with logout().

Since:

1.0.0

Version:

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

Author:

tlerios@marketcetera.com

Field Summary

Fields inherited from class org.marketcetera.util.ws.stateless.Node

DEFAULT_CLIENT_HOST, DEFAULT_PORT, DEFAULT_SERVER_HOST

Constructor Summary

Constructors

Constructor and Description
Client() Creates a new client node with the default server host name and port, and no client application ID.
Client(AppId appId) Creates a new client node with the default server host name and port, and the given client application ID.
Client(String host, int port, AppId appId) Creates a new client node with the given server host name, port, and client application ID.
Client(String inHost, int inPort, AppId inAppId, ContextClassProvider inContextClassProvider) Create a new Client instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	assertValidSession() Asserts that an active session is in progress.
ClientContext	getContext() Returns a client context which the client must supply as an argument to every remote call made via proxies obtained from the receiver.
SessionId	getSessionId() Returns the receiver's session ID.
String	getUsername() Get the username value.
void	login(String user, char[] password) Initiates a new session using the given credentials.
void	logout() Ends an ongoing session.

Methods inherited from class org.marketcetera.util.ws.stateless.StatelessClient

fillContext, getAppId, getService

Methods inherited from class org.marketcetera.util.ws.stateless.Node

getConnectionUrl, getHost, getId, getNodeDescription, getPort, getPortDescriptors, setHost, setNodeDescription, setPort

Methods inherited from class java.lang.Object

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

Constructor Detail

Client

public Client(String inHost,
      int inPort,
      AppId inAppId,
      ContextClassProvider inContextClassProvider)

Create a new Client instance.

Parameters:

inHost - a String value

inPort - an int value

inAppId - an AppId value

inContextClassProvider - a ContextClassProvider value

Client

public Client(String host,
      int port,
      AppId appId)

Creates a new client node with the given server host name, port, and client application ID.

Parameters:

host - The host name.

port - The port.

appId - The application ID, which may be null.

Client

public Client(AppId appId)

Creates a new client node with the default server host name and port, and the given client application ID.

Parameters:

appId - The application ID, which may be null.

Client

public Client()

Creates a new client node with the default server host name and port, and no client application ID.

Method Detail

getUsername

public String getUsername()

Get the username value.

Returns:

a String value

getSessionId

public SessionId getSessionId()

Returns the receiver's session ID.

Returns:

The session ID, which may be null.

assertValidSession

public void assertValidSession()
                        throws I18NException

Asserts that an active session is in progress.

Throws:

I18NException - Thrown if an active session is not in progress.

login

public void login(String user,
         char[] password)
           throws I18NException,
                  RemoteException

Initiates a new session using the given credentials.

Parameters:

user - The user name.

password - The password.

Throws:

I18NException - Thrown if a session is already in progress.

RemoteException - Thrown if the server is unable to complete the login operation.

logout

public void logout()
            throws RemoteException

Ends an ongoing session.

Throws:

RemoteException - Thrown if the server is unable to complete the logout operation.

getContext

public ClientContext getContext()

Description copied from class: StatelessClient

Returns a client context which the client must supply as an argument to every remote call made via proxies obtained from the receiver.

Overrides:

getContext in class StatelessClient

Returns:

The context.