Package org.jgrapes.webconsole.base

Class ConsoleWeblet

java.lang.Object

org.jgrapes.core.internal.ComponentVertex

org.jgrapes.core.Component

org.jgrapes.webconsole.base.ConsoleWeblet

All Implemented Interfaces:

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

Direct Known Subclasses:

FreeMarkerConsoleWeblet

public abstract class ConsoleWeblet
extends Component

The server side base class for the web console single page application (SPA).

Its main tasks are to provide resources using Request/Response events (see onGet(org.jgrapes.http.events.Request.In.Get, org.jgrapes.io.IOSubchannel) for details about the different kinds of resources), to create the ConsoleConnections for new WebSocket connections (see onUpgraded(org.jgrapes.http.events.Upgraded, org.jgrapes.io.IOSubchannel)) and to convert the JSON RPC messages received from the browser via the web socket to JsonInput events and fire them on the corresponding ConsoleConnection channel.

The class has a counter part in the browser, the jgconsole JavaScript module (see functions) that can be loaded as console-base-resource/jgconsole.js (relative to the configured prefix).

The class also provides handlers for some console related events (i.e. fired on the attached WebConsole’s channel) that affect the console representation in the browser. These handlers are declared with class channel ConsoleConnection which is replaced using the HandlerDefinition.ChannelReplacements mechanism.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ConsoleWeblet.ConsoleChannel	The class used in handler annotations to represent the console channel.
class	ConsoleWeblet.ConsoleResourceChannel	The channel used to send PageResourceRequests and ConletResourceRequests to the web console components (via the console).

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

Channel.Default

Field Summary

Fields inherited from class org.jgrapes.core.Component

logger

Fields inherited from interface org.jgrapes.core.Channel

BROADCAST, SELF

Constructor Summary

Constructors

Constructor	Description
ConsoleWeblet(Channel webletChannel, Channel consoleChannel, URI consolePrefix)	Instantiates a new console weblet.

Method Summary

Modifier and Type	Method	Description
Duration	connectionInactivityTimeout()	Returns the console connection inactivity timeout.
Duration	connectionNetworkTimeout()	Returns the console connection network timeout.
Duration	connectionRefreshInterval()	Returns the console connection refresh interval.
WebConsole	console()	Returns the automatically generated WebConsole component.
protected final List<Class<?>>	consoleHierarchy()	Return the list of classes that form the current console weblet implementation.
ResourceBundle	consoleResourceBundle(Locale locale)	Return the console resources for a given locale.
void	onClosed(Closed<?> event, IOSubchannel wsChannel)	Handles the closed event from the web socket.
void	onConsoleCommand(ConsoleCommand event, ConsoleConnection channel)	Sends a command to the console.
void	onDiscardSession(DiscardSession event)	Discard the session referenced in the event.
void	onGet(Request.In.Get event, IOSubchannel channel)	Handle the GET requests for the various resources.
void	onGetRedirect(Request.In.Get event, IOSubchannel channel)	Redirects GET requests without trailing slash.
void	onInput(Input<CharBuffer> event, IOSubchannel wsChannel)	Handles network input (JSON data).
void	onResourceRequestCompleted(ResourceRequestCompleted event, ConsoleWeblet.ConsoleResourceChannel channel)	Handles the ResourceRequestCompleted event.
void	onSetLocale(SetLocale event, ConsoleConnection channel)	Handles a change of Locale for the console.
void	onSetLocaleCompleted(SetLocaleCompleted event, ConsoleConnection channel)	Sends a reload if the change of locale could not be handled by all conlets.
void	onUpgraded(Upgraded event, IOSubchannel wsChannel)	Called when the connection has been upgraded.
URI	prefix()
ConsoleWeblet	prependConsoleResourceProvider(Class<?> cls)	Prepends the given class to the list of classes searched by provideConsoleResource(Request.In.Get, String, IOSubchannel).
ConsoleWeblet	prependResourceBundleProvider(Class<?> cls)	Prepends a class to the list of classes used to lookup console resources.
protected void	provideConsoleResource(Request.In.Get event, String requestPath, IOSubchannel channel)	Provide a console resource.
protected abstract void	renderConsole(Request.In.Get event, IOSubchannel channel, UUID consoleConnectionId)	Render the console page.
protected RenderSupport	renderSupport()	Provides the render support.
ConsoleWeblet	setConnectionInactivityTimeout(Duration timeout)	Sets the console connection inactivity timeout.
ConsoleWeblet	setConnectionNetworkTimeout(Duration timeout)	Sets the console connection network timeout.
ConsoleWeblet	setConnectionRefreshInterval(Duration interval)	Sets the console connection refresh interval.
void	setUseMinifiedResources(boolean useMinifiedResources)	Determines if resources should be minified.
abstract String	styling()	Returns the name of the styling library or toolkit used by the console.
protected Map<Locale,ResourceBundle>	supportedLocales()	Returns the supported locales and their resource bundles.
protected final void	updateSupportedLocales()	Update the supported locales.
boolean	useMinifiedResources()	Returns whether resources are minified.

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

