Package org.jgrapes.webconsole.base

Class AbstractConlet<S>

java.lang.Object

org.jgrapes.core.internal.ComponentVertex

org.jgrapes.core.Component

org.jgrapes.webconsole.base.AbstractConlet<S>

Type Parameters:

S - the type of the conlet’s state information

All Implemented Interfaces:

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

Direct Known Subclasses:

FreeMarkerConlet

public abstract class AbstractConlet<S>
extends Component

Provides a base class for implementing web console components.

The class provides the following support functions:

• “Translate” the conlet related events to invocations of abstract methods. This is mainly a prerequisite for implementing the other support functions.
• Optionally manage state for a conlet instance.
• Optionally track the existing previews or views of a conlet, thus allowing the server side to send update events (usually when the state changes on the server side).
• Optionally refresh existing previews or views periodically

Event handling

The following diagrams show the events exchanged between the WebConsole and a web console component from the web console component’s perspective. If applicable, they also show how the events are translated by the AbstractConlet to invocations of the abstract methods that have to be implemented by the derived class (the web console component that provides a specific web console component type).

ConsoleReady

From the web console’s page point of view, a web console component consists of CSS and JavaScript that is added to the console page by AddConletType events and HTML that is provided by RenderConlet events (see below). These events must therefore be generated by a web console component.

The AbstractConlet does not provide support for generating an AddConletType event. The handler for the ConsoleReady that generates this event must be implemented by the derived class itself.

AddConletRequest

The AddConletRequest indicates that a new web console component instance of a given type should be added to the page. The AbstractConlet checks the type requested, and if it matches, invokes generateInstanceId and createNewState. If the conlet has associated state, the information is saved with putInSession. Then doRenderConlet is invoked, which must render the conlet in the browser. Information about the rendered views is returned and used to track the views.

Method doRenderConlet renders the preview or view by firing a RenderConlet event that provides to the console page the HTML that represents the web console component on the page. The HTML may be generated using and thus depending on the component state. Alternatively, state independent HTML may be provided followed by a NotifyConletView event that updates the HTML (using JavaScript) on the console page. The latter approach is preferred if the model changes frequently and updating the rendered representation is more efficient than providing a new one.

RenderConletRequest

A RenderConletRequest event indicates that the web console page needs the HTML for displaying a web console component. This may be caused by e.g. the initial display, by a refresh or by requesting a full page view from the preview.

Upon receiving such an event, the AbstractConlet checks if it has state information for the component id requested. If not, it calls recreateState which allows the conlet to e.g. retrieve state information from a backing store.

Once state information has been obtained, the method continues as when adding a new conlet by invoking doRenderConlet.

ConletDeleted

When the AbstractConlet receives a ConletDeleted event, it updates the information about the shown conlet views. If the conlet is no longer used in the browser (no views remain), it deletes the state information from the session. In any case, it invokes doConletDeleted with the state information.

NotifyConletModel

If the web console component views include input elements, actions on these elements may result in NotifyConletModel events from the web console page to the web console. When the AbstractConlet receives such events, it retrieves any existing state information. It then invokes doUpdateConletState with the retrieved information. The web console component usually responds with a NotifyConletView event. However, it can also re-render the complete conlet view.

Support for unsolicited updates

The class tracks the relationship between the known ConsoleConnections and the web console components displayed in the console pages. The information is available from conletInfosByConsoleConnection. It can e.g. be used to send events to the web console(s) in response to an event on the server side.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractConlet.ConletTrackingInfo	The information tracked about web console components that are used by the console.

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

Channel.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE_INSTANCE_SEPARATOR	Separator used between type and instance when generating the id.

Fields inherited from class org.jgrapes.core.Component

logger

Fields inherited from interface org.jgrapes.core.Channel

BROADCAST, SELF

Constructor Summary

Constructors

Constructor	Description
AbstractConlet(Channel channel)	Creates a new component that listens for new events on the given channel.
AbstractConlet(Channel channel, HandlerDefinition.ChannelReplacements channelReplacements)	Like AbstractConlet(Channel), but supports the specification of channel replacements.

Method Summary

