Package com.inductiveautomation.ignition.gateway.clientcomm

Interface GatewaySessionManager

public interface GatewaySessionManager

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MDC_PROJECT_NAME	MDC key for request's associated project
static final String	MDC_REMOTE_ADDR	MDC key for request ip
static final String	MDC_SESSION_ID	MDC key for request's associated session id
static final String	MDC_USERNAME	MDC key for request user

Method Summary

Modifier and Type	Method	Description
ClientReqSession	findSession(String id)
List<ClientReqSession>	findSessions()
List<ClientReqSession>	findSessions(int scope)
int	getSessionCount()
void	sendNotification(int scope, String moduleId, String messageType)	Sends an empty push notification to all sessions that match the scope.
<T> void	sendNotification(int scope, String moduleId, String messageType, T message, PushNotificationSerializer<T> serializer)	Sends the given push notification message to all sessions that match the scope.

Field Details

MDC_REMOTE_ADDR

static final String MDC_REMOTE_ADDR

MDC key for request ip

See Also:

• Constant Field Values

MDC_USERNAME

static final String MDC_USERNAME

MDC key for request user

See Also:

• Constant Field Values

MDC_SESSION_ID

static final String MDC_SESSION_ID

MDC key for request's associated session id

See Also:

• Constant Field Values

MDC_PROJECT_NAME

static final String MDC_PROJECT_NAME

MDC key for request's associated project

See Also:

• Constant Field Values

Method Details

findSession

@Nullable
ClientReqSession findSession(String id)

findSessions

@Nonnull
List<ClientReqSession> findSessions()

findSessions

@Nonnull
List<ClientReqSession> findSessions(int scope)

getSessionCount

int getSessionCount()

sendNotification

<T> void sendNotification(int scope,
 String moduleId,
 String messageType,
 T message,
 PushNotificationSerializer<T> serializer)
                   throws Exception

Sends the given push notification message to all sessions that match the scope.

Throws:

Exception

See Also:

• ApplicationScope

sendNotification

void sendNotification(int scope,
 String moduleId,
 String messageType)
               throws Exception

Sends an empty push notification to all sessions that match the scope.

Throws:

Exception