3 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
5 * This program and the accompanying materials are made available under the
6 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
7 * and is available at http://www.eclipse.org/legal/epl-v10.html
13 * @brief Describe a generic network element in multiple SDNs technologies
15 * Describe a generic network element in multiple SDNs technologies. A
16 * Node is identified by the pair (NodeType, NodeID), the nodetype are
17 * needed in order to further specify the nodeID
19 package org.opendaylight.controller.sal.core;
21 import java.io.Serializable;
22 import java.math.BigInteger;
24 import java.util.UUID;
25 import java.util.concurrent.ConcurrentHashMap;
27 import javax.xml.bind.annotation.XmlAccessType;
28 import javax.xml.bind.annotation.XmlAccessorType;
29 import javax.xml.bind.annotation.XmlAttribute;
30 import javax.xml.bind.annotation.XmlRootElement;
32 import org.apache.commons.lang3.builder.EqualsBuilder;
33 import org.apache.commons.lang3.builder.HashCodeBuilder;
34 import org.opendaylight.controller.sal.utils.HexEncode;
37 * Describe a generic network element in multiple SDNs technologies. A
38 * Node is identified by the pair (NodeType, NodeID), the nodetype are
39 * needed in order to further specify the nodeID
42 @XmlAccessorType(XmlAccessType.NONE)
44 public class Node implements Serializable {
45 private static final long serialVersionUID = 1L;
48 * Enum-like static class created with the purpose of identifing
49 * multiple type of nodes in the SDN network. The type is
50 * necessary to figure out to later on correctly use the
51 * nodeID. Using a static class instead of an Enum so we can add
52 * dynamically new types without changing anything in the
55 public static final class NodeIDType {
56 private static final ConcurrentHashMap<String, Class> compatibleType =
57 new ConcurrentHashMap<String, Class>();
59 * Identifier for an OpenFlow node
61 public static String OPENFLOW = "OF";
63 * Identifier for a PCEP node
65 public static String PCEP = "PE";
67 * Identifier for a ONEPK node
69 public static String ONEPK = "PK";
71 * Identifier for a node in a non-SDN network
73 public static String PRODUCTION = "PR";
75 // Pre-populated types, just here for convenience and ease of
76 // unit-testing, but certainly those could live also outside.
78 compatibleType.put(OPENFLOW, Long.class);
79 compatibleType.put(PCEP, UUID.class);
80 compatibleType.put(ONEPK, String.class);
81 compatibleType.put(PRODUCTION, String.class);
85 * Return the type of the class expected for the
86 * NodeID, it's used for validity check in the constructor
88 * @param nodeType the type of the node we want to check
91 * @return The Class which is supposed to instantiate the ID
94 public static Class<?> getClassType(String nodeType) {
95 return compatibleType.get(nodeType);
99 * Returns all the registered nodeIDTypes currently available
101 * @return The current registered NodeIDTypes
103 public static Set<String> values() {
104 return compatibleType.keySet();
108 * Register a new ID for which Node can be created
110 * @param type, the new type being registered
111 * @param compatibleID, the type of class to be accepted as ID
113 * @return true if registered, false otherwise
115 public static boolean registerIDType(String type,
116 Class compatibleID) {
117 if (compatibleType.get(type) != null) {
120 compatibleType.put(type, compatibleID);
126 * UNRegister a new ID for which Node can be created
128 * @param type, the type being UN-registered
131 public static void unRegisterIDType(String type) {
132 compatibleType.remove(type);
136 // This is the identity of the Node a (Type,ID) pair!, the full
137 // essence of this class.
138 private Object nodeID;
139 private String nodeType;
141 // Shadow value for unmarshalling
142 private String nodeIDString;
145 * Private constructor used for JAXB mapping
149 this.nodeType = null;
150 this.nodeIDString = null;
154 * Constructor for the Node objects, it validate the input so if
155 * the ID passed is not of the type expected accordingly to the
156 * type an exception is raised.
158 * @param nodeType Type of the node we are building
159 * @param id ID used by the SDN technology to identify the node
162 public Node(String nodeType, Object id) throws ConstructionException {
163 if (NodeIDType.getClassType(nodeType) != null &&
164 NodeIDType.getClassType(nodeType).isInstance(id)) {
165 this.nodeType = nodeType;
168 throw new ConstructionException("Type of incoming object:"
169 + id.getClass() + " not compatible with expected type:"
170 + NodeIDType.getClassType(nodeType));
175 * Copy Constructor for the Node objects.
177 * @param src type of nodes to copy from
180 public Node(Node src) throws ConstructionException {
182 this.nodeType = src.getType();
183 // Here we can reference the object because that is
184 // supposed to be an immutable identifier as well like a
185 // UUID/Integer and so on, hence no need to create a copy
187 this.nodeID = src.getID();
190 new ConstructionException("Null incoming object to copy from");
195 * getter for node type
198 * @return The node Type for this Node object
200 @XmlAttribute(name = "type")
201 public String getType() {
202 return this.nodeType;
206 * fill the current object from the string parameters passed, will
207 * be only used by JAXB
209 * @param typeStr string representing the type of the Node
210 * @param IDStr String representation of the ID
212 private void fillmeFromString(String typeStr, String IDStr) {
213 if (typeStr == null) {
221 this.nodeType = typeStr;
222 if (typeStr.equals(NodeIDType.OPENFLOW)) {
223 this.nodeID = Long.valueOf(HexEncode.stringToLong(IDStr));
224 } else if (typeStr.equals(NodeIDType.ONEPK)) {
226 } else if (typeStr.equals(NodeIDType.PCEP)) {
227 this.nodeID = UUID.fromString(IDStr);
228 } else if (typeStr.equals(NodeIDType.PRODUCTION)) {
231 // We need to lookup via OSGi service registry for an
237 * Private setter for nodeType to be called by JAXB not by anyone
238 * else, Node is immutable
240 * @param type of node to be set
242 private void setType(String type) {
243 this.nodeType = type;
244 if (this.nodeIDString != null) {
245 this.fillmeFromString(type, this.nodeIDString);
253 * @return The node ID for this Node object
255 public Object getID() {
260 * Getter for the node ID in string format
262 * @return The nodeID in string format
264 @XmlAttribute(name = "id")
265 public String getNodeIDString() {
266 if (this.nodeType.equals(NodeIDType.OPENFLOW)) {
267 return HexEncode.longToHexString((Long) this.nodeID);
269 return this.nodeID.toString();
274 * private setter to be used by JAXB
276 * @param nodeIDString String representation for NodeID
278 private void setNodeIDString(String nodeIDString) {
279 this.nodeIDString = nodeIDString;
280 if (this.nodeType != null) {
281 this.fillmeFromString(this.nodeType, nodeIDString);
286 public int hashCode() {
287 return new HashCodeBuilder(163841, 56473)
294 public boolean equals(Object obj) {
295 if (obj == null) { return false; }
296 if (obj == this) { return true; }
297 if (obj.getClass() != getClass()) {
300 Node rhs = (Node)obj;
301 return new EqualsBuilder()
302 .append(this.getType(), rhs.getType())
303 .append(this.getID(), rhs.getID())
308 public String toString() {
309 if (this.nodeType.equals(NodeIDType.OPENFLOW)) {
310 return this.nodeType.toString() + "|"
311 + HexEncode.longToHexString((Long) this.nodeID);
313 return this.nodeType.toString() + "|" + this.nodeID.toString();
318 * Static method to get back a Node from a string
320 * @param str string formatted in toString mode that can be
321 * converted back to a Node format.
323 * @return a Node if succed or null if no
325 public static Node fromString(String str) {
330 String parts[] = str.split("\\|");
331 if (parts.length != 2) {
332 // Try to guess from a String formatted as a long because
333 // for long time openflow has been prime citizen so lets
334 // keep this legacy for now
335 String numStr = str.toUpperCase();
337 Long ofNodeID = null;
338 if (numStr.startsWith("0X")) {
339 // Try as an hex number
341 BigInteger b = new BigInteger(
342 numStr.replaceFirst("0X", ""), 16);
343 ofNodeID = Long.valueOf(b.longValue());
344 } catch (Exception ex) {
348 // Try as a decimal number
350 BigInteger b = new BigInteger(numStr);
351 ofNodeID = Long.valueOf(b.longValue());
352 } catch (Exception ex) {
357 // Startegy #3 parse as HexLong
358 if (ofNodeID == null) {
360 ofNodeID = Long.valueOf(HexEncode.stringToLong(numStr));
361 } catch (Exception ex) {
366 // We ran out of ideas ... return null
367 if (ofNodeID == null) {
371 // Lets return the cooked up NodeID
373 return new Node(NodeIDType.OPENFLOW, ofNodeID);
374 } catch (ConstructionException ex) {
379 String typeStr = parts[0];
380 String IDStr = parts[1];
382 return fromString(typeStr, IDStr);
386 * Static method to get back a Node from a pair of strings, the
387 * first one being the Type representation, the second one being
388 * the ID string representation, expected to be heavily used in
391 * @param type, the type of the node we are parsing
392 * @param id, the string representation of the node id
394 * @return a Node if succed or null if no
396 public static Node fromString(String typeStr, String IDStr) {
397 if (typeStr == null) {
405 if (typeStr.equals(NodeIDType.OPENFLOW)) {
407 Long ID = Long.valueOf(HexEncode.stringToLong(IDStr));
408 return new Node(typeStr, ID);
409 } catch (Exception ex) {
412 } else if (typeStr.equals(NodeIDType.ONEPK)) {
414 return new Node(typeStr, IDStr);
415 } catch (Exception ex) {
418 } else if (typeStr.equals(NodeIDType.PCEP)) {
420 UUID ID = UUID.fromString(IDStr);
421 return new Node(typeStr, ID);
422 } catch (Exception ex) {
425 } else if (typeStr.equals(NodeIDType.PRODUCTION)) {
427 return new Node(typeStr, IDStr);
428 } catch (Exception ex) {
432 // We need to lookup via OSGi service registry for an