Modifier and Type	Method	Description
protected void	afterOnClosed(Closed<?> event, ConsoleConnection connection)	Invoked by onClosed(Closed, ConsoleConnection) after the web console connection has been removed from the set of tracked connections.
protected Set<String>	conletIds(ConsoleConnection connection)	Returns the set of web console component ids associated with the console connection as a Set.
protected Map<ConsoleConnection,Set<String>>	conletIdsByConsoleConnection()	Returns the tracked connections and conlet ids as map.
protected Map<String,Set<Conlet.RenderMode>>	conletViews(ConsoleConnection connection)	Returns a map of all conlet ids and the modes in which views are currently rendered.
protected Optional<S>	createNewState(AddConletRequest event, ConsoleConnection connection, String conletId)	Called by onAddConletRequest(org.jgrapes.webconsole.base.events.AddConletRequest, org.jgrapes.webconsole.base.ConsoleConnection) when a new conlet instance is created in the browser.
protected Optional<S>	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	doConletDeleted(ConletDeleted event, ConsoleConnection channel, String conletId, S conletState)	Called by onConletDeleted(org.jgrapes.webconsole.base.events.ConletDeleted, org.jgrapes.webconsole.base.ConsoleConnection) to propagate the event to derived classes.
protected void	doGetResource(ConletResourceRequest event, IOSubchannel channel)	The default implementation searches for a file with the requested resource URI in the web console component’s class path and sets its URL as result if found.
protected void	doRemoveConletType()	Iterates over all connections and fires DeleteConlet events for all known conlets and a UpdateConletType (with no render modes) event.
protected abstract Set<Conlet.RenderMode>	doRenderConlet(RenderConletRequestBase<?> event, ConsoleConnection channel, String conletId, S conletState)	Called by onAddConletRequest(AddConletRequest, ConsoleConnection) and onRenderConletRequest(RenderConletRequest, ConsoleConnection) to complete rendering the web console component.
protected boolean	doSetLocale(SetLocale event, ConsoleConnection channel, String conletId)	Called by onSetLocale(SetLocale, ConsoleConnection) for each web console component in the console connection.
protected void	doUpdateConletState(NotifyConletModel event, ConsoleConnection channel, S conletState)	Called by onNotifyConletModel(org.jgrapes.webconsole.base.events.NotifyConletModel, org.jgrapes.webconsole.base.ConsoleConnection) to complete handling the notification.
protected String	generateInstanceId(AddConletRequest event, ConsoleConnection connection)	Create the instance specific part of a conlet id.
protected Map<Locale,ResourceBundle>	l10nBundles(Set<Locale> toGet)	Returns bundles for the given locales.
protected Map<Locale,String>	localizations(Set<Locale> locales, String key)	Provides localizations for the given key for all requested locales.
final void	onAddConletRequest(AddConletRequest event, ConsoleConnection connection)	Checks if the request applies to this component.
final void	onClosed(Closed<?> event, ConsoleConnection connection)	Removes the ConsoleConnection from the set of tracked connections.
final void	onConletDeleted(ConletDeleted event, ConsoleConnection connection)	Checks if the request applies to this component.
final void	onConletResourceRequest(ConletResourceRequest event, IOSubchannel channel)	A default handler for resource requests.
void	onDetached(Detached event)	Calls doRemoveConletType() if this component is detached.
final void	onNotifyConletModel(NotifyConletModel event, ConsoleConnection connection)	If stateFromSession(Session, String) returns a model, calls doUpdateConletState(org.jgrapes.webconsole.base.events.NotifyConletModel, org.jgrapes.webconsole.base.ConsoleConnection, S) with the model.
final void	onRenderConletRequest(RenderConletRequest event, ConsoleConnection connection)	Checks if the request applies to this component by verifying if the component id starts with type() plus TYPE_INSTANCE_SEPARATOR.
void	onSetLocale(SetLocale event, ConsoleConnection connection)	Invokes doSetLocale(SetLocale, ConsoleConnection, String) for each web console component in the console connection.
protected S	putInSession(Session session, String conletId, S conletState)	Puts the given web console component state in the session using the type() and the given web console component id as keys.
Future<String>	readContent(ExecutorService execSvc, Reader contentReader)	Returns a future string providing the result from reading everything from the provided reader.
Future<String>	readContent(RenderConletRequestBase<?> request, Reader contentReader)	Returns a future string providing the result from reading everything from the provided reader.
protected Optional<S>	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 Optional<S>	removeState(Session session, String conletId)	Removes the web console component state of the web console component with the given id from the session.
protected ResourceBundle	resourceBundle(Locale locale)	Provides a resource bundle for localization.
AbstractConlet<S>	setPeriodicRefresh(Duration interval, Supplier<Event<?>> supplier)	If set to a value different from null causes an event from the given supplier to be fired on all tracked web console connections periodically.
protected Optional<S>	stateFromSession(Session session, String conletId)	Returns the state of this web console component’s type with the given id from the session.
protected Collection<Map.Entry<String,S>>	statesFromSession(Session session)	Returns all conlet ids and conlet states of this web console component’s type from the session.
protected Map<Locale,ResourceBundle>	supportedLocales()	Returns the supported locales and the associated bundles.
protected AbstractConlet.ConletTrackingInfo	trackConlet(ConsoleConnection connection, String conletId, AbstractConlet.ConletTrackingInfo info)	Track the given web console component from the given connection.
protected ConsoleConnection[]	trackedConnections()	Returns the tracked connections.
protected String	type()	Returns the web console component type.
static String	typeFromId(String conletId)	Extract the conlet type from a conlet id.

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

