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 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  * The implemented fields are as follows:
  24  *
  25  * tenant_id               uuid-str
  26  * name                    String
  27  * description             String
  28  * admin_state_up          Bool
  29  * status                  String
  30  * shared                  Bool
  31  * firewall_policy_id      uuid-str
  32  * protocol                String
  33  * ip_version              Integer
  34  * source_ip_address       String (IP addr or CIDR)
  35  * destination_ip_address  String (IP addr or CIDR)
  36  * source_port             Integer
  37  * destination_port        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
  49 public class NeutronFirewallRule extends NeutronObject implements Serializable, INeutronObject {
  50     private static final long serialVersionUID = 1L;
  51
  52     @XmlElement(name = "name")
  53     String firewallRuleName;
  54
  55     @XmlElement(name = "description")
  56     String firewallRuleDescription;
  57
  58     @XmlElement(name = "status")
  59     String firewallRuleStatus;
  60
  61     @XmlElement(defaultValue = "false", name = "shared")
  62     Boolean firewallRuleIsShared;
  63
  64     @XmlElement(name = "firewall_policy_id")
  65     String firewallRulePolicyID;
  66
  67     @XmlElement(name = "protocol")
  68     String firewallRuleProtocol;
  69
  70     @XmlElement(name = "ip_version")
  71     Integer firewallRuleIpVer;
  72
  73     @XmlElement(name = "source_ip_address")
  74     String firewallRuleSrcIpAddr;
  75
  76     @XmlElement(name = "destination_ip_address")
  77     String firewallRuleDstIpAddr;
  78
  79     @XmlElement(name = "source_port")
  80     Integer firewallRuleSrcPort;
  81
  82     @XmlElement(name = "destination_port")
  83     Integer firewallRuleDstPort;
  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 getFirewallRuleDstPort() {
 119         return firewallRuleDstPort;
 120     }
 121
 122     public void setFirewallRuleDstPort(Integer firewallRuleDstPort) {
 123         this.firewallRuleDstPort = firewallRuleDstPort;
 124     }
 125
 126     public Integer getFirewallRuleSrcPort() {
 127         return firewallRuleSrcPort;
 128     }
 129
 130     public void setFirewallRuleSrcPort(Integer firewallRuleSrcPort) {
 131         this.firewallRuleSrcPort = firewallRuleSrcPort;
 132     }
 133
 134     public String getFirewallRuleDstIpAddr() {
 135         return firewallRuleDstIpAddr;
 136     }
 137
 138     public void setFirewallRuleDstIpAddr(String firewallRuleDstIpAddr) {
 139         this.firewallRuleDstIpAddr = firewallRuleDstIpAddr;
 140     }
 141
 142     public String getFirewallRuleSrcIpAddr() {
 143         return firewallRuleSrcIpAddr;
 144     }
 145
 146     public void setFirewallRuleSrcIpAddr(String firewallRuleSrcIpAddr) {
 147         this.firewallRuleSrcIpAddr = firewallRuleSrcIpAddr;
 148     }
 149
 150     public Integer getFirewallRuleIpVer() {
 151         return firewallRuleIpVer;
 152     }
 153
 154     public void setFirewallRuleIpVer(Integer firewallRuleIpVer) {
 155         this.firewallRuleIpVer = firewallRuleIpVer;
 156     }
 157
 158     public String getFirewallRuleProtocol() {
 159         return firewallRuleProtocol;
 160     }
 161
 162     public void setFirewallRuleProtocol(String firewallRuleProtocol) {
 163         this.firewallRuleProtocol = firewallRuleProtocol;
 164     }
 165
 166     public String getFirewallRulePolicyID() {
 167         return firewallRulePolicyID;
 168     }
 169
 170     public void setFirewallRulePolicyID(String firewallRulePolicyID) {
 171         this.firewallRulePolicyID = firewallRulePolicyID;
 172     }
 173
 174     public Boolean getFirewallRuleIsShared() {
 175         return firewallRuleIsShared;
 176     }
 177
 178     public void setFirewallRuleIsShared(Boolean firewallRuleIsShared) {
 179         this.firewallRuleIsShared = firewallRuleIsShared;
 180     }
 181
 182     public String getFirewallRuleStatus() {
 183         return firewallRuleStatus;
 184     }
 185
 186     public void setFirewallRuleStatus(String firewallRuleStatus) {
 187         this.firewallRuleStatus = firewallRuleStatus;
 188     }
 189
 190     public String getFirewallRuleDescription() {
 191         return firewallRuleDescription;
 192     }
 193
 194     public void setFirewallRuleDescription(String firewallRuleDescription) {
 195         this.firewallRuleDescription = firewallRuleDescription;
 196     }
 197
 198     public String getFirewallRuleName() {
 199         return firewallRuleName;
 200     }
 201
 202     public void setFirewallRuleName(String firewallRuleName) {
 203         this.firewallRuleName = firewallRuleName;
 204     }
 205
 206     @Deprecated
 207     public String getFirewallRuleTenantID() {
 208         return getTenantID();
 209     }
 210
 211     @Deprecated
 212     public void setFirewallRuleTenantID(String tenantID) {
 213         setTenantID(tenantID);
 214     }
 215
 216     // @deprecated use getID()
 217     public String getFirewallRuleUUID() {
 218         return getID();
 219     }
 220
 221     // @deprecated use setID()
 222     public void setFireWallRuleID(String uuid) {
 223         setID(uuid);
 224     }
 225
 226     public NeutronFirewallRule extractFields(List<String> fields) {
 227         NeutronFirewallRule ans = new NeutronFirewallRule();
 228         Iterator<String> i = fields.iterator();
 229         while (i.hasNext()) {
 230             String s = i.next();
 231             if (s.equals("id")) {
 232                 ans.setID(this.getID());
 233             }
 234             if (s.equals("tenant_id")) {
 235                 ans.setTenantID(this.getTenantID());
 236             }
 237             if (s.equals("name")) {
 238                 ans.setFirewallRuleName(this.getFirewallRuleName());
 239             }
 240             if (s.equals("description")) {
 241                 ans.setFirewallRuleDescription(this.getFirewallRuleDescription());
 242             }
 243             if (s.equals("status")) {
 244                 ans.setFirewallRuleStatus(this.getFirewallRuleStatus());
 245             }
 246             if (s.equals("shared")) {
 247                 ans.setFirewallRuleIsShared(firewallRuleIsShared);
 248             }
 249             if (s.equals("firewall_policy_id")) {
 250                 ans.setFirewallRulePolicyID(this.getFirewallRulePolicyID());
 251             }
 252             if (s.equals("protocol")) {
 253                 ans.setFirewallRuleProtocol(this.getFirewallRuleProtocol());
 254             }
 255             if (s.equals("source_ip_address")) {
 256                 ans.setFirewallRuleSrcIpAddr(this.getFirewallRuleSrcIpAddr());
 257             }
 258             if (s.equals("destination_ip_address")) {
 259                 ans.setFirewallRuleDstIpAddr(this.getFirewallRuleDstIpAddr());
 260             }
 261             if (s.equals("source_port")) {
 262                 ans.setFirewallRuleSrcPort(this.getFirewallRuleSrcPort());
 263             }
 264             if (s.equals("destination_port")) {
 265                 ans.setFirewallRuleDstPort(this.getFirewallRuleDstPort());
 266             }
 267             if (s.equals("position")) {
 268                 ans.setFirewallRulePosition(this.getFirewallRulePosition());
 269             }
 270             if (s.equals("action")) {
 271                 ans.setFirewallRuleAction(this.getFirewallRuleAction());
 272             }
 273             if (s.equals("enabled")) {
 274                 ans.setFirewallRuleIsEnabled(firewallRuleIsEnabled);
 275             }
 276
 277         }
 278         return ans;
 279     }
 280
 281     @Override
 282     public String toString() {
 283         return "firewallPolicyRules{" +
 284             "firewallRuleUUID='" + uuid + '\'' +
 285             ", firewallRuleTenantID='" + tenantID + '\'' +
 286             ", firewallRuleName='" + firewallRuleName + '\'' +
 287             ", firewallRuleDescription='" + firewallRuleDescription + '\'' +
 288             ", firewallRuleStatus='" + firewallRuleStatus + '\'' +
 289             ", firewallRuleIsShared=" + firewallRuleIsShared +
 290             ", firewallRulePolicyID=" + firewallRulePolicyID +
 291             ", firewallRuleProtocol='" + firewallRuleProtocol + '\'' +
 292             ", firewallRuleIpVer=" + firewallRuleIpVer +
 293             ", firewallRuleSrcIpAddr='" + firewallRuleSrcIpAddr + '\'' +
 294             ", firewallRuleDstIpAddr='" + firewallRuleDstIpAddr + '\'' +
 295             ", firewallRuleSrcPort=" + firewallRuleSrcPort +
 296             ", firewallRuleDstPort=" + firewallRuleDstPort +
 297             ", firewallRulePosition=" + firewallRulePosition +
 298             ", firewallRuleAction='" + firewallRuleAction + '\'' +
 299             ", firewallRuleIsEnabled=" + firewallRuleIsEnabled +
 300             '}';
 301     }
 302
 303     public void initDefaults() {
 304     }
 305 }