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 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
  16 /**
  17  * OpenStack Neutron v2.0 Firewall as a service
  18  * (FWaaS) bindings. See OpenStack Network API
  19  * v2.0 Reference for description of  the fields.
  20  * The implemented fields are as follows:
  21  *
  22  * <p>
  23  * tenant_id               uuid-str
  24  * name                    String
  25  * admin_state_up          Bool
  26  * shared                  Bool
  27  * firewall_policy_id      uuid-str
  28  * protocol                String
  29  * ip_version              Integer
  30  * source_ip_address       String (IP addr or CIDR)
  31  * destination_ip_address  String (IP addr or CIDR)
  32  * source_port_range_min    Integer
  33  * source_port_range_max    Integer
  34  * destination_port_range_min Integer
  35  * destination_port_range_max Integer
  36  * position                Integer
  37  * action                  String
  38  * enabled                 Bool
  39  * id                      uuid-str
  40  * http://docs.openstack.org/api/openstack-network/2.0/openstack-network.pdf
  41  *
  42  */
  43
  44 @XmlRootElement
  45 @XmlAccessorType(XmlAccessType.NONE)
  46 public final class NeutronFirewallRule extends NeutronBaseAttributes<NeutronFirewallRule> {
  47     private static final long serialVersionUID = 1L;
  48
  49     @XmlElement(defaultValue = "false", name = "shared")
  50     Boolean firewallRuleIsShared;
  51
  52     @XmlElement(name = "firewall_policy_id")
  53     String firewallRulePolicyID;
  54
  55     @XmlElement(name = "protocol")
  56     String firewallRuleProtocol;
  57
  58     @XmlElement(name = "ip_version")
  59     Integer firewallRuleIpVer;
  60
  61     @XmlElement(name = "source_ip_address")
  62     String firewallRuleSrcIpAddr;
  63
  64     @XmlElement(name = "destination_ip_address")
  65     String firewallRuleDstIpAddr;
  66
  67     @XmlElement(name = "source_port_range_min")
  68     Integer firewallRuleSrcPortRangeMin;
  69
  70     @XmlElement(name = "source_port_range_max")
  71     Integer firewallRuleSrcPortRangeMax;
  72
  73     @XmlElement(name = "destination_port_range_min")
  74     Integer firewallRuleDstPortRangeMin;
  75
  76     @XmlElement(name = "destination_port_range_max")
  77     Integer firewallRuleDstPortRangeMax;
  78
  79     @XmlElement(name = "position")
  80     Integer firewallRulePosition;
  81
  82     @XmlElement(name = "action")
  83     String firewallRuleAction;
  84
  85     @XmlElement(name = "enabled")
  86     Boolean firewallRuleIsEnabled;
  87
  88     public Boolean getFirewallRuleIsEnabled() {
  89         return firewallRuleIsEnabled;
  90     }
  91
  92     public void setFirewallRuleIsEnabled(Boolean firewallRuleIsEnabled) {
  93         this.firewallRuleIsEnabled = firewallRuleIsEnabled;
  94     }
  95
  96     public String getFirewallRuleAction() {
  97         return firewallRuleAction;
  98     }
  99
 100     public void setFirewallRuleAction(String firewallRuleAction) {
 101         this.firewallRuleAction = firewallRuleAction;
 102     }
 103
 104     public Integer getFirewallRulePosition() {
 105         return firewallRulePosition;
 106     }
 107
 108     public void setFirewallRulePosition(Integer firewallRulePosition) {
 109         this.firewallRulePosition = firewallRulePosition;
 110     }
 111
 112     public Integer getFirewallRuleDstPortRangeMin() {
 113         return firewallRuleDstPortRangeMin;
 114     }
 115
 116     public void setFirewallRuleDstPortRangeMin(Integer firewallRuleDstPortRangeMin) {
 117         this.firewallRuleDstPortRangeMin = firewallRuleDstPortRangeMin;
 118     }
 119
 120     public Integer getFirewallRuleDstPortRangeMax() {
 121         return firewallRuleDstPortRangeMax;
 122     }
 123
 124     public void setFirewallRuleDstPortRangeMax(Integer firewallRuleDstPortRangeMax) {
 125         this.firewallRuleDstPortRangeMax = firewallRuleDstPortRangeMax;
 126     }
 127
 128     public Integer getFirewallRuleSrcPortRangeMin() {
 129         return firewallRuleSrcPortRangeMin;
 130     }
 131
 132     public void setFirewallRuleSrcPortRangeMin(Integer firewallRuleSrcPortRangeMin) {
 133         this.firewallRuleSrcPortRangeMin = firewallRuleSrcPortRangeMin;
 134     }
 135
 136     public Integer getFirewallRuleSrcPortRangeMax() {
 137         return firewallRuleSrcPortRangeMax;
 138     }
 139
 140     public void setFirewallRuleSrcPortRangeMax(Integer firewallRuleSrcPortRangeMax) {
 141         this.firewallRuleSrcPortRangeMax = firewallRuleSrcPortRangeMax;
 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 setFirewallRulePolicyID(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     @Override
 193     protected boolean extractField(String field, NeutronFirewallRule ans) {
 194         switch (field) {
 195             case "shared":
 196                 ans.setFirewallRuleIsShared(firewallRuleIsShared);
 197                 break;
 198             case "firewall_policy_id":
 199                 ans.setFirewallRulePolicyID(this.getFirewallRulePolicyID());
 200                 break;
 201             case "protocol":
 202                 ans.setFirewallRuleProtocol(this.getFirewallRuleProtocol());
 203                 break;
 204             case "source_ip_address":
 205                 ans.setFirewallRuleSrcIpAddr(this.getFirewallRuleSrcIpAddr());
 206                 break;
 207             case "destination_ip_address":
 208                 ans.setFirewallRuleDstIpAddr(this.getFirewallRuleDstIpAddr());
 209                 break;
 210             case "source_port_range_min":
 211                 ans.setFirewallRuleSrcPortRangeMin(this.getFirewallRuleSrcPortRangeMin());
 212                 break;
 213             case "source_port_range_max":
 214                 ans.setFirewallRuleSrcPortRangeMax(this.getFirewallRuleSrcPortRangeMax());
 215                 break;
 216             case "destination_port_range_min":
 217                 ans.setFirewallRuleDstPortRangeMin(this.getFirewallRuleDstPortRangeMin());
 218                 break;
 219             case "destination_port_range_max":
 220                 ans.setFirewallRuleDstPortRangeMax(this.getFirewallRuleDstPortRangeMax());
 221                 break;
 222             case "position":
 223                 ans.setFirewallRulePosition(this.getFirewallRulePosition());
 224                 break;
 225             case "action":
 226                 ans.setFirewallRuleAction(this.getFirewallRuleAction());
 227                 break;
 228             case "enabled":
 229                 ans.setFirewallRuleIsEnabled(firewallRuleIsEnabled);
 230                 break;
 231             default:
 232                 return super.extractField(field, ans);
 233         }
 234         return true;
 235     }
 236
 237     @Override
 238     public String toString() {
 239         return "firewallPolicyRules{" + "firewallRuleUUID='" + uuid + '\'' + ", firewallRuleTenantID='" + tenantID
 240                 + '\'' + ", firewallRuleName='" + name + '\'' + ", firewallRuleIsShared="
 241                 + firewallRuleIsShared + ", firewallRulePolicyID=" + firewallRulePolicyID + ", firewallRuleProtocol='"
 242                 + firewallRuleProtocol + '\'' + ", firewallRuleIpVer=" + firewallRuleIpVer + ", firewallRuleSrcIpAddr='"
 243                 + firewallRuleSrcIpAddr + '\'' + ", firewallRuleDstIpAddr='" + firewallRuleDstIpAddr + '\''
 244                 + ", firewallRuleSrcPort=" + firewallRuleSrcPortRangeMin + ':' + firewallRuleSrcPortRangeMax
 245                 + ", firewallRuleDstPort=" + firewallRuleDstPortRangeMin + ':' + firewallRuleDstPortRangeMax
 246                 + ", firewallRulePosition=" + firewallRulePosition + ", firewallRuleAction='" + firewallRuleAction
 247                 + '\'' + ", firewallRuleIsEnabled=" + firewallRuleIsEnabled + '}';
 248     }
 249 }