Package ch.tocco.nice2.netui.api.remote

Interface RemoteContext

All Known Implementing Classes:

NullRemoteContext, RemoteContextImpl

public interface RemoteContext

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	RemoteContext.Current

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.

Method Details

getHttpSessionId

@Nullable
@Nullable String getHttpSessionId()

getUserName

@Nullable
@Nullable String getUserName()

getScriptSessionId

@Nullable
@Nullable String getScriptSessionId()

currentThreadIsWebThread

boolean currentThreadIsWebThread()

withCurrentBrowser

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

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

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

Parameters:

actionName - The action in the client to call.

params - Params to pass to the action.

withCurrentUser

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

Call action in all sessions of the current user.

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

Parameters:

actionName - The action in the client to call.

params - Params to pass to the action.

withUser

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

Call action in all sessions of the given user.

Parameters:

userName - The user to call.

actionName - The action in the client to call.

params - Params to pass to the action.

withScriptSession

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

Call action in script session with the given id.

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

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

Call action in all sessions.

Parameters:

actionName - The action in the client to call.

params - Params to pass to the action.