opendaylight/networkconfiguration/neutron/src/main/java/org/opendaylight/controller/networkconfig/neutron/NeutronFirewallRule.java

   1 /*
   2  * Copyright (C) 2014 Red Hat, Inc.
   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.controller.networkconfig.neutron;
  10
  11 import org.opendaylight.controller.configuration.ConfigurationObject;
  12
  13 import javax.xml.bind.annotation.XmlAccessType;
  14 import javax.xml.bind.annotation.XmlAccessorType;
  15 import javax.xml.bind.annotation.XmlElement;
  16 import javax.xml.bind.annotation.XmlRootElement;
  17 import java.io.Serializable;
  18 import java.util.Iterator;
  19 import java.util.List;
  20
  21 /**
  22  * OpenStack Neutron v2.0 Firewall as a service
  23  * (FWaaS) bindings. See OpenStack Network API
  24  * v2.0 Reference for description of  the fields.
  25  * The implemented fields are as follows:
  26  *
  27  * tenant_id               uuid-str
  28  * name                    String
  29  * description             String
  30  * admin_state_up          Bool
  31  * status                  String
  32  * shared                  Bool
  33  * firewall_policy_id      uuid-str
  34  * protocol                String
  35  * ip_version              Integer
  36  * source_ip_address       String (IP addr or CIDR)
  37  * destination_ip_address  String (IP addr or CIDR)
  38  * source_port             Integer
  39  * destination_port        Integer
  40  * position                Integer
  41  * action                  String
  42  * enabled                 Bool
  43  * id                      uuid-str
  44  * http://docs.openstack.org/api/openstack-network/2.0/openstack-network.pdf
  45  */
  46
  47 @XmlRootElement
  48 @XmlAccessorType(XmlAccessType.NONE)
  49
  50 public class NeutronFirewallRule extends ConfigurationObject implements Serializable {
  51     private static final long serialVersionUID = 1L;
  52
  53     @XmlElement(name = "id")
  54     String firewallRuleUUID;
  55
  56     @XmlElement(name = "tenant_id")
  57     String firewallRuleTenantID;
  58
  59     @XmlElement(name = "name")
  60     String firewallRuleName;
  61
  62     @XmlElement(name = "description")
  63     String firewallRuleDescription;
  64
  65     @XmlElement(defaultValue = "true", name = "admin_state_up")
  66     Boolean firewallRuleAdminStateIsUp;
  67
  68     @XmlElement(name = "status")
  69     String firewallRuleStatus;
  70
  71     @XmlElement(defaultValue = "false", name = "shared")
  72     Boolean firewallRuleIsShared;
  73
  74     @XmlElement(name = "firewall_policy_id")
  75     String firewallRulePolicyID;
  76
  77     @XmlElement(name = "protocol")
  78     String firewallRuleProtocol;
  79
  80     @XmlElement(name = "ip_version")
  81     Integer firewallRuleIpVer;
  82
  83     @XmlElement(name = "source_ip_address")
  84     String firewallRuleSrcIpAddr;
  85
  86     @XmlElement(name = "destination_ip_address")
  87     String firewallRuleDstIpAddr;
  88
  89     @XmlElement(name = "source_port")
  90     Integer firewallRuleSrcPort;
  91
  92     @XmlElement(name = "destination_port")
  93     Integer firewallRuleDstPort;
  94
  95     @XmlElement(name = "position")
  96     Integer firewallRulePosition;
  97
  98     @XmlElement(name = "action")
  99     String firewallRuleAction;
 100
 101     @XmlElement(name = "enabled")
 102     Boolean firewallRuleIsEnabled;
 103
 104     public Boolean getFirewallRuleIsEnabled() {
 105         return firewallRuleIsEnabled;
 106     }
 107
 108     public void setFirewallRuleIsEnabled(Boolean firewallRuleIsEnabled) {
 109         this.firewallRuleIsEnabled = firewallRuleIsEnabled;
 110     }
 111
 112     public String getFirewallRuleAction() {
 113         return firewallRuleAction;
 114     }
 115
 116     public void setFirewallRuleAction(String firewallRuleAction) {
 117         this.firewallRuleAction = firewallRuleAction;
 118     }
 119
 120     public Integer getFirewallRulePosition() {
 121         return firewallRulePosition;
 122     }
 123
 124     public void setFirewallRulePosition(Integer firewallRulePosition) {
 125         this.firewallRulePosition = firewallRulePosition;
 126     }
 127
 128     public Integer getFirewallRuleDstPort() {
 129         return firewallRuleDstPort;
 130     }
 131
 132     public void setFirewallRuleDstPort(Integer firewallRuleDstPort) {
 133         this.firewallRuleDstPort = firewallRuleDstPort;
 134     }
 135
 136     public Integer getFirewallRuleSrcPort() {
 137         return firewallRuleSrcPort;
 138     }
 139
 140     public void setFirewallRuleSrcPort(Integer firewallRuleSrcPort) {
 141         this.firewallRuleSrcPort = firewallRuleSrcPort;
 142     }
 143
 144     public String getFirewallRuleDstIpAddr() {
 145         return firewallRuleDstIpAddr;
 146     }
 147
 148     public void setFirewallRuleDstIpAddr(String firewallRuleDstIpAddr) {
 149         this.firewallRuleDstIpAddr = firewallRuleDstIpAddr;
 150     }
 151
 152     public String getFirewallRuleSrcIpAddr() {
 153         return firewallRuleSrcIpAddr;
 154     }
 155
 156     public void setFirewallRuleSrcIpAddr(String firewallRuleSrcIpAddr) {
 157         this.firewallRuleSrcIpAddr = firewallRuleSrcIpAddr;
 158     }
 159
 160     public Integer getFirewallRuleIpVer() {
 161         return firewallRuleIpVer;
 162     }
 163
 164     public void setFirewallRuleIpVer(Integer firewallRuleIpVer) {
 165         this.firewallRuleIpVer = firewallRuleIpVer;
 166     }
 167
 168     public String getFirewallRuleProtocol() {
 169         return firewallRuleProtocol;
 170     }
 171
 172     public void setFirewallRuleProtocol(String firewallRuleProtocol) {
 173         this.firewallRuleProtocol = firewallRuleProtocol;
 174     }
 175
 176     public String getFirewallRulePolicyID() {
 177         return firewallRulePolicyID;
 178     }
 179
 180     public void setFirewallRulesPolicyID(String firewallRulePolicyID) {
 181         this.firewallRulePolicyID = firewallRulePolicyID;
 182     }
 183
 184     public Boolean getFirewallRuleIsShared() {
 185         return firewallRuleIsShared;
 186     }
 187
 188     public void setFirewallRuleIsShared(Boolean firewallRuleIsShared) {
 189         this.firewallRuleIsShared = firewallRuleIsShared;
 190     }
 191
 192     public String getFirewallRuleStatus() {
 193         return firewallRuleStatus;
 194     }
 195
 196     public void setFirewallRuleStatus(String firewallRuleStatus) {
 197         this.firewallRuleStatus = firewallRuleStatus;
 198     }
 199
 200     public Boolean getFirewallRuleAdminStateIsUp() {
 201         return firewallRuleAdminStateIsUp;
 202     }
 203
 204     public void setFirewallRuleAdminStateIsUp(Boolean firewallRuleAdminStateIsUp) {
 205         this.firewallRuleAdminStateIsUp = firewallRuleAdminStateIsUp;
 206     }
 207
 208     public String getFirewallRuleDescription() {
 209         return firewallRuleDescription;
 210     }
 211
 212     public void setFirewallRuleDescription(String firewallRuleDescription) {
 213         this.firewallRuleDescription = firewallRuleDescription;
 214     }
 215
 216     public String getFirewallRuleName() {
 217         return firewallRuleName;
 218     }
 219
 220     public void setFirewallRuleName(String firewallRuleName) {
 221         this.firewallRuleName = firewallRuleName;
 222     }
 223
 224     public String getFirewallRuleTenantID() {
 225         return firewallRuleTenantID;
 226     }
 227
 228     public void setFirewallRuleTenantID(String firewallRuleTenantID) {
 229         this.firewallRuleTenantID = firewallRuleTenantID;
 230     }
 231
 232     public String getFirewallRuleUUID() {
 233         return firewallRuleUUID;
 234     }
 235
 236     public void setFirewallRuleUUID(String firewallRuleUUID) {
 237         this.firewallRuleUUID = firewallRuleUUID;
 238     }
 239
 240     public NeutronFirewallRule extractFields(List<String> fields) {
 241         NeutronFirewallRule ans = new NeutronFirewallRule();
 242         Iterator<String> i = fields.iterator();
 243         while (i.hasNext()) {
 244             String s = i.next();
 245             if (s.equals("id")) {
 246                 ans.setFirewallRuleUUID(this.getFirewallRuleUUID());
 247             }
 248             if (s.equals("tenant_id")) {
 249                 ans.setFirewallRuleTenantID(this.getFirewallRuleTenantID());
 250             }
 251             if (s.equals("name")) {
 252                 ans.setFirewallRuleName(this.getFirewallRuleName());
 253             }
 254             if (s.equals("description")) {
 255                 ans.setFirewallRuleDescription(this.getFirewallRuleDescription());
 256             }
 257             if (s.equals("admin_state_up")) {
 258                 ans.setFirewallRuleAdminStateIsUp(firewallRuleAdminStateIsUp);
 259             }
 260             if (s.equals("status")) {
 261                 ans.setFirewallRuleStatus(this.getFirewallRuleStatus());
 262             }
 263             if (s.equals("shared")) {
 264                 ans.setFirewallRuleIsShared(firewallRuleIsShared);
 265             }
 266             if (s.equals("firewall_policy_id")) {
 267                 ans.setFirewallRulesPolicyID(this.getFirewallRulePolicyID());
 268             }
 269             if (s.equals("protocol")) {
 270                 ans.setFirewallRuleProtocol(this.getFirewallRuleProtocol());
 271             }
 272             if (s.equals("source_ip_address")) {
 273                 ans.setFirewallRuleSrcIpAddr(this.getFirewallRuleSrcIpAddr());
 274             }
 275             if (s.equals("destination_ip_address")) {
 276                 ans.setFirewallRuleDstIpAddr(this.getFirewallRuleDstIpAddr());
 277             }
 278             if (s.equals("source_port")) {
 279                 ans.setFirewallRuleSrcPort(this.getFirewallRuleSrcPort());
 280             }
 281             if (s.equals("destination_port")) {
 282                 ans.setFirewallRuleDstPort(this.getFirewallRuleDstPort());
 283             }
 284             if (s.equals("position")) {
 285                 ans.setFirewallRulePosition(this.getFirewallRulePosition());
 286             }
 287             if (s.equals("action")) {
 288                 ans.setFirewallRuleAction(this.getFirewallRuleAction());
 289             }
 290             if (s.equals("enabled")) {
 291                 ans.setFirewallRuleIsEnabled(firewallRuleIsEnabled);
 292             }
 293
 294         }
 295         return ans;
 296     }
 297
 298     @Override
 299     public String toString() {
 300         return "firewallPolicyRules{" +
 301             "firewallRuleUUID='" + firewallRuleUUID + '\'' +
 302             ", firewallRuleTenantID='" + firewallRuleTenantID + '\'' +
 303             ", firewallRuleName='" + firewallRuleName + '\'' +
 304             ", firewallRuleDescription='" + firewallRuleDescription + '\'' +
 305             ", firewallRuleAdminStateIsUp=" + firewallRuleAdminStateIsUp +
 306             ", firewallRuleStatus='" + firewallRuleStatus + '\'' +
 307             ", firewallRuleIsShared=" + firewallRuleIsShared +
 308             ", firewallRulePolicyID=" + firewallRulePolicyID +
 309             ", firewallRuleProtocol='" + firewallRuleProtocol + '\'' +
 310             ", firewallRuleIpVer=" + firewallRuleIpVer +
 311             ", firewallRuleSrcIpAddr='" + firewallRuleSrcIpAddr + '\'' +
 312             ", firewallRuleDstIpAddr='" + firewallRuleDstIpAddr + '\'' +
 313             ", firewallRuleSrcPort=" + firewallRuleSrcPort +
 314             ", firewallRuleDstPort=" + firewallRuleDstPort +
 315             ", firewallRulePosition=" + firewallRulePosition +
 316             ", firewallRuleAction='" + firewallRuleAction + '\'' +
 317             ", firewallRuleIsEnabled=" + firewallRuleIsEnabled +
 318             '}';
 319     }
 320
 321     public void initDefaults() {
 322     }
 323 }