org.itsnat.core.event

Interface ItsNatAttachedClientEvent

All Superinterfaces:

ItsNatEvent, ItsNatUserData

All Known Subinterfaces:

ItsNatAttachedClientCometEvent, ItsNatAttachedClientTimerEvent

public interface ItsNatAttachedClientEvent
extends ItsNatEvent

This event object is sent to registered ItsNatAttachedClientEventListener objects to notify the several phases of a remote control process using a timer or comet to notify the client any document change.

Author:

Jose Maria Arranz Santamaria

Field Summary

Fields

Modifier and Type	Field and Description
static int	LOAD Constant used to inform that a remote control client document is being loaded.
static int	REFRESH Constant used to inform that an event has been received to refresh (update) the remote control client with any document change.
static int	REQUEST Constant used to inform that an event is a new request to remote control a document.
static int	UNLOAD Constant used to inform that a remote control client document is being unloaded.

Method Summary

Methods

Modifier and Type	Method and Description
long	getEventTimeout() Returns the timeout in client of asynchronous AJAX/SCRIPT events used for remote control.
int	getPhase() Returns the life cycle phase/notification type of this event.
long	getWaitDocTimeout() Returns the maximum time in milliseconds the remote control request will wait to the document to be bound if this document is not in server yet.
boolean	isAccepted() Returns true if this event request is accepted.
boolean	isReadOnly() Returns true if this attached client cannot send events to the server (read only).
void	setAccepted(boolean accepted) Used to accept or deny a remote control request.

Methods inherited from interface org.itsnat.core.event.ItsNatEvent

getClientDocument, getCommMode, getExtraParam, getExtraParamMultiple, getItsNatDocument, getItsNatEventListenerChain, getItsNatServletRequest, getItsNatServletResponse, setExtraParam

Methods inherited from interface org.itsnat.core.ItsNatUserData

containsUserValueName, getUserValue, getUserValueNames, removeUserValue, setUserValue

Field Detail

REQUEST

static final int REQUEST

Constant used to inform that an event is a new request to remote control a document.

See Also:

getPhase(), Constant Field Values

LOAD

static final int LOAD

Constant used to inform that a remote control client document is being loaded.

See Also:

getPhase(), Constant Field Values

REFRESH

static final int REFRESH

Constant used to inform that an event has been received to refresh (update) the remote control client with any document change.

See Also:

getPhase(), Constant Field Values

UNLOAD

static final int UNLOAD

Constant used to inform that a remote control client document is being unloaded.

See Also:

getPhase(), Constant Field Values

Method Detail

getPhase

int getPhase()

Returns the life cycle phase/notification type of this event.

Returns:

the phase or notification type.

See Also:

REQUEST, LOAD, REFRESH, UNLOAD

isAccepted

boolean isAccepted()

Returns true if this event request is accepted.

If this event is a new remote control request (REQUEST phase) by default returns false otherwise returns true.

Returns:

true if this request is accepted.

See Also:

setAccepted(boolean)

setAccepted

void setAccepted(boolean accepted)

Used to accept or deny a remote control request.

This method must be called with a true value to accept a new remote control request (REQUEST phase), because by default ItsNat does not accept new remote control requests.

If called with false informs ItsNat to deny a new remote control request or to end an already running remote control process.

Parameters:

accepted - if set to false rejects or ends a new or existing remote control process.

getEventTimeout

long getEventTimeout()

Returns the timeout in client of asynchronous AJAX/SCRIPT events used for remote control. If this event is a REQUEST the returned value may be used to validate the remote control request.

Returned value is proposed initially by the client but can not change during the remote control life cycle.

Returns:

the timeout of asynchronous events. If negative no timeout is defined.

See Also:

setAccepted(boolean)

getWaitDocTimeout

long getWaitDocTimeout()

Returns the maximum time in milliseconds the remote control request will wait to the document to be bound if this document is not in server yet.

This timeout only applies to <iframe>, <object> and <embed> elements with associated documents automatically bound to the parent.

Returns:

the timeout waiting for the document to remote control. If 0 there is no wait.

isReadOnly

boolean isReadOnly()

Returns true if this attached client cannot send events to the server (read only).

Returns:

true if this client is read only.