ConsoleWeblet

public ConsoleWeblet(Channel webletChannel,
 Channel consoleChannel,
 URI consolePrefix)

Instantiates a new console weblet.

The weblet handles Request.In.Get events for URIs that start with the specified prefix (see onGet(org.jgrapes.http.events.Request.In.Get, IOSubchannel)).

Parameters:

webletChannel - the weblet channel

consoleChannel - the console channel

consolePrefix - the console prefix

Method Details

consoleHierarchy

protected final List<Class<?>> consoleHierarchy()

Return the list of classes that form the current console weblet implementation.

This consists of all classes from getClass() up to ConsoleWeblet.class.

Returns:

the list

styling

public abstract String styling()

Returns the name of the styling library or toolkit used by the console.

This value is informative. It may, however, be used by a PageResourceProviderFactory to influence the creation of PageResourceProviders.

Returns:

the value

prefix

public URI prefix()

Returns:

the prefix

console

public WebConsole console()

Returns the automatically generated WebConsole component.

Returns:

the console

setConnectionNetworkTimeout

public ConsoleWeblet setConnectionNetworkTimeout(Duration timeout)

Sets the console connection network timeout.

The console connection will be removed if no messages have been received from the console page for the given duration. The value defaults to 45 seconds.

Parameters:

timeout - the timeout in milli seconds

Returns:

the console view for easy chaining

connectionNetworkTimeout

public Duration connectionNetworkTimeout()

Returns the console connection network timeout.

Returns:

the timeout

setConnectionRefreshInterval

public ConsoleWeblet setConnectionRefreshInterval(Duration interval)

Sets the console connection refresh interval.

The console code in the browser will send a keep alive packet if there has been no user activity for more than the given period. The value defaults to 30 seconds.

Parameters:

interval - the interval

Returns:

the console view for easy chaining

connectionRefreshInterval

public Duration connectionRefreshInterval()

Returns the console connection refresh interval.

Returns:

the interval

setConnectionInactivityTimeout

public ConsoleWeblet setConnectionInactivityTimeout(Duration timeout)

Sets the console connection inactivity timeout.

If there has been no user activity for more than the given duration the console code stops sending keep alive packets and displays a message to the user. The value defaults to -1 (no timeout).

Parameters:

timeout - the timeout

Returns:

the console view for easy chaining

connectionInactivityTimeout

public Duration connectionInactivityTimeout()

Returns the console connection inactivity timeout.

Returns:

the timeout

useMinifiedResources

public boolean useMinifiedResources()

Returns whether resources are minified.

Returns:

the useMinifiedResources

setUseMinifiedResources

public void setUseMinifiedResources(boolean useMinifiedResources)

Determines if resources should be minified.

Parameters:

useMinifiedResources - the useMinifiedResources to set

renderSupport

protected RenderSupport renderSupport()

Provides the render support.

Returns:

the render support

prependResourceBundleProvider

public ConsoleWeblet prependResourceBundleProvider(Class<?> cls)

Prepends a class to the list of classes used to lookup console resources.

See ConsoleResourceBundleControl.newBundle(java.lang.String, java.util.Locale, java.lang.String, java.lang.ClassLoader, boolean). Affects the content of the resource bundle returned by consoleResourceBundle(Locale).

Parameters:

cls - the class to prepend.

Returns:

the console weblet for easy chaining

updateSupportedLocales

protected final void updateSupportedLocales()

Update the supported locales.

consoleResourceBundle

public ResourceBundle consoleResourceBundle(Locale locale)

Return the console resources for a given locale.

Parameters:

locale - the locale

Returns:

the resource bundle

supportedLocales

protected Map<Locale,ResourceBundle> supportedLocales()

Returns the supported locales and their resource bundles.

Returns:

the set of locales supported by the console and their resource bundles

onGetRedirect

@RequestHandler(dynamic=true)
public void onGetRedirect(Request.In.Get event,
 IOSubchannel channel)
                   throws InterruptedException,
IOException,
ParseException

Redirects GET requests without trailing slash.

Parameters:

event - the event

channel - the channel

