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