com.kheops.jmap.net

Class JMapRequest

java.lang.Object

com.kheops.jmap.net.JMapRequest

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

JMapAdminRequest, JMapExtensionRequest, JMapServerRequest

public abstract class JMapRequest
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	pendingRequest
protected boolean	postProcessable
static byte	PROTOCOL_VERSION_4_0
static byte	PROTOCOL_VERSION_5_0
static byte	PROTOCOL_VERSION_7_0
protected int	type Deprecated.

Constructor Summary

Constructors

Constructor and Description
JMapRequest()

Method Summary

Modifier and Type	Method and Description
JMapRequestClient	getClient() Returns the optional client (or requester) associated with the request.
java.util.Locale	getClientLocale()
ConnectionProperties	getConnectionProperties()
byte	getProtocolVersion()
java.lang.Object	getRequestContextValue(java.lang.String key) Returns the value to which the specified key is mapped, or null if this request context contains no mapping for the key.
int	getSessionId() Gets the session Id
int	getType() Deprecated.
boolean	isCancelled() Returns whether or not this request has been canceled.
boolean	isPendingRequest() Returns the 'pending request' flag for this request.
boolean	isPostProcessable() Returns the post processable flag for this request.
void	putRequestContextValue(java.lang.String key, java.lang.Object value) Associates the specified value with the specified key in this request context.
void	setCancelled(boolean cancelled) Sets the canceled property of this request to the specified boolean value.
void	setClient(JMapRequestClient client) Sets the optional client (or requester) associated with the request that will have its callback method called when the request execution completes.
void	setClientLocale(java.util.Locale locale)
void	setPendingRequest(boolean pendingRequest) Sets the 'pending request' flag.
void	setPostProcessable(boolean postProcessable) Sets the post processable flag.
void	setSessionId(int id) Sets the session Id
void	setType(int type) Deprecated.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PROTOCOL_VERSION_4_0

public static final byte PROTOCOL_VERSION_4_0

See Also:

Constant Field Values

PROTOCOL_VERSION_5_0

public static final byte PROTOCOL_VERSION_5_0

See Also:

Constant Field Values

PROTOCOL_VERSION_7_0

public static final byte PROTOCOL_VERSION_7_0

See Also:

Constant Field Values

type

@Deprecated
protected int type

Deprecated.

postProcessable

protected transient boolean postProcessable

pendingRequest

protected transient boolean pendingRequest

Constructor Detail

JMapRequest

public JMapRequest()

Method Detail

getProtocolVersion

public byte getProtocolVersion()

setSessionId

public void setSessionId(int id)

Sets the session Id

Parameters:

id - the specified Id

getSessionId

public int getSessionId()

Gets the session Id

Returns:

sessionId

getType

@Deprecated
public int getType()

Deprecated.

Returns the type of this request.

setType

@Deprecated
public void setType(int type)

Deprecated.

setClient

public void setClient(JMapRequestClient client)

Sets the optional client (or requester) associated with the request that will have its callback method called when the request execution completes. The client must implement the interface JMapRequestClient.

Parameters:

client - the JMapRequestClient to locally keep with the request

getClient

public JMapRequestClient getClient()

Returns the optional client (or requester) associated with the request.

Returns:

the optional client associated with the request

setCancelled

public void setCancelled(boolean cancelled)

Sets the canceled property of this request to the specified boolean value. JMap requests that are canceled are ignored by the request servicing thread.

Parameters:

cancelled - the new state for the canceled property.

isCancelled

public boolean isCancelled()

Returns whether or not this request has been canceled.

Returns:

a boolean which specifies if this request was canceled or not.

isPostProcessable

public boolean isPostProcessable()

Returns the post processable flag for this request.

Returns:

true if post processable

See Also:

OfflineRequestHandler

setPostProcessable

public void setPostProcessable(boolean postProcessable)

Sets the post processable flag. If true and this request is sent while in offline mode, the request will be kept until a reconnection.

Parameters:

postProcessable - is the request post processable

See Also:

OfflineRequestHandler

isPendingRequest

public boolean isPendingRequest()

Returns the 'pending request' flag for this request.

Returns:

true if this request is a pending request

See Also:

OfflineRequestHandler

setPendingRequest

public void setPendingRequest(boolean pendingRequest)

Sets the 'pending request' flag. This flag can be set to true only if this request is a post processable request.

Parameters:

pendingRequest - is this request is a pending request

See Also:

OfflineRequestHandler

getConnectionProperties

public ConnectionProperties getConnectionProperties()

putRequestContextValue

public void putRequestContextValue(java.lang.String key,
                                   java.lang.Object value)

Associates the specified value with the specified key in this request context. If the map previously contained a mapping for the key, the old value is replaced. Those values WILL NOT be sent to the server.

Parameters:

key - key with which the specified value is to be associated

value - value to be associated with the specified key

getRequestContextValue

public java.lang.Object getRequestContextValue(java.lang.String key)

Returns the value to which the specified key is mapped, or null if this request context contains no mapping for the key.

Parameters:

key - the key

Returns:

value to be associated with the specified key

getClientLocale

public java.util.Locale getClientLocale()

setClientLocale

public void setClientLocale(java.util.Locale locale)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object