Package org.jgrapes.webconsole.base.events

Class ConsoleCommand

java.lang.Object

org.jgrapes.core.internal.EventBase<T>

org.jgrapes.core.Event<Void>

org.jgrapes.webconsole.base.events.ConsoleCommand

All Implemented Interfaces:

Future<Void>, Associator, Eligible

Direct Known Subclasses:

AddConletType, AddPageResources, CloseModalDialog, DeleteConlet, DisplayNotification, LastConsoleLayout, NotifyConletView, OpenModalDialog, RenderConlet, SimpleConsoleCommand, UpdateConletType

public abstract class ConsoleCommand
extends Event<Void>

Events derived from this class are transformed to JSON messages that are sent to the web console page.

They may only be fired on the IOSubchannel.DefaultIOSubchannel.responsePipeline() (usually with IOSubchannel.respond(org.jgrapes.core.Event)).

Field Summary

Fields inherited from class org.jgrapes.core.internal.EventBase

completed, completionEvents

Constructor Summary

Constructors

Constructor	Description
ConsoleCommand()

Method Summary

Modifier and Type	Method	Description
abstract void	toJson(Writer writer)	Writes the event as JSON notification to the given writer.
protected void	toJson(Writer writer, String method, Object... params)	Creates a JSON notification from the given data.

Methods inherited from class org.jgrapes.core.Event

addCompletionEvent, associated, cancel, channels, channels, completionEvents, currentResults, defaultCriterion, forChannels, get, get, handled, handlingError, isCancelled, isDone, isEligibleFor, isStopped, processedBy, results, results, resumeHandling, setAssociated, setChannels, setRequiresResult, setResult, stop, suspendHandling, suspendHandling, tieTo, toString

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

disableTracking, enqueued, firstResultAssigned, isTracked, onCompletion

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jgrapes.core.Associator

associated, associated, associated, associatedGet

Constructor Details

ConsoleCommand

public ConsoleCommand()

Method Details

toJson

public abstract void toJson(Writer writer)
                     throws InterruptedException,
IOException

Writes the event as JSON notification to the given writer.

Derived classes usually simply call toJson(Writer, String, Object...) with the method name and parameters.

Parameters:

writer - the writer

Throws:

InterruptedException

IOException

toJson

protected void toJson(Writer writer,
 String method,
 Object... params)
               throws IOException

Creates a JSON notification from the given data.

Closes the writer.

Parameters:

writer - the writer

Throws:

IOException