Package org.jgrapes.webconsole.base.events

Class ConsoleCommand

java.lang.Object

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

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)).

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.concurrent.Future

Future.State

Field Summary

Fields

Modifier and Type	Field	Description
protected static final com.fasterxml.jackson.databind.ObjectMapper	mapper	The mapper.

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

completed, completionEvents, invokedFor

Constructor Summary

Constructors

Constructor	Description
ConsoleCommand()

Method Summary

Modifier and Type	Method	Description
abstract void	emitJson(Writer writer)	Emits the JSON notification using the given writer.
protected void	emitJson(Writer writer, String method, Object... params)	Creates a JSON notification from the given data.
protected void	toJson(Writer writer, String method, Object... params)	Deprecated. Use emitJson(Writer, String, Object...) instead.

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

Methods inherited from interface java.util.concurrent.Future

exceptionNow, resultNow, state

Field Details

mapper

protected static final com.fasterxml.jackson.databind.ObjectMapper mapper

The mapper.

Constructor Details

ConsoleCommand

public ConsoleCommand()

Method Details

emitJson

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

Emits the JSON notification using the given writer.

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

Parameters:

writer - the writer

Throws:

InterruptedException

IOException

emitJson

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

Creates a JSON notification from the given data.

Closes the writer.

Parameters:

writer - the writer

method - the method

params - the params

Throws:

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

toJson

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

Deprecated.

Use emitJson(Writer, String, Object...) instead.

Calls emitJson(Writer, String, Object...) with the given method and parameters.

Provided for backwards compatibility.

Parameters:

writer - the writer

method - the method

params - the params

Throws:

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