com.inductiveautomation.ignition.gateway.web

Class IgnitionSession

java.lang.Object

org.apache.wicket.Session

org.apache.wicket.protocol.http.WebSession

com.inductiveautomation.ignition.gateway.web.IgnitionSession

All Implemented Interfaces:

java.io.Serializable, org.apache.wicket.event.IEventSink, org.apache.wicket.util.io.IClusterable

public class IgnitionSession
extends org.apache.wicket.protocol.http.WebSession

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.wicket.Session

clientInfo, SESSION_ATTRIBUTE_NAME

Constructor Summary

Constructors

Constructor and Description
IgnitionSession(org.apache.wicket.request.Request request)

Method Summary

Modifier and Type	Method and Description
void	clearConsoleWriter()
void	debug(java.lang.String message)
void	error(java.lang.String message, java.lang.Throwable ex)
void	error(java.lang.Throwable ex)
void	fatal(java.lang.String message)
java.lang.String	formatThrowable(java.lang.Throwable ex)
static IgnitionSession	get()
java.io.StringWriter	getConsoleWriter()
NavLocation	getCurrentLocation()
ProgressListener	getProgressListener()
java.util.Collection<java.lang.String>	getRoles() Returns the roles of the logged in user, or an empty list if the user isn't logged in.
AuthenticatedUser	getUser()
void	info(java.lang.String message)
boolean	isAdmin() Returns true if this web session is logged in and should have access to the administrative portions of the gateway.
boolean	isLockedOut() Returns true if this session is currently locked out from attempting to log in.
boolean	isLoggedIn() Returns true if this web session has logged in.
void	notifyFailedLogin()
void	setCurrentLocation(NavLocation currentLocation)
void	setProgressListener(ProgressListener progressListener)
void	setUser(AuthenticatedUser user)
void	success(java.lang.String message)
void	warn(java.lang.String message)

Methods inherited from class org.apache.wicket.protocol.http.WebSession

getClientInfo, invalidate, newBrowserInfoPage

Methods inherited from class org.apache.wicket.Session

bind, cleanupFeedbackMessages, clear, debug, detach, dirty, error, exists, fatal, getApplication, getAttribute, getAttributeNames, getAuthorizationStrategy, getClassResolver, getFeedbackMessages, getId, getLocale, getMetaData, getPageFactory, getPageManager, getSessionStore, getSizeInBytes, getStyle, info, internalDetach, invalidateNow, isCurrentRequestValid, isSessionInvalidated, isTemporary, nextPageId, nextSequenceValue, onEvent, removeAttribute, replaceSession, setAttribute, setClientInfo, setLocale, setMetaData, setStyle, success, warn

Methods inherited from class java.lang.Object

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

Constructor Detail

IgnitionSession

public IgnitionSession(org.apache.wicket.request.Request request)

Method Detail

get

public static IgnitionSession get()

clearConsoleWriter

public void clearConsoleWriter()

getConsoleWriter

public java.io.StringWriter getConsoleWriter()

getUser

public AuthenticatedUser getUser()

setUser

public void setUser(AuthenticatedUser user)

isLoggedIn

public boolean isLoggedIn()

Returns true if this web session has logged in. Doesn't say anything about what roles or access the logged in user should have

isAdmin

public boolean isAdmin()

Returns true if this web session is logged in and should have access to the administrative portions of the gateway.

debug

public void debug(java.lang.String message)

info

public void info(java.lang.String message)

success

public void success(java.lang.String message)

warn

public void warn(java.lang.String message)

fatal

public void fatal(java.lang.String message)

error

public void error(java.lang.String message,
                  java.lang.Throwable ex)

error

public void error(java.lang.Throwable ex)

formatThrowable

public java.lang.String formatThrowable(java.lang.Throwable ex)

getRoles

public java.util.Collection<java.lang.String> getRoles()

Returns the roles of the logged in user, or an empty list if the user isn't logged in. Guaranteed to return non-null.

getCurrentLocation

public NavLocation getCurrentLocation()

setCurrentLocation

public void setCurrentLocation(NavLocation currentLocation)

getProgressListener

public ProgressListener getProgressListener()

setProgressListener

public void setProgressListener(ProgressListener progressListener)

isLockedOut

public boolean isLockedOut()

Returns true if this session is currently locked out from attempting to log in.

notifyFailedLogin

public void notifyFailedLogin()