Field Details

TYPE_INSTANCE_SEPARATOR

public static final String TYPE_INSTANCE_SEPARATOR

Separator used between type and instance when generating the id.

See Also:

• Constant Field Values

Constructor Details

AbstractConlet

public AbstractConlet(Channel channel)

Creates a new component that listens for new events on the given channel.

Parameters:

channel - the channel to listen on

AbstractConlet

public AbstractConlet(Channel channel,
 HandlerDefinition.ChannelReplacements channelReplacements)

Like AbstractConlet(Channel), but supports the specification of channel replacements.

Parameters:

channel - the channel to listen on

channelReplacements - the channel replacements (see Component)

Method Details

typeFromId

public static String typeFromId(String conletId)

Extract the conlet type from a conlet id.

Parameters:

conletId - the conlet id

Returns:

the type or null the conlet id does not contain a TYPE_INSTANCE_SEPARATOR

setPeriodicRefresh

public AbstractConlet<S> setPeriodicRefresh(Duration interval,
 Supplier<Event<?>> supplier)

If set to a value different from null causes an event from the given supplier to be fired on all tracked web console connections periodically.

Parameters:

interval - the refresh interval

supplier - the supplier

Returns:

the web console component for easy chaining

type

protected String type()

Returns the web console component type.

The default implementation returns the name of the class.

Returns:

the type

onConletResourceRequest

@Handler
public final void onConletResourceRequest(ConletResourceRequest event,
 IOSubchannel channel)

A default handler for resource requests.

Checks that the request is directed at this web console component, and calls doGetResource(org.jgrapes.webconsole.base.events.ConletResourceRequest, org.jgrapes.io.IOSubchannel).

Parameters:

event - the resource request event

channel - the channel that the request was recived on

doGetResource

protected void doGetResource(ConletResourceRequest event,
 IOSubchannel channel)

The default implementation searches for a file with the requested resource URI in the web console component’s class path and sets its URL as result if found.

Parameters:

event - the event. The result will be set to true on success

channel - the channel

resourceBundle

protected ResourceBundle resourceBundle(Locale locale)

Provides a resource bundle for localization.

The default implementation looks up a bundle using the package name plus “l10n” as base name. Note that the bundle returned for a given locale may be the fallback bundle.

Returns:

the resource bundle

l10nBundles

protected Map<Locale,ResourceBundle> l10nBundles(Set<Locale> toGet)

Returns bundles for the given locales.

The default implementation uses resourceBundle(Locale) to lookup the bundles. The method is guaranteed to return a bundle for each requested locale even if it is only the fallback bundle. The evaluated results are cached for the conlet class.

