neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronFirewallRule.java

   1 /*
   2  * Copyright (C) 2015 Red Hat, Inc. and others.  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 java.io.Serializable;
  12 import java.util.Iterator;
  13 import java.util.List;
  14 import javax.xml.bind.annotation.XmlAccessType;
  15 import javax.xml.bind.annotation.XmlAccessorType;
  16 import javax.xml.bind.annotation.XmlElement;
  17 import javax.xml.bind.annotation.XmlRootElement;
  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  * The implemented fields are as follows:
  24  *
  25  * tenant_id               uuid-str
  26  * name                    String
  27  * admin_state_up          Bool
  28  * shared                  Bool
  29  * firewall_policy_id      uuid-str
  30  * protocol                String
  31  * ip_version              Integer
  32  * source_ip_address       String (IP addr or CIDR)
  33  * destination_ip_address  String (IP addr or CIDR)
  34  * source_port_range_min    Integer
  35  * source_port_range_max    Integer
  36  * destination_port_range_min Integer
  37  * destination_port_range_max Integer
  38  * position                Integer
  39  * action                  String
  40  * enabled                 Bool
  41  * id                      uuid-str
  42  * http://docs.openstack.org/api/openstack-network/2.0/openstack-network.pdf
  43  *
  44  */
  45
  46 @XmlRootElement
  47 @XmlAccessorType(XmlAccessType.NONE)
  48 public class NeutronFirewallRule extends NeutronObject<NeutronFirewallRule>
  49         implements Serializable, INeutronObject<NeutronFirewallRule> {
  50     private static final long serialVersionUID = 1L;
  51
  52     @XmlElement(name = "name")
  53     String firewallRuleName;
  54
  55     @XmlElement(defaultValue = "false", name = "shared")
  56     Boolean firewallRuleIsShared;
  57
  58     @XmlElement(name = "firewall_policy_id")
  59     String firewallRulePolicyID;
  60
  61     @XmlElement(name = "protocol")
  62     String firewallRuleProtocol;
  63
  64     @XmlElement(name = "ip_version")
  65     Integer firewallRuleIpVer;
  66
  67     @XmlElement(name = "source_ip_address")
  68     String firewallRuleSrcIpAddr;
  69
  70     @XmlElement(name = "destination_ip_address")
  71     String firewallRuleDstIpAddr;
  72
  73     @XmlElement(name = "source_port_range_min")
  74     Integer firewallRuleSrcPortRangeMin;
  75
  76     @XmlElement(name = "source_port_range_max")
  77     Integer firewallRuleSrcPortRangeMax;
  78
  79     @XmlElement(name = "destination_port_range_min")
  80     Integer firewallRuleDstPortRangeMin;
  81
  82     @XmlElement(name = "destination_port_range_max")
  83     Integer firewallRuleDstPortRangeMax;
  84
  85     @XmlElement(name = "position")
  86     Integer firewallRulePosition;
  87
  88     @XmlElement(name = "action")
  89     String firewallRuleAction;
  90
  91     @XmlElement(name = "enabled")
  92     Boolean firewallRuleIsEnabled;
  93
  94     public Boolean getFirewallRuleIsEnabled() {
  95         return firewallRuleIsEnabled;
  96     }
  97
  98     public void setFirewallRuleIsEnabled(Boolean firewallRuleIsEnabled) {
  99         this.firewallRuleIsEnabled = firewallRuleIsEnabled;
 100     }
 101
 102     public String getFirewallRuleAction() {
 103         return firewallRuleAction;
 104     }
 105
 106     public void setFirewallRuleAction(String firewallRuleAction) {
 107         this.firewallRuleAction = firewallRuleAction;
 108     }
 109
 110     public Integer getFirewallRulePosition() {
 111         return firewallRulePosition;
 112     }
 113
 114     public void setFirewallRulePosition(Integer firewallRulePosition) {
 115         this.firewallRulePosition = firewallRulePosition;
 116     }
 117
 118     public Integer getFirewallRuleDstPortRangeMin() {
 119         return firewallRuleDstPortRangeMin;
 120     }
 121
 122     public void setFirewallRuleDstPortRangeMin(Integer firewallRuleDstPortRangeMin) {
 123         this.firewallRuleDstPortRangeMin = firewallRuleDstPortRangeMin;
 124     }
 125
 126     public Integer getFirewallRuleDstPortRangeMax() {
 127         return firewallRuleDstPortRangeMax;
 128     }
 129
 130     public void setFirewallRuleDstPortRangeMax(Integer firewallRuleDstPortRangeMax) {
 131         this.firewallRuleDstPortRangeMax = firewallRuleDstPortRangeMax;
 132     }
 133
 134     public Integer getFirewallRuleSrcPortRangeMin() {
 135         return firewallRuleSrcPortRangeMin;
 136     }
 137
 138     public void setFirewallRuleSrcPortRangeMin(Integer firewallRuleSrcPortRangeMin) {
 139         this.firewallRuleSrcPortRangeMin = firewallRuleSrcPortRangeMin;
 140     }
 141
 142     public Integer getFirewallRuleSrcPortRangeMax() {
 143         return firewallRuleSrcPortRangeMax;
 144     }
 145
 146     public void setFirewallRuleSrcPortRangeMax(Integer firewallRuleSrcPortRangeMax) {
 147         this.firewallRuleSrcPortRangeMax = firewallRuleSrcPortRangeMax;
 148     }
 149
 150     public String getFirewallRuleDstIpAddr() {
 151         return firewallRuleDstIpAddr;
 152     }
 153
 154     public void setFirewallRuleDstIpAddr(String firewallRuleDstIpAddr) {
 155         this.firewallRuleDstIpAddr = firewallRuleDstIpAddr;
 156     }
 157
 158     public String getFirewallRuleSrcIpAddr() {
 159         return firewallRuleSrcIpAddr;
 160     }
 161
 162     public void setFirewallRuleSrcIpAddr(String firewallRuleSrcIpAddr) {
 163         this.firewallRuleSrcIpAddr = firewallRuleSrcIpAddr;
 164     }
 165
 166     public Integer getFirewallRuleIpVer() {
 167         return firewallRuleIpVer;
 168     }
 169
 170     public void setFirewallRuleIpVer(Integer firewallRuleIpVer) {
 171         this.firewallRuleIpVer = firewallRuleIpVer;
 172     }
 173
 174     public String getFirewallRuleProtocol() {
 175         return firewallRuleProtocol;
 176     }
 177
 178     public void setFirewallRuleProtocol(String firewallRuleProtocol) {
 179         this.firewallRuleProtocol = firewallRuleProtocol;
 180     }
 181
 182     public String getFirewallRulePolicyID() {
 183         return firewallRulePolicyID;
 184     }
 185
 186     public void setFirewallRulePolicyID(String firewallRulePolicyID) {
 187         this.firewallRulePolicyID = firewallRulePolicyID;
 188     }
 189
 190     public Boolean getFirewallRuleIsShared() {
 191         return firewallRuleIsShared;
 192     }
 193
 194     public void setFirewallRuleIsShared(Boolean firewallRuleIsShared) {
 195         this.firewallRuleIsShared = firewallRuleIsShared;
 196     }
 197
 198     public String getFirewallRuleName() {
 199         return firewallRuleName;
 200     }
 201
 202     public void setFirewallRuleName(String firewallRuleName) {
 203         this.firewallRuleName = firewallRuleName;
 204     }
 205
 206     public NeutronFirewallRule extractFields(List<String> fields) {
 207         NeutronFirewallRule ans = new NeutronFirewallRule();
 208         Iterator<String> i = fields.iterator();
 209         while (i.hasNext()) {
 210             String s = i.next();
 211             if (s.equals("id")) {
 212                 ans.setID(this.getID());
 213             }
 214             if (s.equals("tenant_id")) {
 215                 ans.setTenantID(this.getTenantID());
 216             }
 217             if (s.equals("name")) {
 218                 ans.setFirewallRuleName(this.getFirewallRuleName());
 219             }
 220             if (s.equals("shared")) {
 221                 ans.setFirewallRuleIsShared(firewallRuleIsShared);
 222             }
 223             if (s.equals("firewall_policy_id")) {
 224                 ans.setFirewallRulePolicyID(this.getFirewallRulePolicyID());
 225             }
 226             if (s.equals("protocol")) {
 227                 ans.setFirewallRuleProtocol(this.getFirewallRuleProtocol());
 228             }
 229             if (s.equals("source_ip_address")) {
 230                 ans.setFirewallRuleSrcIpAddr(this.getFirewallRuleSrcIpAddr());
 231             }
 232             if (s.equals("destination_ip_address")) {
 233                 ans.setFirewallRuleDstIpAddr(this.getFirewallRuleDstIpAddr());
 234             }
 235             if (s.equals("source_port_range_min")) {
 236                 ans.setFirewallRuleSrcPortRangeMin(this.getFirewallRuleSrcPortRangeMin());
 237             }
 238             if (s.equals("source_port_range_max")) {
 239                 ans.setFirewallRuleSrcPortRangeMax(this.getFirewallRuleSrcPortRangeMax());
 240             }
 241             if (s.equals("destination_port_range_min")) {
 242                 ans.setFirewallRuleDstPortRangeMin(this.getFirewallRuleDstPortRangeMin());
 243             }
 244             if (s.equals("destination_port_range_max")) {
 245                 ans.setFirewallRuleDstPortRangeMax(this.getFirewallRuleDstPortRangeMax());
 246             }
 247             if (s.equals("position")) {
 248                 ans.setFirewallRulePosition(this.getFirewallRulePosition());
 249             }
 250             if (s.equals("action")) {
 251                 ans.setFirewallRuleAction(this.getFirewallRuleAction());
 252             }
 253             if (s.equals("enabled")) {
 254                 ans.setFirewallRuleIsEnabled(firewallRuleIsEnabled);
 255             }
 256
 257         }
 258         return ans;
 259     }
 260
 261     @Override
 262     public String toString() {
 263         return "firewallPolicyRules{" + "firewallRuleUUID='" + uuid + '\'' + ", firewallRuleTenantID='" + tenantID
 264                 + '\'' + ", firewallRuleName='" + firewallRuleName + '\'' + ", firewallRuleIsShared="
 265                 + firewallRuleIsShared + ", firewallRulePolicyID=" + firewallRulePolicyID + ", firewallRuleProtocol='"
 266                 + firewallRuleProtocol + '\'' + ", firewallRuleIpVer=" + firewallRuleIpVer + ", firewallRuleSrcIpAddr='"
 267                 + firewallRuleSrcIpAddr + '\'' + ", firewallRuleDstIpAddr='" + firewallRuleDstIpAddr + '\''
 268                 + ", firewallRuleSrcPort=" + firewallRuleSrcPortRangeMin + ':' + firewallRuleSrcPortRangeMax
 269                 + ", firewallRuleDstPort=" + firewallRuleDstPortRangeMin + ':' + firewallRuleDstPortRangeMax
 270                 + ", firewallRulePosition=" + firewallRulePosition + ", firewallRuleAction='" + firewallRuleAction
 271                 + '\'' + ", firewallRuleIsEnabled=" + firewallRuleIsEnabled + '}';
 272     }
 273
 274     @Override
 275     public void initDefaults() {
 276     }
 277 }