Package org.jgrapes.webconlet.sysinfo

Class SysInfoConlet

java.lang.Object

org.jgrapes.core.internal.ComponentVertex

org.jgrapes.core.Component

org.jgrapes.webconsole.base.AbstractConlet<SysInfoConlet.SysInfoModel>

org.jgrapes.webconsole.base.freemarker.FreeMarkerConlet<SysInfoConlet.SysInfoModel>

org.jgrapes.webconlet.sysinfo.SysInfoConlet

All Implemented Interfaces:

Iterable<ComponentType>, Channel, ComponentType, Eligible, Manager

public class SysInfoConlet
extends FreeMarkerConlet<SysInfoConlet.SysInfoModel>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SysInfoConlet.SysInfoModel	The conlet’s model.
static class	SysInfoConlet.Update	The periodically generated update event.

Nested classes/interfaces inherited from class org.jgrapes.webconsole.base.AbstractConlet

AbstractConlet.ConletTrackingInfo

Nested classes/interfaces inherited from interface org.jgrapes.core.Channel

Channel.Default

Field Summary

Fields inherited from class org.jgrapes.webconsole.base.AbstractConlet

TYPE_INSTANCE_SEPARATOR

Fields inherited from class org.jgrapes.core.Component

logger

Fields inherited from interface org.jgrapes.core.Channel

BROADCAST, SELF

Constructor Summary

Constructors

Constructor	Description
SysInfoConlet(Channel componentChannel)	Creates a new component with its channel set to the given channel.

Method Summary

Modifier and Type	Method	Description
protected Optional<SysInfoConlet.SysInfoModel>	createStateRepresentation(Event<?> event, ConsoleConnection session, String conletId)	Creates an instance of the type that represents the conlet’s state, initialized with default values.
protected Set<Conlet.RenderMode>	doRenderConlet(RenderConletRequestBase<?> event, ConsoleConnection connection, String conletId, SysInfoConlet.SysInfoModel conletState)	Called by AbstractConlet.onAddConletRequest(AddConletRequest, ConsoleConnection) and AbstractConlet.onRenderConletRequest(RenderConletRequest, ConsoleConnection) to complete rendering the web console component.
protected void	doUpdateConletState(NotifyConletModel event, ConsoleConnection connection, SysInfoConlet.SysInfoModel conletState)	Called by AbstractConlet.onNotifyConletModel(org.jgrapes.webconsole.base.events.NotifyConletModel, org.jgrapes.webconsole.base.ConsoleConnection) to complete handling the notification.
void	onConsoleReady(ConsoleReady event, ConsoleConnection connection)	On ConsoleReady, fire the AddConletType.
void	onUpdate(SysInfoConlet.Update event, ConsoleConnection connection)	Handle the periodic update event by sending NotifyConletView events.

Methods inherited from class org.jgrapes.webconsole.base.freemarker.FreeMarkerConlet

doGetResource, fmConletModel, fmModel, fmModel, fmSessionModel, fmTypeModel, freemarkerConfig, processTemplate, processTemplate

Methods inherited from class org.jgrapes.webconsole.base.AbstractConlet

afterOnClosed, conletIds, conletIdsByConsoleConnection, conletViews, createNewState, doConletDeleted, doRemoveConletType, doSetLocale, generateInstanceId, l10nBundles, localizations, onAddConletRequest, onClosed, onConletDeleted, onConletResourceRequest, onDetached, onNotifyConletModel, onRenderConletRequest, onSetLocale, putInSession, readContent, readContent, recreateState, removeState, resourceBundle, setPeriodicRefresh, stateFromSession, statesFromSession, supportedLocales, trackConlet, trackedConnections, type, typeFromId

Methods inherited from class org.jgrapes.core.Component

channel, component, defaultCriterion, isEligibleFor, setName

Methods inherited from class org.jgrapes.core.internal.ComponentVertex

activeEventPipeline, addHandler, attach, channelReplacements, children, componentPath, componentVertex, detach, fire, initComponentsHandlers, iterator, name, newEventPipeline, newEventPipeline, parent, registerAsGenerator, root, toString, unregisterAsGenerator

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.jgrapes.core.Manager

stream

Constructor Details

SysInfoConlet

public SysInfoConlet(Channel componentChannel)

Creates a new component with its channel set to the given channel.

Parameters:

componentChannel - the channel that the component’s handlers listen on by default and that Manager.fire(Event, Channel...) sends the event to

Method Details

onConsoleReady

@Handler
public void onConsoleReady(ConsoleReady event,
 ConsoleConnection connection)
                    throws TemplateNotFoundException,
MalformedTemplateNameException,
ParseException,
IOException

On ConsoleReady, fire the AddConletType.

Parameters:

event - the event

connection - the console connection

Throws:

TemplateNotFoundException - the template not found exception

MalformedTemplateNameException - the malformed template name exception

ParseException - the parse exception

IOException - Signals that an I/O exception has occurred.

createStateRepresentation

protected Optional<SysInfoConlet.SysInfoModel> createStateRepresentation(Event<?> event,
 ConsoleConnection session,
 String conletId)
                                                                  throws Exception

Description copied from class: AbstractConlet

Creates an instance of the type that represents the conlet’s state, initialized with default values.

The default implementation returns Optional.isEmpty(), thus indicating that no state information is needed or available.

This method should always be overridden if conlet instances have associated state.

Overrides:

createStateRepresentation in class AbstractConlet<SysInfoConlet.SysInfoModel>

Parameters:

event - the event, which may contain required information (see AddConletRequest.properties())

session - the console connection, sometimes required to send events to components that provide a backing store

conletId - the conlet id calculated as type() + TYPE_INSTANCE_SEPARATOR + generateInstanceId(...)

Returns:

the state representation or Optional.empty() if none is required

Throws:

Exception - if an exception occurs

doRenderConlet

protected Set<Conlet.RenderMode> doRenderConlet(RenderConletRequestBase<?> event,
 ConsoleConnection connection,
 String conletId,
 SysInfoConlet.SysInfoModel conletState)
                                         throws Exception

Description copied from class: AbstractConlet

Called by AbstractConlet.onAddConletRequest(AddConletRequest, ConsoleConnection) and AbstractConlet.onRenderConletRequest(RenderConletRequest, ConsoleConnection) to complete rendering the web console component.

The

Specified by:

doRenderConlet in class AbstractConlet<SysInfoConlet.SysInfoModel>

Parameters:

event - the event

connection - the channel

conletId - the component id

conletState - the conlet’s state; may be null if the conlet doesn’t have associated state information

Returns:

the rendered modes

Throws:

Exception - the exception

onUpdate

@Handler
public void onUpdate(SysInfoConlet.Update event,
 ConsoleConnection connection)

Handle the periodic update event by sending NotifyConletView events.

Parameters:

event - the event

connection - the console connection

doUpdateConletState

protected void doUpdateConletState(NotifyConletModel event,
 ConsoleConnection connection,
 SysInfoConlet.SysInfoModel conletState)
                            throws Exception

Description copied from class: AbstractConlet

Called by AbstractConlet.onNotifyConletModel(org.jgrapes.webconsole.base.events.NotifyConletModel, org.jgrapes.webconsole.base.ConsoleConnection) to complete handling the notification.

The default implementation does nothing.

Overrides:

doUpdateConletState in class AbstractConlet<SysInfoConlet.SysInfoModel>

Parameters:

event - the event

connection - the channel

conletState - the conlet’s state; may be null if the conlet doesn’t have associated state information

Throws:

Exception