Parameters:

toGet - the locales to get bundles for

Returns:

the map with locales and bundles

localizations

protected Map<Locale,String> localizations(Set<Locale> locales,
 String key)

Provides localizations for the given key for all requested locales.

The default implementation uses l10nBundles(Set) to obtain the localizations.

Parameters:

locales - the requested locales

key - the key

Returns:

the result

supportedLocales

protected Map<Locale,ResourceBundle> supportedLocales()

Returns the supported locales and the associated bundles.

The default implementation invokes resourceBundle(Locale) with all available locales and drops results with fallback bundles. The evaluated results are cached for the conlet class.

Returns:

the result

generateInstanceId

protected String generateInstanceId(AddConletRequest event,
 ConsoleConnection connection)

Create the instance specific part of a conlet id.

The default implementation generates a UUID. Derived classes override this method if e.g. the instance specific part must include a key that associates the conlet’s state with some backing store.

Parameters:

event - the event that triggered the creation of a new conlet, which may contain required information (see AddConletRequest.properties())

connection - the console connection; usually not required but provided as context

Returns:

the web console component id

createStateRepresentation

protected Optional<S> createStateRepresentation(Event<?> event,
 ConsoleConnection connection,
 String conletId)
                                         throws Exception

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.

Parameters:

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

connection - 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

createNewState

protected Optional<S> createNewState(AddConletRequest event,
 ConsoleConnection connection,
 String conletId)
                              throws Exception

Called by onAddConletRequest(org.jgrapes.webconsole.base.events.AddConletRequest, org.jgrapes.webconsole.base.ConsoleConnection) when a new conlet instance is created in the browser.

The default implementation simply invokes createStateRepresentation(org.jgrapes.core.Event<?>, org.jgrapes.webconsole.base.ConsoleConnection, java.lang.String) and returns its result. If state is provided, it is put in the browser session by the invoker.

This method should only be overridden if the event has associated information (see AddConletRequest.addProperty(java.lang.Object, java.lang.Object)) that can be used to initialize the state with information that differs from the defaults used by createStateRepresentation(org.jgrapes.core.Event<?>, org.jgrapes.webconsole.base.ConsoleConnection, java.lang.String).

Parameters:

event - the event

connection - the console connection

conletId - the conlet id

Returns:

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

Throws:

Exception - if an exception occurs

recreateState

protected Optional<S> recreateState(Event<?> event,
 ConsoleConnection connection,
 String conletId)
                             throws Exception

Called when a previously created conlet (with associated state) is rendered in a new browser session for the first time.

The default implementation simply invokes createStateRepresentation and returns its result. Conlets with long-term state should retrieve their state from some storage. If state is returned, it is put in the browser session by the invoker.

Parameters:

event - the event

connection - the console connection

conletId - the conlet id

Returns:

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

Throws:

Exception - if an exception occurs

conletIdsByConsoleConnection

protected Map<ConsoleConnection,Set<String>> conletIdsByConsoleConnection()

Returns the tracked connections and conlet ids as map.

If you need a particular connection’s web console component ids, you should prefer conletIds(ConsoleConnection) over calling this method with get(consoleConnection) appended.

Returns:

the result

trackedConnections

protected ConsoleConnection[] trackedConnections()

Returns the tracked connections.

This is effectively conletInfosByConsoleConnection().keySet() converted to an array. This representation is especially useful when the web console connections are used as argument for ComponentVertex.fire(Event, Channel...).

Returns:

the web console connections

conletIds

protected Set<String> conletIds(ConsoleConnection connection)

Returns the set of web console component ids associated with the console connection as a Set.

If no web console components have registered yet, an empty set is returned.

Parameters:

connection - the console connection

Returns:

the set

conletViews

protected Map<String,Set<Conlet.RenderMode>> conletViews(ConsoleConnection connection)

Returns a map of all conlet ids and the modes in which views are currently rendered.

Parameters:

connection - the console connection

Returns:

the map

trackConlet

