Package org.jdrupes.vmoperator.vmconlet

Class VmConlet

java.lang.Object

org.jgrapes.core.internal.ComponentVertex

org.jgrapes.core.Component

org.jgrapes.webconsole.base.AbstractConlet<VmConlet.VmsModel>

org.jgrapes.webconsole.base.freemarker.FreeMarkerConlet<VmConlet.VmsModel>

org.jdrupes.vmoperator.vmconlet.VmConlet

All Implemented Interfaces:

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

public class VmConlet
extends org.jgrapes.webconsole.base.freemarker.FreeMarkerConlet<VmConlet.VmsModel>

The Class VmConlet.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VmConlet.Summary	The Class Summary.
static class	VmConlet.Update	The periodically generated update event.
class	VmConlet.VmsModel	The Class VmsModel.

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

org.jgrapes.webconsole.base.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
VmConlet(Channel componentChannel)	Creates a new component with its channel set to the given channel.

Method Summary

Modifier and Type	Method	Description
protected Optional<VmConlet.VmsModel>	createNewState(org.jgrapes.webconsole.base.events.AddConletRequest event, org.jgrapes.webconsole.base.ConsoleConnection connection, String conletId)
protected Set<org.jgrapes.webconsole.base.Conlet.RenderMode>	doRenderConlet(org.jgrapes.webconsole.base.events.RenderConletRequestBase<?> event, org.jgrapes.webconsole.base.ConsoleConnection channel, String conletId, VmConlet.VmsModel conletState)
protected boolean	doSetLocale(org.jgrapes.webconsole.base.events.SetLocale event, org.jgrapes.webconsole.base.ConsoleConnection channel, String conletId)
protected void	doUpdateConletState(org.jgrapes.webconsole.base.events.NotifyConletModel event, org.jgrapes.webconsole.base.ConsoleConnection channel, VmConlet.VmsModel conletState)
void	onConsoleReady(org.jgrapes.webconsole.base.events.ConsoleReady event, org.jgrapes.webconsole.base.ConsoleConnection channel)	On ConsoleReady, fire the AddConletType.
void	onUpdate(VmConlet.Update event, org.jgrapes.webconsole.base.ConsoleConnection connection)	Handle the periodic update event by sending NotifyConletView events.
void	onVmDefChanged(VmDefChanged event, VmChannel channel)	Track the VM definitions.

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, createStateRepresentation, doConletDeleted, doRemoveConletType, 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

VmConlet

public VmConlet(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(org.jgrapes.webconsole.base.events.ConsoleReady event,
 org.jgrapes.webconsole.base.ConsoleConnection channel)
                    throws TemplateNotFoundException,
MalformedTemplateNameException,
ParseException,
IOException

On ConsoleReady, fire the AddConletType.

Parameters:

event - the event

channel - the channel

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.

createNewState

protected Optional<VmConlet.VmsModel> createNewState(org.jgrapes.webconsole.base.events.AddConletRequest event,
 org.jgrapes.webconsole.base.ConsoleConnection connection,
 String conletId)
                                              throws Exception

Overrides:

createNewState in class org.jgrapes.webconsole.base.AbstractConlet<VmConlet.VmsModel>

Throws:

Exception

doRenderConlet

protected Set<org.jgrapes.webconsole.base.Conlet.RenderMode> doRenderConlet(org.jgrapes.webconsole.base.events.RenderConletRequestBase<?> event,
 org.jgrapes.webconsole.base.ConsoleConnection channel,
 String conletId,
 VmConlet.VmsModel conletState)
                                                                     throws Exception

Specified by:

doRenderConlet in class org.jgrapes.webconsole.base.AbstractConlet<VmConlet.VmsModel>

Throws:

Exception

onVmDefChanged

@Handler(namedChannels="manager")
public void onVmDefChanged(VmDefChanged event,
 VmChannel channel)
                    throws IOException

Track the VM definitions.

Parameters:

event - the event

channel - the channel

Throws:

IOException

onUpdate

@Handler
public void onUpdate(VmConlet.Update event,
 org.jgrapes.webconsole.base.ConsoleConnection connection)

Handle the periodic update event by sending NotifyConletView events.

Parameters:

event - the event

connection - the console connection

doUpdateConletState

protected void doUpdateConletState(org.jgrapes.webconsole.base.events.NotifyConletModel event,
 org.jgrapes.webconsole.base.ConsoleConnection channel,
 VmConlet.VmsModel conletState)
                            throws Exception

Overrides:

doUpdateConletState in class org.jgrapes.webconsole.base.AbstractConlet<VmConlet.VmsModel>

Throws:

Exception

doSetLocale

protected boolean doSetLocale(org.jgrapes.webconsole.base.events.SetLocale event,
 org.jgrapes.webconsole.base.ConsoleConnection channel,
 String conletId)
                       throws Exception

Overrides:

doSetLocale in class org.jgrapes.webconsole.base.AbstractConlet<VmConlet.VmsModel>

Throws:

Exception