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.List;
  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
  18 /**
  19  * OpenStack Neutron v2.0 Firewall as a service
  20  * (FWaaS) bindings. See OpenStack Network API
  21  * v2.0 Reference for description of  the fields.
  22  * The implemented fields are as follows:
  23  *
  24  * <p>
  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 final class NeutronFirewallRule extends NeutronBaseAttributes<NeutronFirewallRule> implements Serializable {
  49     private static final long serialVersionUID = 1L;
  50
  51     @XmlElement(defaultValue = "false", name = "shared")
  52     Boolean firewallRuleIsShared;
  53
  54     @XmlElement(name = "firewall_policy_id")
  55     String firewallRulePolicyID;
  56
  57     @XmlElement(name = "protocol")
  58     String firewallRuleProtocol;
  59
  60     @XmlElement(name = "ip_version")
  61     Integer firewallRuleIpVer;
  62
  63     @XmlElement(name = "source_ip_address")
  64     String firewallRuleSrcIpAddr;
  65
  66     @XmlElement(name = "destination_ip_address")
  67     String firewallRuleDstIpAddr;
  68
  69     @XmlElement(name = "source_port_range_min")
  70     Integer firewallRuleSrcPortRangeMin;
  71
  72     @XmlElement(name = "source_port_range_max")
  73     Integer firewallRuleSrcPortRangeMax;
  74
  75     @XmlElement(name = "destination_port_range_min")
  76     Integer firewallRuleDstPortRangeMin;
  77
  78     @XmlElement(name = "destination_port_range_max")
  79     Integer firewallRuleDstPortRangeMax;
  80
  81     @XmlElement(name = "position")
  82     Integer firewallRulePosition;
  83
  84     @XmlElement(name = "action")
  85     String firewallRuleAction;
  86
  87     @XmlElement(name = "enabled")
  88     Boolean firewallRuleIsEnabled;
  89
  90     public Boolean getFirewallRuleIsEnabled() {
  91         return firewallRuleIsEnabled;
  92     }
  93
  94     public void setFirewallRuleIsEnabled(Boolean firewallRuleIsEnabled) {
  95         this.firewallRuleIsEnabled = firewallRuleIsEnabled;
  96     }
  97
  98     public String getFirewallRuleAction() {
  99         return firewallRuleAction;
 100     }
 101
 102     public void setFirewallRuleAction(String firewallRuleAction) {
 103         this.firewallRuleAction = firewallRuleAction;
 104     }
 105
 106     public Integer getFirewallRulePosition() {
 107         return firewallRulePosition;
 108     }
 109
 110     public void setFirewallRulePosition(Integer firewallRulePosition) {
 111         this.firewallRulePosition = firewallRulePosition;
 112     }
 113
 114     public Integer getFirewallRuleDstPortRangeMin() {
 115         return firewallRuleDstPortRangeMin;
 116     }
 117
 118     public void setFirewallRuleDstPortRangeMin(Integer firewallRuleDstPortRangeMin) {
 119         this.firewallRuleDstPortRangeMin = firewallRuleDstPortRangeMin;
 120     }
 121
 122     public Integer getFirewallRuleDstPortRangeMax() {
 123         return firewallRuleDstPortRangeMax;
 124     }
 125
 126     public void setFirewallRuleDstPortRangeMax(Integer firewallRuleDstPortRangeMax) {
 127         this.firewallRuleDstPortRangeMax = firewallRuleDstPortRangeMax;
 128     }
 129
 130     public Integer getFirewallRuleSrcPortRangeMin() {
 131         return firewallRuleSrcPortRangeMin;
 132     }
 133
 134     public void setFirewallRuleSrcPortRangeMin(Integer firewallRuleSrcPortRangeMin) {
 135         this.firewallRuleSrcPortRangeMin = firewallRuleSrcPortRangeMin;
 136     }
 137
 138     public Integer getFirewallRuleSrcPortRangeMax() {
 139         return firewallRuleSrcPortRangeMax;
 140     }
 141
 142     public void setFirewallRuleSrcPortRangeMax(Integer firewallRuleSrcPortRangeMax) {
 143         this.firewallRuleSrcPortRangeMax = firewallRuleSrcPortRangeMax;
 144     }
 145
 146     public String getFirewallRuleDstIpAddr() {
 147         return firewallRuleDstIpAddr;
 148     }
 149
 150     public void setFirewallRuleDstIpAddr(String firewallRuleDstIpAddr) {
 151         this.firewallRuleDstIpAddr = firewallRuleDstIpAddr;
 152     }
 153
 154     public String getFirewallRuleSrcIpAddr() {
 155         return firewallRuleSrcIpAddr;
 156     }
 157
 158     public void setFirewallRuleSrcIpAddr(String firewallRuleSrcIpAddr) {
 159         this.firewallRuleSrcIpAddr = firewallRuleSrcIpAddr;
 160     }
 161
 162     public Integer getFirewallRuleIpVer() {
 163         return firewallRuleIpVer;
 164     }
 165
 166     public void setFirewallRuleIpVer(Integer firewallRuleIpVer) {
 167         this.firewallRuleIpVer = firewallRuleIpVer;
 168     }
 169
 170     public String getFirewallRuleProtocol() {
 171         return firewallRuleProtocol;
 172     }
 173
 174     public void setFirewallRuleProtocol(String firewallRuleProtocol) {
 175         this.firewallRuleProtocol = firewallRuleProtocol;
 176     }
 177
 178     public String getFirewallRulePolicyID() {
 179         return firewallRulePolicyID;
 180     }
 181
 182     public void setFirewallRulePolicyID(String firewallRulePolicyID) {
 183         this.firewallRulePolicyID = firewallRulePolicyID;
 184     }
 185
 186     public Boolean getFirewallRuleIsShared() {
 187         return firewallRuleIsShared;
 188     }
 189
 190     public void setFirewallRuleIsShared(Boolean firewallRuleIsShared) {
 191         this.firewallRuleIsShared = firewallRuleIsShared;
 192     }
 193
 194     public NeutronFirewallRule extractFields(List<String> fields) {
 195         NeutronFirewallRule ans = new NeutronFirewallRule();
 196         for (String s : fields) {
 197             extractField(s, ans);
 198             if (s.equals("shared")) {
 199                 ans.setFirewallRuleIsShared(firewallRuleIsShared);
 200             }
 201             if (s.equals("firewall_policy_id")) {
 202                 ans.setFirewallRulePolicyID(this.getFirewallRulePolicyID());
 203             }
 204             if (s.equals("protocol")) {
 205                 ans.setFirewallRuleProtocol(this.getFirewallRuleProtocol());
 206             }
 207             if (s.equals("source_ip_address")) {
 208                 ans.setFirewallRuleSrcIpAddr(this.getFirewallRuleSrcIpAddr());
 209             }
 210             if (s.equals("destination_ip_address")) {
 211                 ans.setFirewallRuleDstIpAddr(this.getFirewallRuleDstIpAddr());
 212             }
 213             if (s.equals("source_port_range_min")) {
 214                 ans.setFirewallRuleSrcPortRangeMin(this.getFirewallRuleSrcPortRangeMin());
 215             }
 216             if (s.equals("source_port_range_max")) {
 217                 ans.setFirewallRuleSrcPortRangeMax(this.getFirewallRuleSrcPortRangeMax());
 218             }
 219             if (s.equals("destination_port_range_min")) {
 220                 ans.setFirewallRuleDstPortRangeMin(this.getFirewallRuleDstPortRangeMin());
 221             }
 222             if (s.equals("destination_port_range_max")) {
 223                 ans.setFirewallRuleDstPortRangeMax(this.getFirewallRuleDstPortRangeMax());
 224             }
 225             if (s.equals("position")) {
 226                 ans.setFirewallRulePosition(this.getFirewallRulePosition());
 227             }
 228             if (s.equals("action")) {
 229                 ans.setFirewallRuleAction(this.getFirewallRuleAction());
 230             }
 231             if (s.equals("enabled")) {
 232                 ans.setFirewallRuleIsEnabled(firewallRuleIsEnabled);
 233             }
 234
 235         }
 236         return ans;
 237     }
 238
 239     @Override
 240     public String toString() {
 241         return "firewallPolicyRules{" + "firewallRuleUUID='" + uuid + '\'' + ", firewallRuleTenantID='" + tenantID
 242                 + '\'' + ", firewallRuleName='" + name + '\'' + ", firewallRuleIsShared="
 243                 + firewallRuleIsShared + ", firewallRulePolicyID=" + firewallRulePolicyID + ", firewallRuleProtocol='"
 244                 + firewallRuleProtocol + '\'' + ", firewallRuleIpVer=" + firewallRuleIpVer + ", firewallRuleSrcIpAddr='"
 245                 + firewallRuleSrcIpAddr + '\'' + ", firewallRuleDstIpAddr='" + firewallRuleDstIpAddr + '\''
 246                 + ", firewallRuleSrcPort=" + firewallRuleSrcPortRangeMin + ':' + firewallRuleSrcPortRangeMax
 247                 + ", firewallRuleDstPort=" + firewallRuleDstPortRangeMin + ':' + firewallRuleDstPortRangeMax
 248                 + ", firewallRulePosition=" + firewallRulePosition + ", firewallRuleAction='" + firewallRuleAction
 249                 + '\'' + ", firewallRuleIsEnabled=" + firewallRuleIsEnabled + '}';
 250     }
 251
 252     @Override
 253     public void initDefaults() {
 254     }
 255 }