Uses of Class
org.jgrapes.webconsole.base.ConsoleConnection
Package
Description
A web console component for displaying markdown text in a web console.
This package provides an OIDC login conlet (with fallback to password
login).
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.
Provides a simple role based access control using
information from the configuration support provided by JGrapes.
-
Uses of ConsoleConnection in org.jgrapes.webconlet.examples.formtest
Modifier and TypeMethodDescriptionprotected Set
<Conlet.RenderMode> FormTestConlet.doRenderConlet
(RenderConletRequestBase<?> event, ConsoleConnection channel, String conletId, Serializable conletState) void
FormTestConlet.onConsoleReady
(ConsoleReady event, ConsoleConnection connection) Trigger loading of resources when the console is ready. -
Uses of ConsoleConnection in org.jgrapes.webconlet.examples.helloworld
Modifier and TypeMethodDescriptionprotected Optional
<HelloWorldConlet.HelloWorldModel> HelloWorldConlet.createStateRepresentation
(Event<?> event, ConsoleConnection channel, String conletId) protected void
HelloWorldConlet.doConletDeleted
(ConletDeleted event, ConsoleConnection channel, String conletId, HelloWorldConlet.HelloWorldModel conletState) protected Set
<Conlet.RenderMode> HelloWorldConlet.doRenderConlet
(RenderConletRequestBase<?> event, ConsoleConnection channel, String conletId, HelloWorldConlet.HelloWorldModel conletState) protected void
HelloWorldConlet.doUpdateConletState
(NotifyConletModel event, ConsoleConnection channel, HelloWorldConlet.HelloWorldModel conletModel) void
HelloWorldConlet.onConsoleReady
(ConsoleReady event, ConsoleConnection connection) Trigger loading of resources when the console is ready.protected Optional
<HelloWorldConlet.HelloWorldModel> HelloWorldConlet.recreateState
(Event<?> event, ConsoleConnection channel, String conletId) -
Uses of ConsoleConnection in org.jgrapes.webconlet.examples.styletest
Modifier and TypeMethodDescriptionprotected Set
<Conlet.RenderMode> StyleTestConlet.doRenderConlet
(RenderConletRequestBase<?> event, ConsoleConnection channel, String conletId, Serializable conletState) protected boolean
StyleTestConlet.doSetLocale
(SetLocale event, ConsoleConnection channel, String conletId) void
StyleTestConlet.onConsoleReady
(ConsoleReady event, ConsoleConnection consoleConnection) Trigger loading of resources when the console is ready. -
Uses of ConsoleConnection in org.jgrapes.webconlet.jmxbrowser
Modifier and TypeMethodDescriptionprotected Set
<Conlet.RenderMode> JmxBrowserConlet.doRenderConlet
(RenderConletRequestBase<?> event, ConsoleConnection channel, String conletId, Serializable conletState) protected void
JmxBrowserConlet.doUpdateConletState
(NotifyConletModel event, ConsoleConnection channel, Serializable conletModel) void
JmxBrowserConlet.onConsoleReady
(ConsoleReady event, ConsoleConnection channel) OnConsoleReady
, fire theAddConletType
. -
Uses of ConsoleConnection in org.jgrapes.webconlet.locallogin
Modifier and TypeMethodDescriptionprotected Optional
<LoginConlet.AccountModel> LoginConlet.createNewState
(AddConletRequest event, ConsoleConnection session, String conletId) As a model has already been created inLoginConlet.doUpdateConletState(org.jgrapes.webconsole.base.events.NotifyConletModel, org.jgrapes.webconsole.base.ConsoleConnection, org.jgrapes.webconlet.locallogin.LoginConlet.AccountModel)
, the “new” model may already exist in the session.protected Optional
<LoginConlet.AccountModel> LoginConlet.createStateRepresentation
(Event<?> event, ConsoleConnection channel, String conletId) protected Set
<Conlet.RenderMode> LoginConlet.doRenderConlet
(RenderConletRequestBase<?> event, ConsoleConnection channel, String conletId, LoginConlet.AccountModel model) protected boolean
LoginConlet.doSetLocale
(SetLocale event, ConsoleConnection channel, String conletId) protected void
LoginConlet.doUpdateConletState
(NotifyConletModel event, ConsoleConnection connection, LoginConlet.AccountModel model) protected String
LoginConlet.generateInstanceId
(AddConletRequest event, ConsoleConnection session) void
LoginConlet.onConsolePrepared
(ConsolePrepared event, ConsoleConnection channel) Handle web console page loaded.void
LoginConlet.onConsoleReady
(ConsoleReady event, ConsoleConnection channel) Register conlet. -
Uses of ConsoleConnection in org.jgrapes.webconlet.logviewer
Modifier and TypeMethodDescriptionprotected Set
<Conlet.RenderMode> LogViewerConlet.doRenderConlet
(RenderConletRequestBase<?> event, ConsoleConnection channel, String conletId, Serializable conletState) protected boolean
LogViewerConlet.doSetLocale
(SetLocale event, ConsoleConnection channel, String conletId) protected void
LogViewerConlet.doUpdateConletState
(NotifyConletModel event, ConsoleConnection channel, Serializable conletState) void
LogViewerConlet.onConsoleReady
(ConsoleReady event, ConsoleConnection channel) OnConsoleReady
, fire theAddConletType
. -
Uses of ConsoleConnection in org.jgrapes.webconlet.markdowndisplay
Modifier and TypeMethodDescriptionMarkdownDisplayConlet.createNewState
(AddConletRequest event, ConsoleConnection session, String conletId) Creates a new model for the conlet.MarkdownDisplayConlet.createStateRepresentation
(Event<?> event, ConsoleConnection channel, String conletId) protected void
MarkdownDisplayConlet.doConletDeleted
(ConletDeleted event, ConsoleConnection channel, String conletId, MarkdownDisplayConlet.MarkdownDisplayModel retrievedState) protected Set
<Conlet.RenderMode> MarkdownDisplayConlet.doRenderConlet
(RenderConletRequestBase<?> event, ConsoleConnection consoleConnection, String conletId, MarkdownDisplayConlet.MarkdownDisplayModel model) protected void
MarkdownDisplayConlet.doUpdateConletState
(NotifyConletModel event, ConsoleConnection connection, MarkdownDisplayConlet.MarkdownDisplayModel conletState) protected String
MarkdownDisplayConlet.generateInstanceId
(AddConletRequest event, ConsoleConnection 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, ConsoleConnection connection) OnConsoleReady
, fire theAddConletType
.void
MarkdownDisplayConlet.onUpdateConletModel
(UpdateConletModel event, ConsoleConnection connection) Stores the modified properties using aKeyValueStoreUpdate
event and updates the view with aNotifyConletView
.MarkdownDisplayConlet.recreateState
(Event<?> event, ConsoleConnection channel, String conletId) -
Uses of ConsoleConnection in org.jgrapes.webconlet.messagebox
Modifier and TypeMethodDescriptionprotected Set
<Conlet.RenderMode> MessageBoxConlet.doRenderConlet
(RenderConletRequestBase<?> event, ConsoleConnection channel, String conletId, Serializable conletState) void
MessageBoxConlet.onConsoleReady
(ConsoleReady event, ConsoleConnection connection) Trigger loading of resources when the console is ready. -
Uses of ConsoleConnection in org.jgrapes.webconlet.oidclogin
Modifier and TypeMethodDescriptionprotected Optional
<LoginConlet.AccountModel> LoginConlet.createNewState
(AddConletRequest event, ConsoleConnection session, String conletId) As a model has already been created inLoginConlet.doUpdateConletState(org.jgrapes.webconsole.base.events.NotifyConletModel, org.jgrapes.webconsole.base.ConsoleConnection, org.jgrapes.webconlet.oidclogin.LoginConlet.AccountModel)
, the “new” model may already exist in the session.protected Optional
<LoginConlet.AccountModel> LoginConlet.createStateRepresentation
(Event<?> event, ConsoleConnection channel, String conletId) protected Set
<Conlet.RenderMode> LoginConlet.doRenderConlet
(RenderConletRequestBase<?> event, ConsoleConnection channel, String conletId, LoginConlet.AccountModel model) protected boolean
LoginConlet.doSetLocale
(SetLocale event, ConsoleConnection channel, String conletId) Do set locale.protected void
LoginConlet.doUpdateConletState
(NotifyConletModel event, ConsoleConnection connection, LoginConlet.AccountModel model) protected String
LoginConlet.generateInstanceId
(AddConletRequest event, ConsoleConnection session) void
LoginConlet.onConsolePrepared
(ConsolePrepared event, ConsoleConnection channel) Handle web console page loaded.void
LoginConlet.onConsoleReady
(ConsoleReady event, ConsoleConnection channel) Register conlet. -
Uses of ConsoleConnection in org.jgrapes.webconlet.sysinfo
Modifier and TypeMethodDescriptionprotected Optional
<SysInfoConlet.SysInfoModel> SysInfoConlet.createStateRepresentation
(Event<?> event, ConsoleConnection session, String conletId) protected Set
<Conlet.RenderMode> SysInfoConlet.doRenderConlet
(RenderConletRequestBase<?> event, ConsoleConnection connection, String conletId, SysInfoConlet.SysInfoModel conletState) protected void
SysInfoConlet.doUpdateConletState
(NotifyConletModel event, ConsoleConnection connection, SysInfoConlet.SysInfoModel conletState) void
SysInfoConlet.onConsoleReady
(ConsoleReady event, ConsoleConnection connection) OnConsoleReady
, fire theAddConletType
.void
SysInfoConlet.onUpdate
(SysInfoConlet.Update event, ConsoleConnection connection) Handle the periodic update event by sendingNotifyConletView
events. -
Uses of ConsoleConnection in org.jgrapes.webconsole.base
Modifier and TypeMethodDescriptionSets the locale for this console connection.ConsoleConnection.setSessionSupplier
(Supplier<Optional<Session>> sessionSupplier) Sets or updates associated browser session.ConsoleConnection.setTimeout
(long timeout) Changes the timeout for thisConsoleConnection
to the given value.ConsoleConnection.setUpstreamChannel
(IOSubchannel upstreamChannel) Sets or updates the upstream channel.protected ConsoleConnection[]
AbstractConlet.trackedConnections()
Returns the tracked connections.Modifier and TypeMethodDescriptionstatic Set
<ConsoleConnection> ConsoleConnection.byConsole
(WebConsole console) Return all connections that belong to the given console as a new unmodifiable set.protected Map
<ConsoleConnection, Set<String>> AbstractConlet.conletIdsByConsoleConnection()
Returns the tracked connections and conlet ids as map.Modifier and TypeMethodDescriptionprotected void
AbstractConlet.afterOnClosed
(Closed<?> event, ConsoleConnection connection) Invoked byAbstractConlet.onClosed(Closed, ConsoleConnection)
after the web console connection has been removed from the set of tracked connections.AbstractConlet.conletIds
(ConsoleConnection connection) Returns the set of web console component ids associated with the console connection as aSet
.protected Map
<String, Set<Conlet.RenderMode>> AbstractConlet.conletViews
(ConsoleConnection connection) Returns a map of all conlet ids and the modes in which views are currently rendered.AbstractConlet.createNewState
(AddConletRequest event, ConsoleConnection connection, String conletId) Called byAbstractConlet.onAddConletRequest(org.jgrapes.webconsole.base.events.AddConletRequest, org.jgrapes.webconsole.base.ConsoleConnection)
when a new conlet instance is created in the browser.AbstractConlet.createStateRepresentation
(Event<?> event, ConsoleConnection connection, String conletId) Creates an instance of the type that represents the conlet’s state, initialized with default values.protected void
AbstractConlet.doConletDeleted
(ConletDeleted event, ConsoleConnection channel, String conletId, S conletState) Called byAbstractConlet.onConletDeleted(org.jgrapes.webconsole.base.events.ConletDeleted, org.jgrapes.webconsole.base.ConsoleConnection)
to propagate the event to derived classes.protected abstract Set
<Conlet.RenderMode> AbstractConlet.doRenderConlet
(RenderConletRequestBase<?> event, ConsoleConnection channel, String conletId, S conletState) Called byAbstractConlet.onAddConletRequest(AddConletRequest, ConsoleConnection)
andAbstractConlet.onRenderConletRequest(RenderConletRequest, ConsoleConnection)
to complete rendering the web console component.protected boolean
AbstractConlet.doSetLocale
(SetLocale event, ConsoleConnection channel, String conletId) Called byAbstractConlet.onSetLocale(SetLocale, ConsoleConnection)
for each web console component in the console connection.protected void
AbstractConlet.doUpdateConletState
(NotifyConletModel event, ConsoleConnection channel, S conletState) Called byAbstractConlet.onNotifyConletModel(org.jgrapes.webconsole.base.events.NotifyConletModel, org.jgrapes.webconsole.base.ConsoleConnection)
to complete handling the notification.protected String
AbstractConlet.generateInstanceId
(AddConletRequest event, ConsoleConnection connection) Create the instance specific part of a conlet id.final void
AbstractConlet.onAddConletRequest
(AddConletRequest event, ConsoleConnection connection) Checks if the request applies to this component.final void
AbstractConlet.onClosed
(Closed<?> event, ConsoleConnection connection) Removes theConsoleConnection
from the set of tracked connections.final void
AbstractConlet.onConletDeleted
(ConletDeleted event, ConsoleConnection connection) Checks if the request applies to this component.void
ConsoleWeblet.onConsoleCommand
(ConsoleCommand event, ConsoleConnection channel) Sends a command to the console.void
WebConsole.onConsoleConfigured
(ConsoleConfigured event, ConsoleConnection channel) Handle network configured condition.void
KVStoreBasedConsolePolicy.onConsoleLayoutChanged
(ConsoleLayoutChanged event, ConsoleConnection channel) Forward layout changed event to browser session scoped storage.void
KVStoreBasedConsolePolicy.onConsolePrepared
(ConsolePrepared event, ConsoleConnection channel) Create browser session scoped storage and forward event to it.void
BrowserLocalBackedKVStore.onConsoleReady
(ConsoleReady event, ConsoleConnection channel) InterceptConsoleReady
event to first get data.void
BrowserLocalBackedKVStore.onJsonInput
(JsonInput event, ConsoleConnection channel) Evaluate “retrievedLocalData” response.void
WebConsole.onJsonInput
(JsonInput event, ConsoleConnection channel) Handle JSON input.void
BrowserLocalBackedKVStore.onKeyValueStoreQuery
(KeyValueStoreQuery event, ConsoleConnection channel) Handle data query..void
BrowserLocalBackedKVStore.onKeyValueStoreUpdate
(KeyValueStoreUpdate event, ConsoleConnection channel) Handle data update events.final void
AbstractConlet.onNotifyConletModel
(NotifyConletModel event, ConsoleConnection connection) void
WebConsole.onRenderConlet
(RenderConletRequest event, ConsoleConnection channel) Fallback handler that sends aDeleteConlet
event if theRenderConletRequest
event has not been handled successfully.final void
AbstractConlet.onRenderConletRequest
(RenderConletRequest event, ConsoleConnection connection) 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, ConsoleConnection connection) InvokesAbstractConlet.doSetLocale(SetLocale, ConsoleConnection, String)
for each web console component in the console connection.void
ConsoleWeblet.onSetLocale
(SetLocale event, ConsoleConnection channel) Handles a change of Locale for the console.void
ConsoleWeblet.onSetLocaleCompleted
(SetLocaleCompleted event, ConsoleConnection channel) Sends a reload if the change of locale could not be handled by all conlets.AbstractConlet.recreateState
(Event<?> event, ConsoleConnection connection, String conletId) Called when a previously created conlet (with associated state) is rendered in a new browser session for the first time.protected AbstractConlet.ConletTrackingInfo
AbstractConlet.trackConlet
(ConsoleConnection connection, String conletId, AbstractConlet.ConletTrackingInfo info) Track the given web console component from the given connection.ModifierConstructorDescriptionConsoleConnectionInfo
(ConsoleConnection connection) WebSocketInputSink
(EventPipeline wsInPipeline, ConsoleConnection consoleChannel) Instantiates a new web socket input reader. -
Uses of ConsoleConnection in org.jgrapes.webconsole.base.freemarker
Modifier and TypeMethodDescriptionFreeMarkerConlet.fmModel
(NotifyConletModel event, ConsoleConnection channel, String conletId, Object conletState) FreeMarkerConlet.fmModel
(RenderConletRequestBase<?> event, ConsoleConnection channel, String conletId, Object conletState) -
Uses of ConsoleConnection in org.jgrapes.webconsole.jqueryui
Modifier and TypeMethodDescriptionvoid
JQueryUiWeblet.onJsonInput
(JsonInput event, ConsoleConnection channel) Handle JSON input.void
JQueryUiWeblet.onSetTheme
(SetTheme event, ConsoleConnection channel) Handles a change of theme. -
Uses of ConsoleConnection in org.jgrapes.webconsole.provider.browserrequire
Modifier and TypeMethodDescriptionvoid
BrowserRequireProvider.onConsoleReady
(ConsoleReady event, ConsoleConnection connection) OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleConnection in org.jgrapes.webconsole.provider.chartjs
Modifier and TypeMethodDescriptionvoid
ChartJsProvider.onConsoleReady
(ConsoleReady event, ConsoleConnection connection) OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleConnection in org.jgrapes.webconsole.provider.datatables
Modifier and TypeMethodDescriptionvoid
DatatablesProvider.onConsoleReady
(ConsoleReady event, ConsoleConnection connection) Deprecated.OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleConnection in org.jgrapes.webconsole.provider.fontawesome
Modifier and TypeMethodDescriptionvoid
FontAwesomeProvider.onConsoleReady
(ConsoleReady event, ConsoleConnection connection) OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleConnection in org.jgrapes.webconsole.provider.forkawesome
Modifier and TypeMethodDescriptionvoid
ForkAwesomeProvider.onConsoleReady
(ConsoleReady event, ConsoleConnection connection) OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleConnection in org.jgrapes.webconsole.provider.gridstack
Modifier and TypeMethodDescriptionvoid
GridstackProvider.onConsoleReady
(ConsoleReady event, ConsoleConnection connection) OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleConnection in org.jgrapes.webconsole.provider.jgwcvuecomponents
Modifier and TypeMethodDescriptionvoid
JgWcComponentsProvider.onConsoleReady
(ConsoleReady event, ConsoleConnection connection) OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleConnection in org.jgrapes.webconsole.provider.jquery
Modifier and TypeMethodDescriptionvoid
JQueryProvider.onConsoleReady
(ConsoleReady event, ConsoleConnection connection) OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleConnection in org.jgrapes.webconsole.provider.jqueryui
Modifier and TypeMethodDescriptionvoid
JQueryUi.onConsoleReady
(ConsoleReady event, ConsoleConnection connection) OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleConnection in org.jgrapes.webconsole.provider.jquitouchpunch
Modifier and TypeMethodDescriptionvoid
JQueryUiTouchPunchProvider.onConsoleReady
(ConsoleReady event, ConsoleConnection connection) OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleConnection in org.jgrapes.webconsole.provider.lodash
Modifier and TypeMethodDescriptionvoid
LodashProvider.onConsoleReady
(ConsoleReady event, ConsoleConnection connection) OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleConnection in org.jgrapes.webconsole.provider.luxon
Modifier and TypeMethodDescriptionvoid
LuxonProvider.onConsoleReady
(ConsoleReady event, ConsoleConnection connection) OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleConnection in org.jgrapes.webconsole.provider.markdownit
Modifier and TypeMethodDescriptionvoid
MarkdownItProvider.onConsoleReady
(ConsoleReady event, ConsoleConnection connection) OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleConnection in org.jgrapes.webconsole.provider.moment
Modifier and TypeMethodDescriptionvoid
MomentProvider.onConsoleReady
(ConsoleReady event, ConsoleConnection connection) OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleConnection in org.jgrapes.webconsole.provider.vue
Modifier and TypeMethodDescriptionvoid
VueProvider.onConsoleReady
(ConsoleReady event, ConsoleConnection connection) OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleConnection in org.jgrapes.webconsole.provider.vuejs
Modifier and TypeMethodDescriptionvoid
VueJsProvider.onConsoleReady
(ConsoleReady event, ConsoleConnection connection) Deprecated.OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleConnection in org.jgrapes.webconsole.provider.vuex
Modifier and TypeMethodDescriptionvoid
VuexProvider.onConsoleReady
(ConsoleReady event, ConsoleConnection connection) OnConsoleReady
, fire the appropriateAddPageResources
. -
Uses of ConsoleConnection in org.jgrapes.webconsole.rbac
Modifier and TypeMethodDescriptionvoid
RoleConletFilter.onAddConlet
(AddConletRequest event, ConsoleConnection channel) If the request originates from a client (seeAddConletRequest.isFrontendRequest()
, verifies that the user is allowed to create a conlet of the given type.void
RoleConletFilter.onConsolePrepared
(ConsolePrepared event, ConsoleConnection channel) Disable all conlets that the user is not allowed to use by firingUpdateConletType
events with no render modes.void
RoleConletFilter.onRenderConletRequest
(RenderConletRequest event, ConsoleConnection channel) If a role is withdrawn from a user, there may still be conlets in his stored layout that he is no longer allowed to use.