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