Package org.marketcetera.util.ws.stateless

Class StatelessClientContext

java.lang.Object

org.marketcetera.util.ws.stateless.StatelessClientContext

Direct Known Subclasses:

ClientContext

public class StatelessClientContext
extends Object

The client context which the client must supply as an argument to every stateless remote call. StatelessClient.getContext() is the preferred way for service clients to obtain a ready-to-use context. It conveys key (but optional) information about the client to the server.

Since:

1.0.0

Version:

$Id: StatelessClientContext.java 16154 2012-07-14 16:34:05Z colin $

Author:

tlerios@marketcetera.com

Field Summary

Fields

Modifier and Type	Field	Description
private AppId	mAppId
private NodeId	mClientId
private LocaleWrapper	mLocale
private VersionId	mVersionId

Constructor Summary

Constructors

Constructor	Description
StatelessClientContext()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
AppId	getAppId()	Returns the receiver's application ID.
NodeId	getClientId()	Returns the receiver's client ID.
LocaleWrapper	getLocale()	Returns the receiver's (wrapped) locale.
VersionId	getVersionId()	Returns the receiver's version ID.
int	hashCode()
void	setAppId(AppId appId)	Sets the receiver's application ID to the given one.
void	setClientId(NodeId clientId)	Sets the receiver's client ID to the given one.
void	setLocale(LocaleWrapper locale)	Sets the receiver's (wrapped) locale to the given one.
void	setVersionId(VersionId versionId)	Sets the receiver's version ID to the given one.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

mVersionId

private VersionId mVersionId

mAppId

private AppId mAppId

mClientId

private NodeId mClientId

mLocale

private LocaleWrapper mLocale

Constructor Detail

StatelessClientContext

public StatelessClientContext()

Method Detail

setVersionId

public void setVersionId(VersionId versionId)

Sets the receiver's version ID to the given one.

Parameters:

versionId - The version ID, which may be null.

getVersionId

public VersionId getVersionId()

Returns the receiver's version ID.

Returns:

The version ID, which may be null.

setAppId

public void setAppId(AppId appId)

Sets the receiver's application ID to the given one.

Parameters:

appId - The application ID, which may be null.

getAppId

public AppId getAppId()

Returns the receiver's application ID.

Returns:

The application ID, which may be null.

setClientId

public void setClientId(NodeId clientId)

Sets the receiver's client ID to the given one.

Parameters:

clientId - The client ID, which may be null.

getClientId

public NodeId getClientId()

Returns the receiver's client ID.

Returns:

The client ID, which may be null.

setLocale

public void setLocale(LocaleWrapper locale)

Sets the receiver's (wrapped) locale to the given one.

Parameters:

locale - The (wrapped) locale, which may be null.

getLocale

public LocaleWrapper getLocale()

Returns the receiver's (wrapped) locale.

Returns:

The (wrapped) locale, which may be null.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object