neutron-spi: Introduce base class for Neutron object
[neutron.git] / neutron-spi / src / main / java / org / opendaylight / neutron / spi / NeutronFirewall.java
1 /*
2  * Copyright (C) 2014 Red Hat, Inc.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8
9 package org.opendaylight.neutron.spi;
10
11 import javax.xml.bind.annotation.XmlAccessType;
12 import javax.xml.bind.annotation.XmlAccessorType;
13 import javax.xml.bind.annotation.XmlElement;
14 import javax.xml.bind.annotation.XmlRootElement;
15 import java.io.Serializable;
16 import java.util.Iterator;
17 import java.util.List;
18
19 /**
20  * OpenStack Neutron v2.0 Firewall as a service
21  * (FWaaS) bindings. See OpenStack Network API
22  * v2.0 Reference for description of  the fields:
23  * Implemented fields are as follows:
24  *
25  * id                 uuid-str
26  * tenant_id          uuid-str
27  * name               String
28  * description        String
29  * admin_state_up     Bool
30  * status             String
31  * shared             Bool
32  * firewall_policy_id uuid-str
33  * http://docs.openstack.org/api/openstack-network/2.0/openstack-network.pdf
34  *
35  */
36
37 @XmlRootElement
38 @XmlAccessorType(XmlAccessType.NONE)
39
40 public class NeutronFirewall extends NeutronObject implements Serializable, INeutronObject {
41     private static final long serialVersionUID = 1L;
42
43     @XmlElement (name = "name")
44     String firewallName;
45
46     @XmlElement (name = "description")
47     String firewallDescription;
48
49     @XmlElement (defaultValue = "true", name = "admin_state_up")
50     Boolean firewallAdminStateIsUp;
51
52     @XmlElement (name = "status")
53     String firewallStatus;
54
55     @XmlElement (defaultValue = "false", name = "shared")
56     Boolean firewallIsShared;
57
58     @XmlElement (name = "firewall_policy_id")
59     String neutronFirewallPolicyID;
60
61     // @deprecated use getID()
62     public String getFirewallUUID() {
63         return getID();
64     }
65
66     // @deprecated use setID()
67     public void setFirewallUUID(String uuid) {
68         setID(uuid);
69     }
70
71     @Deprecated
72     public String getFirewallTenantID() {
73         return getTenantID();
74     }
75
76     @Deprecated
77     public void setFirewallTenantID(String tenantID) {
78         setTenantID(tenantID);
79     }
80
81     public String getFirewallName() {
82         return firewallName;
83     }
84
85     public void setFirewallName(String firewallName) {
86         this.firewallName = firewallName;
87     }
88
89     public String getFirewallDescription() {
90         return firewallDescription;
91     }
92
93     public void setFirewallDescription(String firewallDescription) {
94         this.firewallDescription = firewallDescription;
95     }
96
97     public Boolean getFirewallAdminStateIsUp() {
98         return firewallAdminStateIsUp;
99     }
100
101     public void setFirewallAdminStateIsUp(Boolean firewallAdminStateIsUp) {
102         this.firewallAdminStateIsUp = firewallAdminStateIsUp;
103     }
104
105     public String getFirewallStatus() {
106         return firewallStatus;
107     }
108
109     public void setFirewallStatus(String firewallStatus) {
110         this.firewallStatus = firewallStatus;
111     }
112
113     public Boolean getFirewallIsShared() {
114         return firewallIsShared;
115     }
116
117     public void setFirewallIsShared(Boolean firewallIsShared) {
118         this.firewallIsShared = firewallIsShared;
119     }
120
121     public String getFirewallPolicyID() {
122         return neutronFirewallPolicyID;
123     }
124
125     public void setFirewallPolicyID(String firewallPolicy) {
126         this.neutronFirewallPolicyID = firewallPolicy;
127     }
128
129     public NeutronFirewall extractFields(List<String> fields) {
130         NeutronFirewall ans = new NeutronFirewall();
131         Iterator<String> i = fields.iterator();
132         while (i.hasNext()) {
133             String s = i.next();
134             if (s.equals("id")) {
135                 ans.setID(this.getID());
136             }
137             if (s.equals("tenant_id")) {
138                 ans.setTenantID(this.getTenantID());
139             }
140             if (s.equals("name")) {
141                 ans.setFirewallName(this.getFirewallName());
142             }
143             if(s.equals("description")) {
144                 ans.setFirewallDescription(this.getFirewallDescription());
145             }
146             if (s.equals("admin_state_up")) {
147                 ans.setFirewallAdminStateIsUp(firewallAdminStateIsUp);
148             }
149             if (s.equals("status")) {
150                 ans.setFirewallStatus(this.getFirewallStatus());
151             }
152             if (s.equals("shared")) {
153                 ans.setFirewallIsShared(firewallIsShared);
154             }
155             if (s.equals("firewall_policy_id")) {
156                 ans.setFirewallPolicyID(this.getFirewallPolicyID());
157             }
158         }
159         return ans;
160     }
161
162     @Override
163     public String toString() {
164         return "NeutronFirewall{" +
165             "firewallUUID='" + uuid + '\'' +
166             ", firewallTenantID='" + tenantID + '\'' +
167             ", firewallName='" + firewallName + '\'' +
168             ", firewallDescription='" + firewallDescription + '\'' +
169             ", firewallAdminStateIsUp=" + firewallAdminStateIsUp +
170             ", firewallStatus='" + firewallStatus + '\'' +
171             ", firewallIsShared=" + firewallIsShared +
172             ", firewallRulePolicyID=" + neutronFirewallPolicyID +
173             '}';
174     }
175 }