protected AbstractConlet.ConletTrackingInfo trackConlet(ConsoleConnection connection,
 String conletId,
 AbstractConlet.ConletTrackingInfo info)

Track the given web console component from the given connection.

This is invoked by onAddConletRequest(AddConletRequest, ConsoleConnection) and onRenderConletRequest(RenderConletRequest, ConsoleConnection). It needs only be invoked if either method is overridden.

Parameters:

connection - the web console connection

conletId - the conlet id

info - the info to be added if currently untracked. If null, a new AbstractConlet.ConletTrackingInfo is created and added

Returns:

the conlet tracking info

putInSession

protected S putInSession(Session session,
 String conletId,
 S conletState)

Puts the given web console component state in the session using the type() and the given web console component id as keys.

If the state representation implements Serializable, the information is put in the session, else it is put in the session’s Session.transientData().

Parameters:

session - the session to use

conletId - the web console component id

conletState - the web console component state

Returns:

the component state

stateFromSession

protected Optional<S> stateFromSession(Session session,
 String conletId)

Returns the state of this web console component’s type with the given id from the session.

Parameters:

session - the session to use

conletId - the web console component id

Returns:

the web console component state

statesFromSession

protected Collection<Map.Entry<String,S>> statesFromSession(Session session)

Returns all conlet ids and conlet states of this web console component’s type from the session.

Parameters:

session - the console connection

Returns:

the states

removeState

protected Optional<S> removeState(Session session,
 String conletId)

Removes the web console component state of the web console component with the given id from the session.

Parameters:

session - the session to use

conletId - the web console component id

Returns:

the removed state if state existed

onAddConletRequest

@Handler
public final void onAddConletRequest(AddConletRequest event,
 ConsoleConnection connection)
                              throws Exception

Checks if the request applies to this component.

If so, stops the event, requests a new conlet id (see generateInstanceId(org.jgrapes.webconsole.base.events.AddConletRequest, org.jgrapes.webconsole.base.ConsoleConnection)). Stops processing if state for this id already exists (singleton). Otherwise requests new state information (see createNewState(org.jgrapes.webconsole.base.events.AddConletRequest, org.jgrapes.webconsole.base.ConsoleConnection, java.lang.String)) and saves it in the session (see putInSession(org.jgrapes.http.Session, java.lang.String, S)). Finally doRenderConlet(org.jgrapes.webconsole.base.events.RenderConletRequestBase<?>, org.jgrapes.webconsole.base.ConsoleConnection, java.lang.String, S) is called and its result is passed to trackConlet(org.jgrapes.webconsole.base.ConsoleConnection, java.lang.String, org.jgrapes.webconsole.base.AbstractConlet.ConletTrackingInfo).

Parameters:

event - the event

connection - the channel

Throws:

Exception - the exception

onConletDeleted

@Handler
public final void onConletDeleted(ConletDeleted event,
 ConsoleConnection connection)
                           throws Exception

Checks if the request applies to this component.

If so, stops the event. If the conlet is completely removed from the browser, removes the web console component state from the browser session. In all cases, it calls doConletDeleted(org.jgrapes.webconsole.base.events.ConletDeleted, org.jgrapes.webconsole.base.ConsoleConnection, java.lang.String, S) with the state.

Parameters:

event - the event

connection - the web console connection

Throws:

Exception - the exception

doConletDeleted

protected void doConletDeleted(ConletDeleted event,
 ConsoleConnection channel,
 String conletId,
 S conletState)
                        throws Exception

Called by onConletDeleted(org.jgrapes.webconsole.base.events.ConletDeleted, org.jgrapes.webconsole.base.ConsoleConnection) to propagate the event to derived classes.

Parameters:

event - the event

channel - the channel

conletId - the web console component id

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

Throws:

Exception - if a problem occurs

onRenderConletRequest

@Handler
public final void onRenderConletRequest(RenderConletRequest event,
 ConsoleConnection connection)
                                 throws Exception

Checks if the request applies to this component by verifying if the component id starts with type() plus TYPE_INSTANCE_SEPARATOR.

