Uses of Class
org.jgrapes.webconsole.base.ConsoleSession
Package
Description
A web console component for displaying markdown text in a web console.
A web console component for displaying system information in
a web console.
Provides the components for building web consoles based on the
core, io and http packages.
Classes for implementing a freemarker based web console component.
Provides a web console weblet that implements the web console page using the
JQuery UI framework.
Provides a component for adding the
Browser Require
library to a web console.
Provides a component for adding the Chart.js
library to a web console.
Provides a component for adding the datatables
library to a web console.
Provides a component for adding the Fontawesome
free web font to a web console.
Provides a component for adding the Fork-Awesome
free web font to a web console.
Provides a component for adding the Gridstack.js
library to a web console.
Provides some vue components used in but independent of the Vue.js
web console which may also be of interest when implementing
web console components.
Provides a component for adding the jquery
library to a web console.
Provides a component for adding the jQueryUI
library to a web console.
Provides a component for adding the
jQuery UI Touch Punch
library to a web console.
Provides a component for adding the Lodash
library to a web console.
Provides a component for adding the moment
library to a web console.
Provides a component for adding the
markdownit library
to a web console.
Provides a component for adding the moment
library to a web console.
Provides a component for adding the Vue.js
library to a web console.
Provides a component for adding the old vue.js 2
library to a web console.
Provides a component for adding the Vuex
library to a web console.
-
Uses of ConsoleSession in org.jgrapes.webconlet.examples.formtest
Modifier and TypeMethodDescriptionprotected Set<Conlet.RenderMode>
FormTestConlet.doRenderConlet
(RenderConletRequestBase<?> event, ConsoleSession channel, String conletId, Serializable conletState) void
FormTestConlet.onConsoleReady
(ConsoleReady event, ConsoleSession consoleSession) Trigger loading of resources when the console is ready. -
Uses of ConsoleSession in org.jgrapes.webconlet.examples.helloworld
Modifier and TypeMethodDescriptionprotected Optional<HelloWorldConlet.HelloWorldModel>
HelloWorldConlet.createStateRepresentation
(RenderConletRequestBase<?> event, ConsoleSession channel, String conletId) protected void
HelloWorldConlet.doConletDeleted
(ConletDeleted event, ConsoleSession channel, String conletId, HelloWorldConlet.HelloWorldModel conletState) protected Set<Conlet.RenderMode>
HelloWorldConlet.doRenderConlet
(RenderConletRequestBase<?> event, ConsoleSession channel, String conletId, HelloWorldConlet.HelloWorldModel conletState) protected void
HelloWorldConlet.doUpdateConletState
(NotifyConletModel event, ConsoleSession channel, HelloWorldConlet.HelloWorldModel conletModel) void
HelloWorldConlet.onConsoleReady
(ConsoleReady event, ConsoleSession consoleSession) Trigger loading of resources when the console is ready.void
HelloWorldConlet.onKeyValueStoreData
(KeyValueStoreData event, ConsoleSession channel) Invoked when the key/value store provides data. -
Uses of ConsoleSession in org.jgrapes.webconlet.examples.login
Modifier and TypeMethodDescriptionprotected Optional<LoginConlet.AccountModel>
LoginConlet.createNewState
(AddConletRequest event, ConsoleSession session, String conletId) As a model has already been created inLoginConlet.doUpdateConletState(org.jgrapes.webconsole.base.events.NotifyConletModel, org.jgrapes.webconsole.base.ConsoleSession, org.jgrapes.webconlet.examples.login.LoginConlet.AccountModel)
, the “new” model may already exist in the session.protected Optional<LoginConlet.AccountModel>
LoginConlet.createStateRepresentation
(RenderConletRequestBase<?> event, ConsoleSession channel, String conletId) protected Set<Conlet.RenderMode>
LoginConlet.doRenderConlet
(RenderConletRequestBase<?> event, ConsoleSession channel, String conletId, LoginConlet.AccountModel model) protected boolean
LoginConlet.doSetLocale
(SetLocale event, ConsoleSession channel, String conletId) protected void
LoginConlet.doUpdateConletState
(NotifyConletModel event, ConsoleSession channel, LoginConlet.AccountModel model) protected String
LoginConlet.generateInstanceId
(AddConletRequest event, ConsoleSession session) void
LoginConlet.onConsolePrepared
(ConsolePrepared event, ConsoleSession channel) Handle web console page loaded.void
LoginConlet.onConsoleReady
(ConsoleReady event, ConsoleSession channel) Register conlet. -
Uses of ConsoleSession in org.jgrapes.webconlet.examples.styletest
Modifier and TypeMethodDescriptionprotected Set<Conlet.RenderMode>
StyleTestConlet.doRenderConlet
(RenderConletRequestBase<?> event, ConsoleSession channel, String conletId, Serializable conletState) protected boolean
StyleTestConlet.doSetLocale
(SetLocale event, ConsoleSession channel, String conletId) void
StyleTestConlet.onConsoleReady
(ConsoleReady event, ConsoleSession consoleSession) Trigger loading of resources when the console is ready. -
Uses of ConsoleSession in org.jgrapes.webconlet.jmxbrowser
Modifier and TypeMethodDescriptionprotected Set<Conlet.RenderMode>
JmxBrowserConlet.doRenderConlet
(RenderConletRequestBase<?> event, ConsoleSession channel, String conletId, Serializable conletState) protected void
JmxBrowserConlet.doUpdateConletState
(NotifyConletModel event, ConsoleSession channel, Serializable conletModel) void
JmxBrowserConlet.onConsoleReady
(ConsoleReady event, ConsoleSession channel) OnConsoleReady
, fire theAddConletType
. -
Uses of ConsoleSession in org.jgrapes.webconlet.markdowndisplay
Modifier and TypeMethodDescriptionMarkdownDisplayConlet.createNewState
(AddConletRequest event, ConsoleSession session, String conletId) Creates a new model for the conlet.protected void
MarkdownDisplayConlet.doConletDeleted
(ConletDeleted event, ConsoleSession channel, String conletId, MarkdownDisplayConlet.MarkdownDisplayModel retrievedState) protected Set<Conlet.RenderMode>
MarkdownDisplayConlet.doRenderConlet
(RenderConletRequestBase<?> event, ConsoleSession consoleSession, String conletId, MarkdownDisplayConlet.MarkdownDisplayModel model) protected void
MarkdownDisplayConlet.doUpdateConletState
(NotifyConletModel event, ConsoleSession consoleSession, MarkdownDisplayConlet.MarkdownDisplayModel conletState) protected String
MarkdownDisplayConlet.generateInstanceId
(AddConletRequest event, ConsoleSession session) Generates a new component instance id or uses the one stored in the event’s properties asCONLET_ID
(seeAddConletRequest.properties()
)void
MarkdownDisplayConlet.onConsoleReady
(ConsoleReady event, ConsoleSession consoleSession) OnConsoleReady
, fire theAddConletType
.void
MarkdownDisplayConlet.onUpdateConletModel
(UpdateConletModel event, ConsoleSession consoleSession) Stores the modified properties using aKeyValueStoreUpdate
event and updates the view with aNotifyConletView
.MarkdownDisplayConlet.recreateState
(RenderConletRequest event, ConsoleSession channel, String conletId) -
Uses of ConsoleSession in org.jgrapes.webconlet.messagebox
Modifier and TypeMethodDescriptionprotected Set<Conlet.RenderMode>
MessageBoxConlet.doRenderConlet
(RenderConletRequestBase<?> event, ConsoleSession channel, String conletId, Serializable conletState) void
MessageBoxConlet.onConsoleReady
(ConsoleReady event, ConsoleSession consoleSession) Trigger loading of resources when the console is ready. -
Uses of ConsoleSession in org.jgrapes.webconlet.sysinfo
Modifier and TypeMethodDescriptionprotected Optional<SysInfoConlet.SysInfoModel>
SysInfoConlet.createStateRepresentation
(RenderConletRequestBase<?> event, ConsoleSession session, String conletId) protected Set<Conlet.RenderMode>
SysInfoConlet.doRenderConlet
(RenderConletRequestBase<?> event, ConsoleSession consoleSession, String conletId, SysInfoConlet.SysInfoModel conletState) protected void
SysInfoConlet.doUpdateConletState
(NotifyConletModel event, ConsoleSession consoleSession, SysInfoConlet.SysInfoModel conletState) void
SysInfoConlet.onConsoleReady
(ConsoleReady event, ConsoleSession consoleSession) OnConsoleReady
, fire theAddConletType
.void
SysInfoConlet.onUpdate
(SysInfoConlet.Update event, ConsoleSession consoleSession) Handle the periodic update event by sendingNotifyConletView
events. -
Uses of ConsoleSession in org.jgrapes.webconsole.base
Modifier and TypeMethodDescriptionSets the locale for this console session.ConsoleSession.setSessionSupplier
(Supplier<Optional<Session>> sessionSupplier) Sets or updates associated browser session.ConsoleSession.setTimeout
(long timeout) Changes the timeout for thisConsoleSession
to the given value.ConsoleSession.setUpstreamChannel
(IOSubchannel upstreamChannel) Sets or updates the upstream channel.protected ConsoleSession[]
AbstractConlet.trackedSessions()
Returns the tracked sessions.Modifier and TypeMethodDescriptionstatic Set<ConsoleSession>
ConsoleSession.byConsole
(WebConsole console) Return all sessions that belong to the given console as a new unmodifiable set.protected Map<ConsoleSession,
Set<String>> AbstractConlet.conletIdsByConsoleSession()
Returns the tracked sessions and conlet ids as map.Modifier and TypeMethodDescriptionprotected void
AbstractConlet.afterOnClosed
(Closed event, ConsoleSession consoleSession) Invoked byAbstractConlet.onClosed(Closed, ConsoleSession)
after the web console session has been removed from the set of tracked sessions.AbstractConlet.conletIds
(ConsoleSession consoleSession) Returns the set of web console component ids associated with the console session as aSet
.protected Map<String,
Set<Conlet.RenderMode>> AbstractConlet.conletViews
(ConsoleSession consoleSession) Returns a map of all conlet ids and the modes in which views are currently rendered.AbstractConlet.createNewState
(AddConletRequest event, ConsoleSession session, String conletId) Called byAbstractConlet.onAddConletRequest(org.jgrapes.webconsole.base.events.AddConletRequest, org.jgrapes.webconsole.base.ConsoleSession)
when a new conlet instance is created in the browser.AbstractConlet.createStateRepresentation
(RenderConletRequestBase<?> event, ConsoleSession session, String conletId) Creates an instance of the type that represents the conlet’s state.protected void
AbstractConlet.doConletDeleted
(ConletDeleted event, ConsoleSession channel, String conletId, S conletState) Called byAbstractConlet.onConletDeleted(org.jgrapes.webconsole.base.events.ConletDeleted, org.jgrapes.webconsole.base.ConsoleSession)
to propagate the event to derived classes.protected abstract Set<Conlet.RenderMode>
AbstractConlet.doRenderConlet
(RenderConletRequestBase<?> event, ConsoleSession channel, String conletId, S conletState) Called byAbstractConlet.onAddConletRequest(AddConletRequest, ConsoleSession)
andAbstractConlet.onRenderConletRequest(RenderConletRequest, ConsoleSession)
to complete rendering the web console component.protected boolean
AbstractConlet.doSetLocale
(SetLocale event, ConsoleSession channel, String conletId) Called byAbstractConlet.onSetLocale(SetLocale, ConsoleSession)
for each web console component in the console session.protected void
AbstractConlet.doUpdateConletState
(NotifyConletModel event, ConsoleSession channel, S conletState) Called byAbstractConlet.onNotifyConletModel(org.jgrapes.webconsole.base.events.NotifyConletModel, org.jgrapes.webconsole.base.ConsoleSession)
to complete handling the notification.protected String
AbstractConlet.generateInstanceId
(AddConletRequest event, ConsoleSession session) Create the instance specific part of a conlet id.final void
AbstractConlet.onAddConletRequest
(AddConletRequest event, ConsoleSession consoleSession) Checks if the request applies to this component.final void
AbstractConlet.onClosed
(Closed event, ConsoleSession consoleSession) Removes theConsoleSession
from the set of tracked sessions.final void
AbstractConlet.onConletDeleted
(ConletDeleted event, ConsoleSession consoleSession) Checks if the request applies to this component.void
ConsoleWeblet.onConsoleCommand
(ConsoleCommand event, ConsoleSession channel) Sends a command to the console.void
WebConsole.onConsoleConfigured
(ConsoleConfigured event, ConsoleSession channel) Handle network configured condition.void
KVStoreBasedConsolePolicy.onConsoleLayoutChanged
(ConsoleLayoutChanged event, ConsoleSession channel) Forward layout changed event to browser session scoped storage.void
KVStoreBasedConsolePolicy.onConsolePrepared
(ConsolePrepared event, ConsoleSession channel) Create browser session scoped storage and forward event to it.void
UserBasedConletFilter.onConsolePrepared
(ConsolePrepared event, ConsoleSession channel) Filter the events.void
BrowserLocalBackedKVStore.onConsoleReady
(ConsoleReady event, ConsoleSession channel) InterceptConsoleReady
event to first get data.void
BrowserLocalBackedKVStore.onJsonInput
(JsonInput event, ConsoleSession channel) Evaluate “retrievedLocalData” response.void
WebConsole.onJsonInput
(JsonInput event, ConsoleSession channel) Handle JSON input.void
BrowserLocalBackedKVStore.onKeyValueStoreQuery
(KeyValueStoreQuery event, ConsoleSession channel) Handle data query..void
BrowserLocalBackedKVStore.onKeyValueStoreUpdate
(KeyValueStoreUpdate event, ConsoleSession channel) Handle data update events.final void
AbstractConlet.onNotifyConletModel
(NotifyConletModel event, ConsoleSession channel) void
WebConsole.onRenderConlet
(RenderConletRequest event, ConsoleSession channel) Fallback handler that sends aDeleteConlet
event if theRenderConletRequest
event has not been handled successfully.final void
AbstractConlet.onRenderConletRequest
(RenderConletRequest event, ConsoleSession consoleSession) Checks if the request applies to this component by verifying if the component id starts withAbstractConlet.type()
plusAbstractConlet.TYPE_INSTANCE_SEPARATOR
.void
AbstractConlet.onSetLocale
(SetLocale event, ConsoleSession consoleSession) InvokesAbstractConlet.doSetLocale(SetLocale, ConsoleSession, String)
for each web console component in the console session.void
ConsoleWeblet.onSetLocale
(SetLocale event, ConsoleSession channel) Handles a change of Locale for the console.void
ConsoleWeblet.onSetLocaleCompleted
(SetLocaleCompleted event, ConsoleSession channel) Sends a reload if the change of locale could not be handled by all conlets.AbstractConlet.recreateState
(RenderConletRequest event, ConsoleSession session, String conletId) Called byAbstractConlet.onRenderConletRequest(org.jgrapes.webconsole.base.events.RenderConletRequest, org.jgrapes.webconsole.base.ConsoleSession)
when a previously created conlet (with associated state) is rendered in a new browser session for the first time.protected Collection<Map.Entry<String,
S>> AbstractConlet.statesFromSession
(ConsoleSession session) Returns all conlet ids and conlet states of this web console component’s type from the session.protected AbstractConlet.ConletTrackingInfo
AbstractConlet.trackConlet
(ConsoleSession consoleSession, String conletId, AbstractConlet.ConletTrackingInfo info) Track the given web console component from the given session.ModifierConstructorDescriptionConsoleSessionInfo
(ConsoleSession session) WebSocketInputReader
(EventPipeline wsInPipeline, ConsoleSession consoleChannel) Instantiates a new web socket input reader. -
Uses of ConsoleSession in org.jgrapes.webconsole.base.freemarker
Modifier and TypeMethodDescriptionFreeMarkerConlet.fmModel
(RenderConletRequestBase<?> event, ConsoleSession channel, String conletId, Serializable conletState) Build a freemarker model that combinesFreeMarkerConlet.fmTypeModel(org.jgrapes.webconsole.base.RenderSupport)
,FreeMarkerConlet.fmSessionModel(org.jgrapes.http.Session)
andFreeMarkerConlet.fmConletModel(org.jgrapes.webconsole.base.events.RenderConletRequestBase<?>, org.jgrapes.io.IOSubchannel, java.lang.String, java.io.Serializable)
. -
Uses of ConsoleSession in org.jgrapes.webconsole.jqueryui
Modifier and TypeMethodDescriptionvoid
JQueryUiWeblet.onJsonInput
(JsonInput event, ConsoleSession channel) Handle JSON input.void
JQueryUiWeblet.onSetTheme
(SetTheme event, ConsoleSession channel) Handles a change of theme. -
Uses of ConsoleSession in org.jgrapes.webconsole.provider.browserrequire
Modifier and TypeMethodDescriptionvoid
BrowserRequireProvider.onConsoleReady
(ConsoleReady event, ConsoleSession consoleSession) OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleSession in org.jgrapes.webconsole.provider.chartjs
Modifier and TypeMethodDescriptionvoid
ChartJsProvider.onConsoleReady
(ConsoleReady event, ConsoleSession consoleSession) OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleSession in org.jgrapes.webconsole.provider.datatables
Modifier and TypeMethodDescriptionvoid
DatatablesProvider.onConsoleReady
(ConsoleReady event, ConsoleSession consoleSession) OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleSession in org.jgrapes.webconsole.provider.fontawesome
Modifier and TypeMethodDescriptionvoid
FontAwesomeProvider.onConsoleReady
(ConsoleReady event, ConsoleSession consoleSession) OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleSession in org.jgrapes.webconsole.provider.forkawesome
Modifier and TypeMethodDescriptionvoid
ForkAwesomeProvider.onConsoleReady
(ConsoleReady event, ConsoleSession consoleSession) OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleSession in org.jgrapes.webconsole.provider.gridstack
Modifier and TypeMethodDescriptionvoid
GridstackProvider.onConsoleReady
(ConsoleReady event, ConsoleSession consoleSession) OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleSession in org.jgrapes.webconsole.provider.jgwcvuecomponents
Modifier and TypeMethodDescriptionvoid
JgWcComponentsProvider.onConsoleReady
(ConsoleReady event, ConsoleSession consoleSession) OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleSession in org.jgrapes.webconsole.provider.jquery
Modifier and TypeMethodDescriptionvoid
JQueryProvider.onConsoleReady
(ConsoleReady event, ConsoleSession consoleSession) OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleSession in org.jgrapes.webconsole.provider.jqueryui
Modifier and TypeMethodDescriptionvoid
JQueryUi.onConsoleReady
(ConsoleReady event, ConsoleSession consoleSession) OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleSession in org.jgrapes.webconsole.provider.jquitouchpunch
Modifier and TypeMethodDescriptionvoid
JQueryUiTouchPunchProvider.onConsoleReady
(ConsoleReady event, ConsoleSession consoleSession) OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleSession in org.jgrapes.webconsole.provider.lodash
Modifier and TypeMethodDescriptionvoid
LodashProvider.onConsoleReady
(ConsoleReady event, ConsoleSession consoleSession) OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleSession in org.jgrapes.webconsole.provider.luxon
Modifier and TypeMethodDescriptionvoid
LuxonProvider.onConsoleReady
(ConsoleReady event, ConsoleSession consoleSession) OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleSession in org.jgrapes.webconsole.provider.markdownit
Modifier and TypeMethodDescriptionvoid
MarkdownItProvider.onConsoleReady
(ConsoleReady event, ConsoleSession consoleSession) OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleSession in org.jgrapes.webconsole.provider.moment
Modifier and TypeMethodDescriptionvoid
MomentProvider.onConsoleReady
(ConsoleReady event, ConsoleSession consoleSession) OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleSession in org.jgrapes.webconsole.provider.vue
Modifier and TypeMethodDescriptionvoid
VueProvider.onConsoleReady
(ConsoleReady event, ConsoleSession consoleSession) OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleSession in org.jgrapes.webconsole.provider.vuejs
Modifier and TypeMethodDescriptionvoid
VueJsProvider.onConsoleReady
(ConsoleReady event, ConsoleSession consoleSession) Deprecated.OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleSession in org.jgrapes.webconsole.provider.vuex
Modifier and TypeMethodDescriptionvoid
VuexProvider.onConsoleReady
(ConsoleReady event, ConsoleSession consoleSession) OnConsoleReady
, fire the appropriateAddPageResources
.