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.XmlElement;
30 import javax.xml.bind.annotation.XmlRootElement;
32 import org.opendaylight.controller.sal.utils.HexEncode;
33 import org.opendaylight.controller.sal.utils.INodeFactory;
34 import org.opendaylight.controller.sal.utils.ServiceHelper;
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<? extends Object>> compatibleType =
57 new ConcurrentHashMap<String, Class<? extends Object>>();
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<? extends Object> 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 @XmlElement(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 //Use plugin's method to get appropriate conversion from IDStr to nodeID
232 INodeFactory f = (INodeFactory) ServiceHelper
233 .getGlobalInstance(INodeFactory.class, new Node(), "(protocolName="+typeStr+")");
235 Node n = f.fromString(typeStr, IDStr);
236 this.nodeID = n.nodeID;
242 * Private setter for nodeType to be called by JAXB not by anyone
243 * else, Node is immutable
245 * @param type of node to be set
247 @SuppressWarnings("unused")
248 private void setType(String type) {
249 this.nodeType = type;
250 if (this.nodeIDString != null) {
251 this.fillmeFromString(type, this.nodeIDString);
259 * @return The node ID for this Node object
261 public Object getID() {
266 * Getter for the node ID in string format
268 * @return The nodeID in string format
270 @XmlElement(name = "id")
271 public String getNodeIDString() {
272 if (this.nodeType.equals(NodeIDType.OPENFLOW)) {
273 return HexEncode.longToHexString((Long) this.nodeID);
275 return this.nodeID.toString();
280 * private setter to be used by JAXB
282 * @param nodeIDString String representation for NodeID
284 @SuppressWarnings("unused")
285 private void setNodeIDString(String nodeIDString) {
286 this.nodeIDString = nodeIDString;
287 if (this.nodeType != null) {
288 this.fillmeFromString(this.nodeType, nodeIDString);
293 public int hashCode() {
294 final int prime = 31;
296 result = prime * result + ((nodeID == null) ? 0 : nodeID.hashCode());
297 result = prime * result
298 + ((nodeType == null) ? 0 : nodeType.hashCode());
303 public boolean equals(Object obj) {
308 if (getClass() != obj.getClass())
310 Node other = (Node) obj;
311 if (nodeID == null) {
312 if (other.nodeID != null)
314 } else if (!nodeID.equals(other.nodeID))
316 if (nodeType == null) {
317 if (other.nodeType != null)
319 } else if (!nodeType.equals(other.nodeType))
325 public String toString() {
326 if (this.nodeType.equals(NodeIDType.OPENFLOW)) {
327 return this.nodeType + "|"
328 + HexEncode.longToHexString((Long) this.nodeID);
330 return this.nodeType + "|" + this.nodeID.toString();
335 * Static method to get back a Node from a string
337 * @param str string formatted in toString mode that can be
338 * converted back to a Node format.
340 * @return a Node if succed or null if no
342 public static Node fromString(String str) {
347 String parts[] = str.split("\\|");
348 if (parts.length != 2) {
349 // Try to guess from a String formatted as a long because
350 // for long time openflow has been prime citizen so lets
351 // keep this legacy for now
352 String numStr = str.toUpperCase();
354 Long ofNodeID = null;
355 if (numStr.startsWith("0X")) {
356 // Try as an hex number
358 BigInteger b = new BigInteger(
359 numStr.replaceFirst("0X", ""), 16);
360 ofNodeID = Long.valueOf(b.longValue());
361 } catch (Exception ex) {
365 // Try as a decimal number
367 BigInteger b = new BigInteger(numStr);
368 ofNodeID = Long.valueOf(b.longValue());
369 } catch (Exception ex) {
374 // Startegy #3 parse as HexLong
375 if (ofNodeID == null) {
377 ofNodeID = Long.valueOf(HexEncode.stringToLong(numStr));
378 } catch (Exception ex) {
383 // We ran out of ideas ... return null
384 if (ofNodeID == null) {
388 // Lets return the cooked up NodeID
390 return new Node(NodeIDType.OPENFLOW, ofNodeID);
391 } catch (ConstructionException ex) {
396 String typeStr = parts[0];
397 String IDStr = parts[1];
399 return fromString(typeStr, IDStr);
403 * Static method to get back a Node from a pair of strings, the
404 * first one being the Type representation, the second one being
405 * the ID string representation, expected to be heavily used in
408 * @param type, the type of the node we are parsing
409 * @param id, the string representation of the node id
411 * @return a Node if succed or null if no
413 public static Node fromString(String typeStr, String IDStr) {
414 if (typeStr == null) {
422 if (typeStr.equals(NodeIDType.OPENFLOW)) {
424 Long ID = Long.valueOf(HexEncode.stringToLong(IDStr));
425 return new Node(typeStr, ID);
426 } catch (Exception ex) {
429 } else if (typeStr.equals(NodeIDType.ONEPK)) {
431 return new Node(typeStr, IDStr);
432 } catch (Exception ex) {
435 } else if (typeStr.equals(NodeIDType.PCEP)) {
437 UUID ID = UUID.fromString(IDStr);
438 return new Node(typeStr, ID);
439 } catch (Exception ex) {
442 } else if (typeStr.equals(NodeIDType.PRODUCTION)) {
444 return new Node(typeStr, IDStr);
445 } catch (Exception ex) {
449 //Use INodeFactory to create a Node of registered Node type.
450 //The protocol plugin being used depends on typeStr.
451 INodeFactory f = (INodeFactory) ServiceHelper
452 .getGlobalInstance(INodeFactory.class, new Node(), "(protocolName="+typeStr+")");
455 return f.fromString(typeStr, IDStr);