If the id matches, sets the event’s result to true, stops the event and tries to retrieve the model from the session. If this fails, recreateState(org.jgrapes.core.Event<?>, org.jgrapes.webconsole.base.ConsoleConnection, java.lang.String) is called as another attempt to obtain state information.

Finally, doRenderConlet(org.jgrapes.webconsole.base.events.RenderConletRequestBase<?>, org.jgrapes.webconsole.base.ConsoleConnection, java.lang.String, S) is called and the result is added to the tracking information.

Parameters:

event - the event

connection - the web console connection

Throws:

Exception - the exception

doRenderConlet

protected abstract Set<Conlet.RenderMode> doRenderConlet(RenderConletRequestBase<?> event,
 ConsoleConnection channel,
 String conletId,
 S conletState)
                                                  throws Exception

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

The

Parameters:

event - the event

channel - 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

onSetLocale

@Handler
public void onSetLocale(SetLocale event,
 ConsoleConnection connection)
                 throws Exception

Invokes doSetLocale(SetLocale, ConsoleConnection, String) for each web console component in the console connection.

If the vent has the reload flag set, does nothing.

The default implementation fires a

Parameters:

event - the event

connection - the web console connection

Throws:

Exception - the exception

doSetLocale

protected boolean doSetLocale(SetLocale event,
 ConsoleConnection channel,
 String conletId)
                       throws Exception

Called by onSetLocale(SetLocale, ConsoleConnection) for each web console component in the console connection.

Derived classes must send events for updating the representation to match the new locale.

If the method returns false this indicates that the representation cannot be updated without reloading the web console page.

The default implementation fires a RenderConletRequest with tracked render modes (one of or both Conlet.RenderMode.Preview and Conlet.RenderMode.View), thus updating the known representations. (Assuming that “Edit” and “Help” modes are represented with modal dialogs and therefore locale changes aren’t possible while these are open.)

Parameters:

event - the event

channel - the channel

conletId - the web console component id

Returns:

true, if adaption to new locale without reload is possible

Throws:

Exception - the exception

onNotifyConletModel

@Handler
public final void onNotifyConletModel(NotifyConletModel event,
 ConsoleConnection connection)
                               throws Exception

If stateFromSession(Session, String) returns a model, calls doUpdateConletState(org.jgrapes.webconsole.base.events.NotifyConletModel, org.jgrapes.webconsole.base.ConsoleConnection, S) with the model.

Parameters:

event - the event

connection - the connection

Throws:

Exception - the exception

doUpdateConletState

protected void doUpdateConletState(NotifyConletModel event,
 ConsoleConnection channel,
 S conletState)
                            throws Exception

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

The default implementation does nothing.

Parameters:

event - the event

channel - the channel

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

Throws:

Exception

onClosed

@Handler
public final void onClosed(Closed<?> event,
 ConsoleConnection connection)

Removes the ConsoleConnection from the set of tracked connections.

If derived web console components need to perform extra actions when a console connection is closed, they have to override afterOnClosed(Closed, ConsoleConnection).

Parameters:

event - the closed event

connection - the web console connection

afterOnClosed

protected void afterOnClosed(Closed<?> event,
 ConsoleConnection connection)

Invoked by onClosed(Closed, ConsoleConnection) after the web console connection has been removed from the set of tracked connections.

The default implementation does nothing.

Parameters:

event - the closed event

connection - the web console connection

onDetached

@Handler
public void onDetached(Detached event)

Calls doRemoveConletType() if this component is detached.

Parameters:

event - the event

doRemoveConletType

protected void doRemoveConletType()

Iterates over all connections and fires DeleteConlet events for all known conlets and a UpdateConletType (with no render modes) event.

readContent

public Future<String> readContent(RenderConletRequestBase<?> request,
 Reader contentReader)

Returns a future string providing the result from reading everything from the provided reader.

Parameters:

request - the request, used to obtain the ExecutorService service related with the request being processed

contentReader - the reader

Returns:

the future

readContent

public Future<String> readContent(ExecutorService execSvc,
 Reader contentReader)

Returns a future string providing the result from reading everything from the provided reader.

Parameters:

execSvc - the executor service for reading the content

contentReader - the reader

Returns:

the future