org.wisdom.monitor.extensions.terminal

Class WisitShellController

java.lang.Object

org.wisdom.api.http.Results

org.wisdom.api.DefaultController

org.wisdom.monitor.extensions.terminal.WisitShellController

All Implemented Interfaces:

org.wisdom.api.Controller, org.wisdom.api.http.HeaderNames, org.wisdom.api.http.Status, MonitorExtension

public class WisitShellController
extends org.wisdom.api.DefaultController
implements MonitorExtension

The Wisit Terminal allows for an user to run commands from the web.

POST /monitor/terminal/wisit/command/{name} -> run the {name} command, arguments in body GET /monitor/terminal/wisit/command -> return the json list of available commands

Command result are published on the `/wisit/stream` websocket.

Field Summary

Fields

Modifier and Type	Field and Description
private org.ow2.shelbie.core.registry.CommandRegistry	commandRegistry
private org.apache.felix.service.command.CommandProcessor	processor
private org.wisdom.api.http.websockets.Publisher	publisher
private WisitSession	shellSession
(package private) org.wisdom.api.templates.Template	terminal

Fields inherited from interface org.wisdom.api.http.Status

ACCEPTED, BAD_GATEWAY, BAD_REQUEST, CONFLICT, CONTINUE, CREATED, EXPECTATION_FAILED, FORBIDDEN, FOUND, GATEWAY_TIMEOUT, GONE, HTTP_VERSION_NOT_SUPPORTED, INTERNAL_SERVER_ERROR, LENGTH_REQUIRED, METHOD_NOT_ALLOWED, MOVED_PERMANENTLY, MULTIPLE_CHOICES, NO_CONTENT, NON_AUTHORITATIVE_INFORMATION, NOT_ACCEPTABLE, NOT_FOUND, NOT_IMPLEMENTED, NOT_MODIFIED, OK, PARTIAL_CONTENT, PAYMENT_REQUIRED, PRECONDITION_FAILED, PROXY_AUTHENTICATION_REQUIRED, REQUEST_ENTITY_TOO_LARGE, REQUEST_TIMEOUT, REQUEST_URI_TOO_LONG, REQUESTED_RANGE_NOT_SATISFIABLE, RESET_CONTENT, SEE_OTHER, SERVICE_UNAVAILABLE, SWITCHING_PROTOCOLS, TEMPORARY_REDIRECT, UNAUTHORIZED, UNSUPPORTED_MEDIA_TYPE, USE_PROXY

Fields inherited from interface org.wisdom.api.http.HeaderNames

ACCEPT, ACCEPT_CHARSET, ACCEPT_ENCODING, ACCEPT_LANGUAGE, ACCEPT_RANGES, ACCESS_CONTROL_ALLOW_CREDENTIALS, ACCESS_CONTROL_ALLOW_HEADERS, ACCESS_CONTROL_ALLOW_METHODS, ACCESS_CONTROL_ALLOW_ORIGIN, ACCESS_CONTROL_EXPOSE_HEADERS, ACCESS_CONTROL_MAX_AGE, ACCESS_CONTROL_REQUEST_HEADERS, ACCESS_CONTROL_REQUEST_METHOD, AGE, ALLOW, AUTHORIZATION, CACHE_CONTROL, CONNECTION, CONTENT_DISPOSITION, CONTENT_ENCODING, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_LOCATION, CONTENT_MD5, CONTENT_RANGE, CONTENT_TRANSFER_ENCODING, CONTENT_TYPE, COOKIE, DATE, ETAG, EXPECT, EXPIRES, FROM, HOST, IF_MATCH, IF_MODIFIED_SINCE, IF_NONE_MATCH, IF_RANGE, IF_UNMODIFIED_SINCE, LAST_MODIFIED, LOCATION, MAX_FORWARDS, NOCACHE_VALUE, ORIGIN, PRAGMA, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, RANGE, REFERER, RETRY_AFTER, SERVER, SET_COOKIE, SET_COOKIE2, TE, TRAILER, TRANSFER_ENCODING, UPGRADE, USER_AGENT, VARY, VIA, WARNING, WWW_AUTHENTICATE, X_FORWARD_FOR, X_WISDOM_DISABLED_ENCODING_HEADER

Constructor Summary

Constructors

Constructor and Description
WisitShellController()

Method Summary

Modifier and Type	Method and Description
String	category()
org.wisdom.api.http.Result	command(String name, String args) Executes the given command.
org.wisdom.api.http.Result	commands() Retrieves the commands.
Collection<String>	getCommands()
String	label()
org.wisdom.api.http.Result	ping() Ping.
void	start() Initiates the controller.
void	stop() Tears down the controller.
org.wisdom.api.http.Result	terminal()
String	url()

Methods inherited from class org.wisdom.api.DefaultController

context, flash, flash, flash, logger, render, render, render, request, routes, session, session, session

Methods inherited from class org.wisdom.api.http.Results

async, badRequest, badRequest, badRequest, badRequest, forbidden, forbidden, forbidden, html, internalServerError, internalServerError, internalServerError, internalServerError, json, noContent, notFound, notFound, notFound, notFound, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, redirect, redirectTemporary, status, todo, unauthorized, unauthorized, unauthorized, xml

Methods inherited from class java.lang.Object

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

Field Detail

shellSession

private WisitSession shellSession

commandRegistry

private org.ow2.shelbie.core.registry.CommandRegistry commandRegistry

processor

private org.apache.felix.service.command.CommandProcessor processor

publisher

private org.wisdom.api.http.websockets.Publisher publisher

terminal

org.wisdom.api.templates.Template terminal

Constructor Detail

WisitShellController

public WisitShellController()

Method Detail

start

public void start()

Initiates the controller.

stop

public void stop()

Tears down the controller.

terminal

public org.wisdom.api.http.Result terminal()

Returns:

the terminal page.

ping

public org.wisdom.api.http.Result ping()

Ping.

Returns:

OK

commands

public org.wisdom.api.http.Result commands()

Retrieves the commands.

Returns:

the commands

command

public org.wisdom.api.http.Result command(String name,
                                          String args)

Executes the given command.

Parameters:

name - the name

args - the argument

Returns:

the result

getCommands

public Collection<String> getCommands()

Returns:

The collection of commands available in the terminal.

label

public String label()

Specified by:

label in interface MonitorExtension

Returns:

"Shell".

url

public String url()

Specified by:

url in interface MonitorExtension

Returns:

the extension's page.

category

public String category()

Specified by:

category in interface MonitorExtension

Returns:

"osgi".