org.onosproject.ui

Class RequestHandler

java.lang.Object

org.onosproject.ui.RequestHandler

Direct Known Subclasses:

ChartRequestHandler, TableRequestHandler

public abstract class RequestHandler
extends Object

Abstraction of an entity that handles a specific request from the user interface client.

See Also:

UiMessageHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected static com.fasterxml.jackson.databind.ObjectMapper	MAPPER

Constructor Summary

Constructors

Constructor and Description
RequestHandler(String eventType) Constructs a request handler instance that will handle events of the specified type.

Method Summary

Modifier and Type	Method and Description
protected boolean	bool(com.fasterxml.jackson.databind.node.ObjectNode node, String key) Returns the specified node property as a boolean.
protected void	chain(String eventType, long sid, com.fasterxml.jackson.databind.node.ObjectNode payload) Allows one request handler to pass the event on to another for further processing.
String	eventType() Returns the event type that this handler handles.
protected <T> T	get(Class<T> serviceClass) Returns an implementation of the specified service class.
abstract void	process(long sid, com.fasterxml.jackson.databind.node.ObjectNode payload) Processes the incoming message payload from the client.
protected void	sendMessage(com.fasterxml.jackson.databind.node.ObjectNode message) Sends a message back to the client.
protected void	sendMessage(String eventType, long sid, com.fasterxml.jackson.databind.node.ObjectNode payload) Deprecated.
protected void	sendMessage(String eventType, com.fasterxml.jackson.databind.node.ObjectNode payload) Sends a message back to the client with the given event type and payload.
protected String	string(com.fasterxml.jackson.databind.node.ObjectNode node, String key) Returns the specified node property as a string.
protected String	string(com.fasterxml.jackson.databind.node.ObjectNode node, String key, String defValue) Returns the specified node property as a string, with a default fallback.

Methods inherited from class java.lang.Object

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

Field Detail

MAPPER

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

Constructor Detail

RequestHandler

public RequestHandler(String eventType)

Constructs a request handler instance that will handle events of the specified type.

Parameters:

eventType - type of event that will be handled

Method Detail

eventType

public String eventType()

Returns the event type that this handler handles.

Returns:

event type

process

public abstract void process(long sid,
                             com.fasterxml.jackson.databind.node.ObjectNode payload)

Processes the incoming message payload from the client.

Parameters:

sid - message sequence identifier

payload - request message payload

get

protected <T> T get(Class<T> serviceClass)

Returns an implementation of the specified service class.

Type Parameters:

T - type of service

Parameters:

serviceClass - service class

Returns:

implementation class

Throws:

org.onlab.osgi.ServiceNotFoundException - if no implementation found

sendMessage

@Deprecated
protected void sendMessage(String eventType,
                                       long sid,
                                       com.fasterxml.jackson.databind.node.ObjectNode payload)

Deprecated.

Sends a message back to the client with the given event type and payload.

Parameters:

eventType - message event type

sid - message sequence identifier

payload - message payload

sendMessage

protected void sendMessage(String eventType,
                           com.fasterxml.jackson.databind.node.ObjectNode payload)

Sends a message back to the client with the given event type and payload.

Parameters:

eventType - message event type

payload - message payload

sendMessage

protected void sendMessage(com.fasterxml.jackson.databind.node.ObjectNode message)

Sends a message back to the client. Here, the message is preformatted; the assumption is that it has its eventType and payload attributes already filled in.

Parameters:

message - the message to send

chain

protected void chain(String eventType,
                     long sid,
                     com.fasterxml.jackson.databind.node.ObjectNode payload)

Allows one request handler to pass the event on to another for further processing. Note that the message handlers must be defined in the same parent.

Parameters:

eventType - event type

sid - sequence identifier

payload - message payload

string

protected String string(com.fasterxml.jackson.databind.node.ObjectNode node,
                        String key)

Returns the specified node property as a string.

Parameters:

node - message event

key - property name

Returns:

property as a string

string

protected String string(com.fasterxml.jackson.databind.node.ObjectNode node,
                        String key,
                        String defValue)

Returns the specified node property as a string, with a default fallback.

Parameters:

node - object node

key - property name

defValue - fallback value if property is absent

Returns:

property as a string

bool

protected boolean bool(com.fasterxml.jackson.databind.node.ObjectNode node,
                       String key)

Returns the specified node property as a boolean. More precisely, if the value for the given key is the string "true" then this returns true, false otherwise.

Parameters:

node - object node

key - property name

Returns:

property as a boolean