openstack/net-virt/src/main/java/org/opendaylight/netvirt/openstack/netvirt/translator/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.netvirt.openstack.netvirt.translator;
  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.List;
  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  * tenant_id               uuid-str
  25  * name                    String
  26  * description             String
  27  * admin_state_up          Bool
  28  * status                  String
  29  * shared                  Bool
  30  * firewall_policy_id      uuid-str
  31  * protocol                String
  32  * ip_version              Integer
  33  * source_ip_address       String (IP addr or CIDR)
  34  * destination_ip_address  String (IP addr or CIDR)
  35  * source_port             Integer
  36  * destination_port        Integer
  37  * position                Integer
  38  * action                  String
  39  * enabled                 Bool
  40  * id                      uuid-str
  41  * http://docs.openstack.org/api/openstack-network/2.0/openstack-network.pdf
  42  *
  43  */
  44
  45 @XmlRootElement
  46 @XmlAccessorType(XmlAccessType.NONE)
  47
  48 public class NeutronFirewallRule implements Serializable, INeutronObject {
  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(name = "status")
  64     String firewallRuleStatus;
  65
  66     @XmlElement(defaultValue = "false", name = "shared")
  67     Boolean firewallRuleIsShared;
  68
  69     @XmlElement(name = "firewall_policy_id")
  70     String firewallRulePolicyID;
  71
  72     @XmlElement(name = "protocol")
  73     String firewallRuleProtocol;
  74
  75     @XmlElement(name = "ip_version")
  76     Integer firewallRuleIpVer;
  77
  78     @XmlElement(name = "source_ip_address")
  79     String firewallRuleSrcIpAddr;
  80
  81     @XmlElement(name = "destination_ip_address")
  82     String firewallRuleDstIpAddr;
  83
  84     @XmlElement(name = "source_port")
  85     Integer firewallRuleSrcPort;
  86
  87     @XmlElement(name = "destination_port")
  88     Integer firewallRuleDstPort;
  89
  90     @XmlElement(name = "position")
  91     Integer firewallRulePosition;
  92
  93     @XmlElement(name = "action")
  94     String firewallRuleAction;
  95
  96     @XmlElement(name = "enabled")
  97     Boolean firewallRuleIsEnabled;
  98
  99     public Boolean getFirewallRuleIsEnabled() {
 100         return firewallRuleIsEnabled;
 101     }
 102
 103     public void setFirewallRuleIsEnabled(Boolean firewallRuleIsEnabled) {
 104         this.firewallRuleIsEnabled = firewallRuleIsEnabled;
 105     }
 106
 107     public String getFirewallRuleAction() {
 108         return firewallRuleAction;
 109     }
 110
 111     public void setFirewallRuleAction(String firewallRuleAction) {
 112         this.firewallRuleAction = firewallRuleAction;
 113     }
 114
 115     public Integer getFirewallRulePosition() {
 116         return firewallRulePosition;
 117     }
 118
 119     public void setFirewallRulePosition(Integer firewallRulePosition) {
 120         this.firewallRulePosition = firewallRulePosition;
 121     }
 122
 123     public Integer getFirewallRuleDstPort() {
 124         return firewallRuleDstPort;
 125     }
 126
 127     public void setFirewallRuleDstPort(Integer firewallRuleDstPort) {
 128         this.firewallRuleDstPort = firewallRuleDstPort;
 129     }
 130
 131     public Integer getFirewallRuleSrcPort() {
 132         return firewallRuleSrcPort;
 133     }
 134
 135     public void setFirewallRuleSrcPort(Integer firewallRuleSrcPort) {
 136         this.firewallRuleSrcPort = firewallRuleSrcPort;
 137     }
 138
 139     public String getFirewallRuleDstIpAddr() {
 140         return firewallRuleDstIpAddr;
 141     }
 142
 143     public void setFirewallRuleDstIpAddr(String firewallRuleDstIpAddr) {
 144         this.firewallRuleDstIpAddr = firewallRuleDstIpAddr;
 145     }
 146
 147     public String getFirewallRuleSrcIpAddr() {
 148         return firewallRuleSrcIpAddr;
 149     }
 150
 151     public void setFirewallRuleSrcIpAddr(String firewallRuleSrcIpAddr) {
 152         this.firewallRuleSrcIpAddr = firewallRuleSrcIpAddr;
 153     }
 154
 155     public Integer getFirewallRuleIpVer() {
 156         return firewallRuleIpVer;
 157     }
 158
 159     public void setFirewallRuleIpVer(Integer firewallRuleIpVer) {
 160         this.firewallRuleIpVer = firewallRuleIpVer;
 161     }
 162
 163     public String getFirewallRuleProtocol() {
 164         return firewallRuleProtocol;
 165     }
 166
 167     public void setFirewallRuleProtocol(String firewallRuleProtocol) {
 168         this.firewallRuleProtocol = firewallRuleProtocol;
 169     }
 170
 171     public String getFirewallRulePolicyID() {
 172         return firewallRulePolicyID;
 173     }
 174
 175     public void setFirewallRulesPolicyID(String firewallRulePolicyID) {
 176         this.firewallRulePolicyID = firewallRulePolicyID;
 177     }
 178
 179     public Boolean getFirewallRuleIsShared() {
 180         return firewallRuleIsShared;
 181     }
 182
 183     public void setFirewallRuleIsShared(Boolean firewallRuleIsShared) {
 184         this.firewallRuleIsShared = firewallRuleIsShared;
 185     }
 186
 187     public String getFirewallRuleStatus() {
 188         return firewallRuleStatus;
 189     }
 190
 191     public void setFirewallRuleStatus(String firewallRuleStatus) {
 192         this.firewallRuleStatus = firewallRuleStatus;
 193     }
 194
 195     public String getFirewallRuleDescription() {
 196         return firewallRuleDescription;
 197     }
 198
 199     public void setFirewallRuleDescription(String firewallRuleDescription) {
 200         this.firewallRuleDescription = firewallRuleDescription;
 201     }
 202
 203     public String getFirewallRuleName() {
 204         return firewallRuleName;
 205     }
 206
 207     public void setFirewallRuleName(String firewallRuleName) {
 208         this.firewallRuleName = firewallRuleName;
 209     }
 210
 211     public String getFirewallRuleTenantID() {
 212         return firewallRuleTenantID;
 213     }
 214
 215     public void setFirewallRuleTenantID(String firewallRuleTenantID) {
 216         this.firewallRuleTenantID = firewallRuleTenantID;
 217     }
 218
 219     public String getID() {
 220         return firewallRuleUUID;
 221     }
 222
 223     public void setID(String id) {
 224         firewallRuleUUID = id;
 225     }
 226
 227     // @deprecated use getID()
 228     public String getFirewallRuleUUID() {
 229         return firewallRuleUUID;
 230     }
 231
 232     // @deprecated use setID()
 233     public void setFireWallRuleID(String firewallRuleUUID) {
 234         this.firewallRuleUUID = firewallRuleUUID;
 235     }
 236
 237     public NeutronFirewallRule extractFields(List<String> fields) {
 238         NeutronFirewallRule ans = new NeutronFirewallRule();
 239         for (String s : fields) {
 240             switch (s) {
 241                 case "id":
 242                     ans.setID(this.getID());
 243                     break;
 244                 case "tenant_id":
 245                     ans.setFirewallRuleTenantID(this.getFirewallRuleTenantID());
 246                     break;
 247                 case "name":
 248                     ans.setFirewallRuleName(this.getFirewallRuleName());
 249                     break;
 250                 case "description":
 251                     ans.setFirewallRuleDescription(this.getFirewallRuleDescription());
 252                     break;
 253                 case "status":
 254                     ans.setFirewallRuleStatus(this.getFirewallRuleStatus());
 255                     break;
 256                 case "shared":
 257                     ans.setFirewallRuleIsShared(firewallRuleIsShared);
 258                     break;
 259                 case "firewall_policy_id":
 260                     ans.setFirewallRulesPolicyID(this.getFirewallRulePolicyID());
 261                     break;
 262                 case "protocol":
 263                     ans.setFirewallRuleProtocol(this.getFirewallRuleProtocol());
 264                     break;
 265                 case "source_ip_address":
 266                     ans.setFirewallRuleSrcIpAddr(this.getFirewallRuleSrcIpAddr());
 267                     break;
 268                 case "destination_ip_address":
 269                     ans.setFirewallRuleDstIpAddr(this.getFirewallRuleDstIpAddr());
 270                     break;
 271                 case "source_port":
 272                     ans.setFirewallRuleSrcPort(this.getFirewallRuleSrcPort());
 273                     break;
 274                 case "destination_port":
 275                     ans.setFirewallRuleDstPort(this.getFirewallRuleDstPort());
 276                     break;
 277                 case "position":
 278                     ans.setFirewallRulePosition(this.getFirewallRulePosition());
 279                     break;
 280                 case "action":
 281                     ans.setFirewallRuleAction(this.getFirewallRuleAction());
 282                     break;
 283                 case "enabled":
 284                     ans.setFirewallRuleIsEnabled(firewallRuleIsEnabled);
 285                     break;
 286             }
 287
 288         }
 289         return ans;
 290     }
 291
 292     @Override
 293     public String toString() {
 294         return "firewallPolicyRules{" +
 295             "firewallRuleUUID='" + firewallRuleUUID + '\'' +
 296             ", firewallRuleTenantID='" + firewallRuleTenantID + '\'' +
 297             ", firewallRuleName='" + firewallRuleName + '\'' +
 298             ", firewallRuleDescription='" + firewallRuleDescription + '\'' +
 299             ", firewallRuleStatus='" + firewallRuleStatus + '\'' +
 300             ", firewallRuleIsShared=" + firewallRuleIsShared +
 301             ", firewallRulePolicyID=" + firewallRulePolicyID +
 302             ", firewallRuleProtocol='" + firewallRuleProtocol + '\'' +
 303             ", firewallRuleIpVer=" + firewallRuleIpVer +
 304             ", firewallRuleSrcIpAddr='" + firewallRuleSrcIpAddr + '\'' +
 305             ", firewallRuleDstIpAddr='" + firewallRuleDstIpAddr + '\'' +
 306             ", firewallRuleSrcPort=" + firewallRuleSrcPort +
 307             ", firewallRuleDstPort=" + firewallRuleDstPort +
 308             ", firewallRulePosition=" + firewallRulePosition +
 309             ", firewallRuleAction='" + firewallRuleAction + '\'' +
 310             ", firewallRuleIsEnabled=" + firewallRuleIsEnabled +
 311             '}';
 312     }
 313
 314     public void initDefaults() {
 315     }
 316 }