Package org.jdrupes.vmoperator.vmviewer

Class VmViewer

java.lang.Object

org.jgrapes.core.internal.ComponentVertex

org.jgrapes.core.Component

org.jgrapes.webconsole.base.AbstractConlet<VmViewer.ViewerModel>

org.jgrapes.webconsole.base.freemarker.FreeMarkerConlet<VmViewer.ViewerModel>

org.jdrupes.vmoperator.vmviewer.VmViewer

All Implemented Interfaces:

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

public class VmViewer
extends org.jgrapes.webconsole.base.freemarker.FreeMarkerConlet<VmViewer.ViewerModel>

The Class VmViewer.

The component supports the following configuration properties:

• displayResource: a map with the following entries:
  • preferredIpVersion: ipv4 or ipv6 (default: ipv4). Determines the IP addresses uses in the generated connection file.
• deleteConnectionFile: true or false (default: true). If true, the downloaded connection file will be deleted by the remote viewer when opened.
• syncPreviewsFor: a list objects with either property user or role and the associated name (default: []). The remote viewer will synchronize the previews for the specified users and roles.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VmViewer.Update	The periodically generated update event.
static class	VmViewer.ViewerModel	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
VmViewer(Channel componentChannel)	Creates a new component with its channel set to the given channel.

Method Summary

Modifier and Type	Method	Description
protected Optional<VmViewer.ViewerModel>	createNewState(org.jgrapes.webconsole.base.events.AddConletRequest event, org.jgrapes.webconsole.base.ConsoleConnection connection, String conletId)
protected Optional<VmViewer.ViewerModel>	createStateRepresentation(Event<?> event, org.jgrapes.webconsole.base.ConsoleConnection connection, String conletId)
protected void	doConletDeleted(org.jgrapes.webconsole.base.events.ConletDeleted event, org.jgrapes.webconsole.base.ConsoleConnection channel, String conletId, VmViewer.ViewerModel conletState)
protected Set<org.jgrapes.webconsole.base.Conlet.RenderMode>	doRenderConlet(org.jgrapes.webconsole.base.events.RenderConletRequestBase<?> event, org.jgrapes.webconsole.base.ConsoleConnection channel, String conletId, VmViewer.ViewerModel model)
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, VmViewer.ViewerModel model)
void	onConfigurationUpdate(ConfigurationUpdate event)	Configure the component.
void	onConsoleConfigured(org.jgrapes.webconsole.base.events.ConsoleConfigured event, org.jgrapes.webconsole.base.ConsoleConnection connection)	On console configured.
void	onConsolePrepared(org.jgrapes.webconsole.base.events.ConsolePrepared event, org.jgrapes.webconsole.base.ConsoleConnection connection)	On console prepared.
void	onConsoleReady(org.jgrapes.webconsole.base.events.ConsoleReady event, org.jgrapes.webconsole.base.ConsoleConnection channel)	On ConsoleReady, fire the AddConletType.
void	onVmDefChanged(VmDefChanged event, VmChannel channel)	Track the VM definitions.
protected Optional<VmViewer.ViewerModel>	recreateState(Event<?> event, org.jgrapes.webconsole.base.ConsoleConnection channel, String conletId)

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, doRemoveConletType, generateInstanceId, l10nBundles, localizations, onAddConletRequest, onClosed, onConletDeleted, onConletResourceRequest, onDetached, onNotifyConletModel, onRenderConletRequest, onSetLocale, putInSession, readContent, readContent, 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

VmViewer

public VmViewer(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

onConfigurationUpdate

@Handler
public void onConfigurationUpdate(ConfigurationUpdate event)

Configure the component.

Parameters:

event - the event

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.

onConsoleConfigured

@Handler
public void onConsoleConfigured(org.jgrapes.webconsole.base.events.ConsoleConfigured event,
 org.jgrapes.webconsole.base.ConsoleConnection connection)
                         throws InterruptedException,
IOException

On console configured.

Parameters:

event - the event

connection - the console connection

Throws:

InterruptedException - the interrupted exception

IOException

onConsolePrepared

@Handler
public void onConsolePrepared(org.jgrapes.webconsole.base.events.ConsolePrepared event,
 org.jgrapes.webconsole.base.ConsoleConnection connection)

On console prepared.

Parameters:

event - the event

connection - the connection

createNewState

protected Optional<VmViewer.ViewerModel> 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<VmViewer.ViewerModel>

Throws:

Exception

createStateRepresentation

protected Optional<VmViewer.ViewerModel> createStateRepresentation(Event<?> event,
 org.jgrapes.webconsole.base.ConsoleConnection connection,
 String conletId)
                                                            throws Exception

Overrides:

createStateRepresentation in class org.jgrapes.webconsole.base.AbstractConlet<VmViewer.ViewerModel>

Throws:

Exception

recreateState

protected Optional<VmViewer.ViewerModel> recreateState(Event<?> event,
 org.jgrapes.webconsole.base.ConsoleConnection channel,
 String conletId)
                                                throws Exception

Overrides:

recreateState in class org.jgrapes.webconsole.base.AbstractConlet<VmViewer.ViewerModel>

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,
 VmViewer.ViewerModel model)
                                                                     throws Exception

Specified by:

doRenderConlet in class org.jgrapes.webconsole.base.AbstractConlet<VmViewer.ViewerModel>

Throws:

Exception

doConletDeleted

protected void doConletDeleted(org.jgrapes.webconsole.base.events.ConletDeleted event,
 org.jgrapes.webconsole.base.ConsoleConnection channel,
 String conletId,
 VmViewer.ViewerModel conletState)
                        throws Exception

Overrides:

doConletDeleted in class org.jgrapes.webconsole.base.AbstractConlet<VmViewer.ViewerModel>

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

doUpdateConletState

protected void doUpdateConletState(org.jgrapes.webconsole.base.events.NotifyConletModel event,
 org.jgrapes.webconsole.base.ConsoleConnection channel,
 VmViewer.ViewerModel model)
                            throws Exception

Overrides:

doUpdateConletState in class org.jgrapes.webconsole.base.AbstractConlet<VmViewer.ViewerModel>

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<VmViewer.ViewerModel>

Throws:

Exception