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 { |
| 14 | INACTIVE, |
| 15 | ACTIVE, |
| 16 | } |
| 17 | |
Pavlin Radoslavov | ffc5bbc | 2013-10-17 18:23:20 -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. |
Pavlin Radoslavov | ffc5bbc | 2013-10-17 18:23:20 -0700 | [diff] [blame] | 23 | * |
| 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() { |
Pavlin Radoslavov | ffc5bbc | 2013-10-17 18:23:20 -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. |
Pavlin Radoslavov | a2d35f1 | 2013-10-17 16:46:39 -0700 | [diff] [blame] | 33 | * |
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) { |
| 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 | * |
Pavlin Radoslavov | ffc5bbc | 2013-10-17 18:23:20 -0700 | [diff] [blame] | 46 | * @param dpid the DPID to use. |
| 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) { |
| 50 | this.dpid = dpid; |
Pavlin Radoslavov | a2d35f1 | 2013-10-17 16:46:39 -0700 | [diff] [blame] | 51 | this.state = state; |
| 52 | } |
| 53 | |
| 54 | /** |
| 55 | * Get the DPID. |
| 56 | * |
| 57 | * @return the DPID. |
| 58 | */ |
| 59 | @JsonProperty("dpid") |
Pavlin Radoslavov | ffc5bbc | 2013-10-17 18:23:20 -0700 | [diff] [blame] | 60 | public Dpid dpid() { return dpid; } |
Pavlin Radoslavov | a2d35f1 | 2013-10-17 16:46:39 -0700 | [diff] [blame] | 61 | |
| 62 | /** |
| 63 | * Set the DPID. |
| 64 | * |
| 65 | * @param dpid the DPID to use. |
| 66 | */ |
| 67 | @JsonProperty("dpid") |
Pavlin Radoslavov | ffc5bbc | 2013-10-17 18:23:20 -0700 | [diff] [blame] | 68 | public void setDpid(Dpid dpid) { |
Pavlin Radoslavov | a2d35f1 | 2013-10-17 16:46:39 -0700 | [diff] [blame] | 69 | this.dpid = dpid; |
| 70 | } |
| 71 | |
| 72 | /** |
Pavlin Radoslavov | ffc5bbc | 2013-10-17 18:23:20 -0700 | [diff] [blame] | 73 | * Get the state. |
| 74 | * |
| 75 | * @return the state. |
| 76 | */ |
| 77 | @JsonProperty("state") |
| 78 | public SwitchState state() { return state; } |
| 79 | |
| 80 | /** |
| 81 | * Set the state. |
| 82 | * |
| 83 | * @param state the state to use. |
| 84 | */ |
| 85 | @JsonProperty("state") |
| 86 | public void setState(SwitchState state) { |
| 87 | this.state = state; |
| 88 | } |
| 89 | |
| 90 | /** |
| 91 | * Set the Switch State to ACTIVE. |
| 92 | */ |
| 93 | public void setStateActive() { |
| 94 | this.state = SwitchState.ACTIVE; |
| 95 | } |
| 96 | |
| 97 | /** |
| 98 | * Set the Switch State to INACTIVE. |
| 99 | */ |
| 100 | public void setStateInactive() { |
| 101 | this.state = SwitchState.INACTIVE; |
| 102 | } |
| 103 | |
| 104 | /** |
Pavlin Radoslavov | a2d35f1 | 2013-10-17 16:46:39 -0700 | [diff] [blame] | 105 | * Convert the Switch value to a string. |
| 106 | * |
| 107 | * The string has the following form: |
Pavlin Radoslavov | ffc5bbc | 2013-10-17 18:23:20 -0700 | [diff] [blame] | 108 | * dpid/state |
Pavlin Radoslavov | a2d35f1 | 2013-10-17 16:46:39 -0700 | [diff] [blame] | 109 | * |
| 110 | * @return the Switch value as a string. |
| 111 | */ |
| 112 | @Override |
| 113 | public String toString() { |
Pavlin Radoslavov | ffc5bbc | 2013-10-17 18:23:20 -0700 | [diff] [blame] | 114 | return this.dpid.toString() + "/" + this.state.toString(); |
Pavlin Radoslavov | a2d35f1 | 2013-10-17 16:46:39 -0700 | [diff] [blame] | 115 | } |
| 116 | } |