홍길동 / onos

Go to a project
Toggle navigation Toggle navigation pinning
Simon Hunt
8ea1f513 1 parent 9bd1f15b

GUI -- Deleted deprecated UIMessageHandler. 

Change-Id: Ia26853b6cb1198b232edd4e8f0cfffa8ad92dd55
Inline Side-by-side
Showing 1 changed file with 0 additions and 213 deletions
/*
* Copyright 2015 Open Networking Laboratory
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.onosproject.ui;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.ObjectNode;
import org.onlab.osgi.ServiceDirectory;
import java.util.Set;
import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;
/**
* Abstraction of an entity capable of processing a JSON message from the user
* interface client.
* <p>
* The message is a JSON object with the following structure:
* </p>
* <pre>
* {
* "type": "<em>event-type</em>",
* "sid": "<em>sequence-number</em>",
* "payload": {
* <em>arbitrary JSON object structure</em>
* }
* }
* </pre>
*/
@Deprecated
public abstract class UiMessageHandler {
private final Set<String> messageTypes;
private UiConnection connection;
private ServiceDirectory directory;
/**
* Mapper for creating ObjectNodes and ArrayNodes etc.
*/
protected final ObjectMapper mapper = new ObjectMapper();
/**
* Creates a new message handler for the specified set of message types.
*
* @param messageTypes set of message types
*/
protected UiMessageHandler(Set<String> messageTypes) {
this.messageTypes = checkNotNull(messageTypes, "Message types cannot be null");
checkArgument(!messageTypes.isEmpty(), "Message types cannot be empty");
}
/**
* Returns the set of message types which this handler is capable of
* processing.
*
* @return set of message types
*/
public Set<String> messageTypes() {
return messageTypes;
}
/**
* Processes a JSON message from the user interface client.
*
* @param message JSON message
*/
public abstract void process(ObjectNode message);
/**
* Initializes the handler with the user interface connection and
* service directory context.
*
* @param connection user interface connection
* @param directory service directory
*/
public void init(UiConnection connection, ServiceDirectory directory) {
this.connection = connection;
this.directory = directory;
}
/**
* Destroys the message handler context.
*/
public void destroy() {
this.connection = null;
this.directory = null;
}
/**
* Returns the user interface connection with which this handler was primed.
*
* @return user interface connection
*/
public UiConnection connection() {
return connection;
}
/**
* Returns the user interface connection with which this handler was primed.
*
* @return user interface connection
*/
public ServiceDirectory directory() {
return directory;
}
/**
* Returns implementation of the specified service class.
*
* @param serviceClass service class
* @param <T> type of service
* @return implementation class
* @throws org.onlab.osgi.ServiceNotFoundException if no implementation found
*/
protected <T> T get(Class<T> serviceClass) {
return directory.get(serviceClass);
}
/**
* Wraps a message payload into an event structure for the given event
* type and sequence ID. Generally the
*
* @param type event type
* @param sid sequence ID
* @param payload event payload
* @return the object node representation
*/
protected ObjectNode envelope(String type, long sid, ObjectNode payload) {
return JsonUtils.envelope(type, sid, payload);
}
/**
* Returns the event type from the specified event.
*
* @param event the event
* @return the event type
*/
protected String eventType(ObjectNode event) {
return JsonUtils.eventType(event);
}
/**
* Retrieves the payload from the specified event.
*
* @param event message event
* @return extracted payload object
*/
protected ObjectNode payload(ObjectNode event) {
return JsonUtils.payload(event);
}
/**
* Returns the specified node property as a number.
*
* @param node message event
* @param name property name
* @return property as number
*/
protected long number(ObjectNode node, String name) {
return JsonUtils.number(node, name);
}
/**
* Returns the specified node property as a string.
*
* @param node message event
* @param name property name
* @return property as a string
*/
protected String string(ObjectNode node, String name) {
return JsonUtils.string(node, name);
}
/**
* Returns the specified node property as a string with a default fallback.
*
* @param node message event
* @param name property name
* @param defaultValue fallback value if property is absent
* @return property as a string
*/
protected String string(ObjectNode node, String name, String defaultValue) {
return JsonUtils.string(node, name, defaultValue);
}
/**
* Concatenates an arbitrary number of objects, using their
* toString() methods.
*
* @param items the items to concatenate
* @return a concatenated string
*/
protected static String concat(Object... items) {
StringBuilder sb = new StringBuilder();
for (Object o : items) {
sb.append(o);
}
return sb.toString();
}
}