Jonathan Hart | 23701d1 | 2014-04-03 10:45:48 -0700 | [diff] [blame] | 1 | package net.onrc.onos.core.util; |
Pavlin Radoslavov | a2d35f1 | 2013-10-17 16:46:39 -0700 | [diff] [blame] | 2 | |
3 | import org.codehaus.jackson.annotate.JsonProperty; | ||||
4 | |||||
5 | /** | ||||
6 | * The class representing a Switch. | ||||
7 | * NOTE: Currently this class is (almost) not used. | ||||
8 | */ | ||||
9 | public class Switch { | ||||
Pavlin Radoslavov | 8a6912a | 2013-10-25 15:28:11 -0700 | [diff] [blame] | 10 | /** |
11 | * The Switch state. | ||||
12 | */ | ||||
Pavlin Radoslavov | a2d35f1 | 2013-10-17 16:46:39 -0700 | [diff] [blame] | 13 | public enum SwitchState { |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 14 | INACTIVE, |
15 | ACTIVE, | ||||
Pavlin Radoslavov | a2d35f1 | 2013-10-17 16:46:39 -0700 | [diff] [blame] | 16 | } |
17 | |||||
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 18 | private Dpid dpid; // The DPID of the switch |
19 | private SwitchState state; // The state of the switch | ||||
Pavlin Radoslavov | a2d35f1 | 2013-10-17 16:46:39 -0700 | [diff] [blame] | 20 | |
21 | /** | ||||
22 | * Default constructor. | ||||
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 23 | * <p/> |
Pavlin Radoslavov | ffc5bbc | 2013-10-17 18:23:20 -0700 | [diff] [blame] | 24 | * NOTE: The default state for the switch is INACTIVE. |
Pavlin Radoslavov | a2d35f1 | 2013-10-17 16:46:39 -0700 | [diff] [blame] | 25 | */ |
26 | public Switch() { | ||||
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 27 | this.dpid = new Dpid(); |
28 | this.state = SwitchState.INACTIVE; | ||||
Pavlin Radoslavov | a2d35f1 | 2013-10-17 16:46:39 -0700 | [diff] [blame] | 29 | } |
30 | |||||
31 | /** | ||||
Pavlin Radoslavov | ffc5bbc | 2013-10-17 18:23:20 -0700 | [diff] [blame] | 32 | * Constructor for a given DPID. |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 33 | * <p/> |
Pavlin Radoslavov | ffc5bbc | 2013-10-17 18:23:20 -0700 | [diff] [blame] | 34 | * NOTE: The state for the switch with a given DPID is ACTIVE. |
Pavlin Radoslavov | a2d35f1 | 2013-10-17 16:46:39 -0700 | [diff] [blame] | 35 | * |
Pavlin Radoslavov | ffc5bbc | 2013-10-17 18:23:20 -0700 | [diff] [blame] | 36 | * @param dpid the DPID to use. |
Pavlin Radoslavov | a2d35f1 | 2013-10-17 16:46:39 -0700 | [diff] [blame] | 37 | */ |
Pavlin Radoslavov | ffc5bbc | 2013-10-17 18:23:20 -0700 | [diff] [blame] | 38 | public Switch(Dpid dpid) { |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 39 | this.dpid = dpid; |
40 | this.state = SwitchState.ACTIVE; | ||||
Pavlin Radoslavov | a2d35f1 | 2013-10-17 16:46:39 -0700 | [diff] [blame] | 41 | } |
42 | |||||
43 | /** | ||||
Pavlin Radoslavov | ffc5bbc | 2013-10-17 18:23:20 -0700 | [diff] [blame] | 44 | * Constructor for a given DPID and Switch State. |
Pavlin Radoslavov | a2d35f1 | 2013-10-17 16:46:39 -0700 | [diff] [blame] | 45 | * |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 46 | * @param dpid the DPID to use. |
Pavlin Radoslavov | ffc5bbc | 2013-10-17 18:23:20 -0700 | [diff] [blame] | 47 | * @param state the Switch State to use. |
Pavlin Radoslavov | a2d35f1 | 2013-10-17 16:46:39 -0700 | [diff] [blame] | 48 | */ |
Pavlin Radoslavov | ffc5bbc | 2013-10-17 18:23:20 -0700 | [diff] [blame] | 49 | public Switch(Dpid dpid, SwitchState state) { |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 50 | this.dpid = dpid; |
51 | this.state = state; | ||||
Pavlin Radoslavov | a2d35f1 | 2013-10-17 16:46:39 -0700 | [diff] [blame] | 52 | } |
53 | |||||
54 | /** | ||||
55 | * Get the DPID. | ||||
56 | * | ||||
57 | * @return the DPID. | ||||
58 | */ | ||||
59 | @JsonProperty("dpid") | ||||
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 60 | public Dpid dpid() { |
61 | return dpid; | ||||
62 | } | ||||
Pavlin Radoslavov | a2d35f1 | 2013-10-17 16:46:39 -0700 | [diff] [blame] | 63 | |
64 | /** | ||||
65 | * Set the DPID. | ||||
66 | * | ||||
67 | * @param dpid the DPID to use. | ||||
68 | */ | ||||
69 | @JsonProperty("dpid") | ||||
Pavlin Radoslavov | ffc5bbc | 2013-10-17 18:23:20 -0700 | [diff] [blame] | 70 | public void setDpid(Dpid dpid) { |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 71 | this.dpid = dpid; |
Pavlin Radoslavov | a2d35f1 | 2013-10-17 16:46:39 -0700 | [diff] [blame] | 72 | } |
73 | |||||
74 | /** | ||||
Pavlin Radoslavov | ffc5bbc | 2013-10-17 18:23:20 -0700 | [diff] [blame] | 75 | * Get the state. |
76 | * | ||||
77 | * @return the state. | ||||
78 | */ | ||||
79 | @JsonProperty("state") | ||||
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 80 | public SwitchState state() { |
81 | return state; | ||||
82 | } | ||||
Pavlin Radoslavov | ffc5bbc | 2013-10-17 18:23:20 -0700 | [diff] [blame] | 83 | |
84 | /** | ||||
85 | * Set the state. | ||||
86 | * | ||||
87 | * @param state the state to use. | ||||
88 | */ | ||||
89 | @JsonProperty("state") | ||||
90 | public void setState(SwitchState state) { | ||||
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 91 | this.state = state; |
Pavlin Radoslavov | ffc5bbc | 2013-10-17 18:23:20 -0700 | [diff] [blame] | 92 | } |
93 | |||||
94 | /** | ||||
95 | * Set the Switch State to ACTIVE. | ||||
96 | */ | ||||
97 | public void setStateActive() { | ||||
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 98 | this.state = SwitchState.ACTIVE; |
Pavlin Radoslavov | ffc5bbc | 2013-10-17 18:23:20 -0700 | [diff] [blame] | 99 | } |
100 | |||||
101 | /** | ||||
102 | * Set the Switch State to INACTIVE. | ||||
103 | */ | ||||
104 | public void setStateInactive() { | ||||
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 105 | this.state = SwitchState.INACTIVE; |
Pavlin Radoslavov | ffc5bbc | 2013-10-17 18:23:20 -0700 | [diff] [blame] | 106 | } |
107 | |||||
108 | /** | ||||
Pavlin Radoslavov | a2d35f1 | 2013-10-17 16:46:39 -0700 | [diff] [blame] | 109 | * Convert the Switch value to a string. |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 110 | * <p/> |
Pavlin Radoslavov | a2d35f1 | 2013-10-17 16:46:39 -0700 | [diff] [blame] | 111 | * The string has the following form: |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 112 | * dpid/state |
Pavlin Radoslavov | a2d35f1 | 2013-10-17 16:46:39 -0700 | [diff] [blame] | 113 | * |
114 | * @return the Switch value as a string. | ||||
115 | */ | ||||
116 | @Override | ||||
117 | public String toString() { | ||||
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 118 | return this.dpid.toString() + "/" + this.state.toString(); |
Pavlin Radoslavov | a2d35f1 | 2013-10-17 16:46:39 -0700 | [diff] [blame] | 119 | } |
120 | } |