Package ch.tocco.nice2.netui.impl.remote

Class RemoteContextImpl

java.lang.Object

ch.tocco.nice2.netui.impl.remote.RemoteContextImpl

All Implemented Interfaces:

RemoteContext

public class RemoteContextImpl
extends Object
implements RemoteContext

Nested Class Summary

Nested classes/interfaces inherited from interface ch.tocco.nice2.netui.api.remote.RemoteContext

RemoteContext.Current

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTRIBUTE_USER_NAME

Constructor Summary

Constructors

Constructor	Description
RemoteContextImpl(@Nullable String httpSessionId, @Nullable String userName)

Method Summary

Modifier and Type	Method	Description
boolean	currentThreadIsWebThread()
@Nullable String	getHttpSessionId()
@Nullable String	getScriptSessionId()
@Nullable String	getUserName()
void	withAll(String actionName, @Nullable Object... params)	Call action in all sessions.
void	withCurrentBrowser(String actionName, @Nullable Object... params)	Call action only in current browser (not in all sessions of the current user).
void	withCurrentUser(String actionName, @Nullable Object... params)	Call action in all sessions of the current user.
void	withScriptSession(String scriptSessionId, String actionName, @Nullable Object... params)	Call action in script session with the given id.
void	withUser(String userName, String actionName, @Nullable Object... params)	Call action in all sessions of the given user.

Methods inherited from class java.lang.Object

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

Field Details

ATTRIBUTE_USER_NAME

public static final String ATTRIBUTE_USER_NAME

See Also:

• Constant Field Values

Constructor Details

RemoteContextImpl

public RemoteContextImpl(@Nullable
 @Nullable String httpSessionId,
 @Nullable
 @Nullable String userName)

Method Details

getHttpSessionId

@Nullable
public @Nullable String getHttpSessionId()

Specified by:

getHttpSessionId in interface RemoteContext

getUserName

@Nullable
public @Nullable String getUserName()

Specified by:

getUserName in interface RemoteContext

getScriptSessionId

@Nullable
public @Nullable String getScriptSessionId()

Specified by:

getScriptSessionId in interface RemoteContext

currentThreadIsWebThread

public boolean currentThreadIsWebThread()

Specified by:

currentThreadIsWebThread in interface RemoteContext

withCurrentBrowser

public void withCurrentBrowser(String actionName,
 @Nullable
 @Nullable Object... params)

Description copied from interface: RemoteContext

Call action only in current browser (not in all sessions of the current user).

Note: This method is not available in Non-Web threads.

Specified by:

withCurrentBrowser in interface RemoteContext

Parameters:

actionName - The action in the client to call.

params - Params to pass to the action.

withCurrentUser

public void withCurrentUser(String actionName,
 @Nullable
 @Nullable Object... params)

Description copied from interface: RemoteContext

Call action in all sessions of the current user.

Note: This method is not available if the user name is null.

Specified by:

withCurrentUser in interface RemoteContext

Parameters:

actionName - The action in the client to call.

params - Params to pass to the action.

withUser

public void withUser(String userName,
 String actionName,
 @Nullable
 @Nullable Object... params)

Description copied from interface: RemoteContext

Call action in all sessions of the given user.

Specified by:

withUser in interface RemoteContext

Parameters:

userName - The user to call.

actionName - The action in the client to call.

params - Params to pass to the action.

withScriptSession

public void withScriptSession(String scriptSessionId,
 String actionName,
 @Nullable
 @Nullable Object... params)

Description copied from interface: RemoteContext

Call action in script session with the given id.

Specified by:

withScriptSession in interface RemoteContext

Parameters:

scriptSessionId - The id of the script session to call.

actionName - The action in the client to call.

params - Params to pass to the action.

withAll

public void withAll(String actionName,
 @Nullable
 @Nullable Object... params)

Description copied from interface: RemoteContext

Call action in all sessions.

Specified by:

withAll in interface RemoteContext

Parameters:

actionName - The action in the client to call.

params - Params to pass to the action.