Throws:

InterruptedException - the interrupted exception

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

ParseException - the parse exception

onGet

@RequestHandler(dynamic=true)
public void onGet(Request.In.Get event,
 IOSubchannel channel)
           throws InterruptedException,
IOException,
ParseException

Handle the GET requests for the various resources.

The requests have to start with the prefix passed to the constructor. Further processing depends on the next path segment:

• .../console-base-resource: Provide a resource associated with this class. The resources are:

  • jgconsole.js: The JavaScript module with helper classes
  • console.css: Some basic styles for conlets

• .../console-resource: Invokes provideConsoleResource(org.jgrapes.http.events.Request.In.Get, java.lang.String, org.jgrapes.io.IOSubchannel) with the remainder of the path.

• .../page-resource: Invokes providePageResource(org.jgrapes.http.events.Request.In.Get, org.jgrapes.io.IOSubchannel, java.lang.String) with the remainder of the path.

• .../conlet-resource: Invokes provideConletResource(org.jgrapes.http.events.Request.In.Get, org.jgrapes.io.IOSubchannel, java.net.URI) with the remainder of the path.

• .../console-connection: Handled by this class. Used e.g. for initiating the web socket connection.

Parameters:

event - the event

channel - the channel

Throws:

InterruptedException - the interrupted exception

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

ParseException - the parse exception

renderConsole

protected abstract void renderConsole(Request.In.Get event,
 IOSubchannel channel,
 UUID consoleConnectionId)
                               throws IOException,
InterruptedException

Render the console page.

Parameters:

event - the event

channel - the channel

Throws:

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

InterruptedException - the interrupted exception

provideConsoleResource

protected void provideConsoleResource(Request.In.Get event,
 String requestPath,
 IOSubchannel channel)

Provide a console resource.

The implementation tries to load the resource using Class.getResource(String) for each class in the class hierarchy, starting with the finally derived class.

Parameters:

event - the event

requestPath - the request path relativized to the common part for console resources

channel - the channel

prependConsoleResourceProvider

public ConsoleWeblet prependConsoleResourceProvider(Class<?> cls)

Prepends the given class to the list of classes searched by provideConsoleResource(Request.In.Get, String, IOSubchannel).

Parameters:

cls - the class to prepend

Returns:

the console weblet for easy chaining

onResourceRequestCompleted

@Handler(channels=ConsoleChannel.class)
public void onResourceRequestCompleted(ResourceRequestCompleted event,
 ConsoleWeblet.ConsoleResourceChannel channel)
                                throws IOException,
InterruptedException

Handles the ResourceRequestCompleted event.

Parameters:

event - the event

channel - the channel

Throws:

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

InterruptedException - the interrupted exception

onSetLocale

@Handler(channels=ConsoleChannel.class,
         priority=10000)
public void onSetLocale(SetLocale event,
 ConsoleConnection channel)
                 throws InterruptedException,
IOException

Handles a change of Locale for the console.

Parameters:

event - the event

channel - the channel

Throws:

InterruptedException - the interrupted exception

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

onSetLocaleCompleted

@Handler(channels=ConsoleChannel.class)
public void onSetLocaleCompleted(SetLocaleCompleted event,
 ConsoleConnection channel)

Sends a reload if the change of locale could not be handled by all conlets.

Parameters:

event - the event

channel - the channel

onUpgraded

@Handler
public void onUpgraded(Upgraded event,
 IOSubchannel wsChannel)
                throws IOException

Called when the connection has been upgraded.

Parameters:

event - the event

wsChannel - the ws channel

Throws:

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

onDiscardSession

@Handler(channels=org.jgrapes.core.Channel.class)
public void onDiscardSession(DiscardSession event)

Discard the session referenced in the event.

Parameters:

event - the event

onInput

@Handler
public void onInput(Input<CharBuffer> event,
 IOSubchannel wsChannel)
             throws IOException

Handles network input (JSON data).

Parameters:

event - the event

wsChannel - the ws channel

Throws:

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

onClosed

@Handler
public void onClosed(Closed<?> event,
 IOSubchannel wsChannel)
              throws IOException

Handles the closed event from the web socket.

Parameters:

event - the event

wsChannel - the WebSocket channel

Throws:

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

onConsoleCommand

@Handler(channels=ConsoleChannel.class,
         priority=-1000)
public void onConsoleCommand(ConsoleCommand event,
 ConsoleConnection channel)
                      throws InterruptedException,
IOException

Sends a command to the console.

Parameters:

event - the event

channel - the channel

Throws:

InterruptedException - the interrupted exception

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