• Home
• com.softlayer.api
• softlayer-api-client
• 0.2.0
• source code
• Firewall.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.softlayer.api.service.network.vlan.Firewall Maven / Gradle / Ivy

package com.softlayer.api.service.network.vlan;

import com.softlayer.api.ApiClient;
import com.softlayer.api.ResponseHandler;
import com.softlayer.api.annotation.ApiMethod;
import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.Location;
import com.softlayer.api.service.billing.Item;
import com.softlayer.api.service.network.Vlan;
import com.softlayer.api.service.network.firewall.update.Request;
import com.softlayer.api.service.network.vlan.firewall.Rule;
import com.softlayer.api.service.provisioning.version1.Transaction;
import com.softlayer.api.service.software.component.Password;
import com.softlayer.api.service.tag.Reference;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.Future;

/**
 * The SoftLayer_Network_Vlan_Firewall data type contains general information relating to a single SoftLayer VLAN firewall. This is the object which ties the running rules to a specific downstream server. Use the [[SoftLayer Network Firewall Template]] service to pull SoftLayer recommended rule set templates. Use the [[SoftLayer Network Firewall Update Request]] service to submit a firewall update request. 
 *
 * @see SoftLayer_Network_Vlan_Firewall
 */
@ApiType("SoftLayer_Network_Vlan_Firewall")
public class Firewall extends Entity {

    /**
     * The billing item for a Hardware Firewall (Dedicated).
     */
    @ApiProperty
    protected Item billingItem;

    public Item getBillingItem() {
        return billingItem;
    }

    public void setBillingItem(Item billingItem) {
        this.billingItem = billingItem;
    }

    /**
     * The datacenter that the firewall resides in.
     */
    @ApiProperty
    protected Location datacenter;

    public Location getDatacenter() {
        return datacenter;
    }

    public void setDatacenter(Location datacenter) {
        this.datacenter = datacenter;
    }

    /**
     * The firewall device type.
     */
    @ApiProperty
    protected String firewallType;

    public String getFirewallType() {
        return firewallType;
    }

    public void setFirewallType(String firewallType) {
        this.firewallType = firewallType;
    }

    /**
     * A name reflecting the hostname and domain of the firewall. This is created from the combined values of the firewall's logical name and vlan number automatically, and thus can not be edited directly.
     */
    @ApiProperty
    protected String fullyQualifiedDomainName;

    public String getFullyQualifiedDomainName() {
        return fullyQualifiedDomainName;
    }

    public void setFullyQualifiedDomainName(String fullyQualifiedDomainName) {
        this.fullyQualifiedDomainName = fullyQualifiedDomainName;
    }

    /**
     * The credentials to log in to a firewall device. This is only present for dedicated appliances.
     */
    @ApiProperty
    protected Password managementCredentials;

    public Password getManagementCredentials() {
        return managementCredentials;
    }

    public void setManagementCredentials(Password managementCredentials) {
        this.managementCredentials = managementCredentials;
    }

    /**
     * The update requests made for this firewall.
     */
    @ApiProperty
    protected List networkFirewallUpdateRequests;

    public List getNetworkFirewallUpdateRequests() {
        if (networkFirewallUpdateRequests == null) {
            networkFirewallUpdateRequests = new ArrayList();
        }
        return networkFirewallUpdateRequests;
    }

    /**
     * The VLAN object that a firewall is associated with and protecting.
     */
    @ApiProperty
    protected Vlan networkVlan;

    public Vlan getNetworkVlan() {
        return networkVlan;
    }

    public void setNetworkVlan(Vlan networkVlan) {
        this.networkVlan = networkVlan;
    }

    /**
     * The VLAN objects that a firewall is associated with and protecting.
     */
    @ApiProperty
    protected List networkVlans;

    public List getNetworkVlans() {
        if (networkVlans == null) {
            networkVlans = new ArrayList();
        }
        return networkVlans;
    }

    /**
     * The currently running rule set of this network component firewall.
     */
    @ApiProperty
    protected List rules;

    public List getRules() {
        if (rules == null) {
            rules = new ArrayList();
        }
        return rules;
    }

    @ApiProperty
    protected List tagReferences;

    public List getTagReferences() {
        if (tagReferences == null) {
            tagReferences = new ArrayList();
        }
        return tagReferences;
    }

    /**
     * A flag to indicate if the firewall is in administrative bypass mode. In other words, no rules are being applied to the traffic coming through.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String administrativeBypassFlag;

    public String getAdministrativeBypassFlag() {
        return administrativeBypassFlag;
    }

    public void setAdministrativeBypassFlag(String administrativeBypassFlag) {
        administrativeBypassFlagSpecified = true;
        this.administrativeBypassFlag = administrativeBypassFlag;
    }

    protected boolean administrativeBypassFlagSpecified;

    public boolean isAdministrativeBypassFlagSpecified() {
        return administrativeBypassFlagSpecified;
    }

    public void unsetAdministrativeBypassFlag() {
        administrativeBypassFlag = null;
        administrativeBypassFlagSpecified = false;
    }

    /**
     * Whether or not this firewall can be directly logged in to.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Boolean customerManagedFlag;

    public Boolean getCustomerManagedFlag() {
        return customerManagedFlag;
    }

    public void setCustomerManagedFlag(Boolean customerManagedFlag) {
        customerManagedFlagSpecified = true;
        this.customerManagedFlag = customerManagedFlag;
    }

    protected boolean customerManagedFlagSpecified;

    public boolean isCustomerManagedFlagSpecified() {
        return customerManagedFlagSpecified;
    }

    public void unsetCustomerManagedFlag() {
        customerManagedFlag = null;
        customerManagedFlagSpecified = false;
    }

    /**
     * A firewall's unique identifier.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long id;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        idSpecified = true;
        this.id = id;
    }

    protected boolean idSpecified;

    public boolean isIdSpecified() {
        return idSpecified;
    }

    public void unsetId() {
        id = null;
        idSpecified = false;
    }

    /**
     * A firewall's primary IP address. This field will be the IP shown when doing network traces and reverse DNS and is a read-only property.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String primaryIpAddress;

    public String getPrimaryIpAddress() {
        return primaryIpAddress;
    }

    public void setPrimaryIpAddress(String primaryIpAddress) {
        primaryIpAddressSpecified = true;
        this.primaryIpAddress = primaryIpAddress;
    }

    protected boolean primaryIpAddressSpecified;

    public boolean isPrimaryIpAddressSpecified() {
        return primaryIpAddressSpecified;
    }

    public void unsetPrimaryIpAddress() {
        primaryIpAddress = null;
        primaryIpAddressSpecified = false;
    }

    /**
     * A count of the update requests made for this firewall.
     */
    @ApiProperty
    protected Long networkFirewallUpdateRequestCount;

    public Long getNetworkFirewallUpdateRequestCount() {
        return networkFirewallUpdateRequestCount;
    }

    public void setNetworkFirewallUpdateRequestCount(Long networkFirewallUpdateRequestCount) {
        this.networkFirewallUpdateRequestCount = networkFirewallUpdateRequestCount;
    }

    /**
     * A count of the VLAN objects that a firewall is associated with and protecting.
     */
    @ApiProperty
    protected Long networkVlanCount;

    public Long getNetworkVlanCount() {
        return networkVlanCount;
    }

    public void setNetworkVlanCount(Long networkVlanCount) {
        this.networkVlanCount = networkVlanCount;
    }

    /**
     * A count of the currently running rule set of this network component firewall.
     */
    @ApiProperty
    protected Long ruleCount;

    public Long getRuleCount() {
        return ruleCount;
    }

    public void setRuleCount(Long ruleCount) {
        this.ruleCount = ruleCount;
    }

    /**
     * A count of 
     */
    @ApiProperty
    protected Long tagReferenceCount;

    public Long getTagReferenceCount() {
        return tagReferenceCount;
    }

    public void setTagReferenceCount(Long tagReferenceCount) {
        this.tagReferenceCount = tagReferenceCount;
    }

    public Service asService(ApiClient client) {
        return service(client, id);
    }

    public static Service service(ApiClient client) {
        return client.createService(Service.class, null);
    }

    public static Service service(ApiClient client, Long id) {
        return client.createService(Service.class, id == null ? null : id.toString());
    }

    /**
     * The SoftLayer_Network_Vlan_Firewall service accesses general information relating to a single SoftLayer VLAN firewall.  This is the object which ties the running rules to a specific downstream server. The current running rule set can be pulled from this service. Use the [[SoftLayer Network Firewall Template]] service to pull SoftLayer recommended rule set templates. Use the [[SoftLayer Network Firewall Update Request]] service to submit a firewall update request. 
     *
     * @see SoftLayer_Network_Vlan_Firewall
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Network_Vlan_Firewall")
    public static interface Service extends com.softlayer.api.Service {

        public ServiceAsync asAsync();
        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * getObject returns a SoftLayer_Network_Vlan_Firewall object. You can only get objects for vlans attached to your account that have a network firewall enabled. 
         *
         * @see SoftLayer_Network_Vlan_Firewall::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Firewall getObject();

        /**
         * This will completely reset the firewall to factory settings. If the firewall is not a dedicated appliance an error will occur. Note, this process is performed asynchronously. During the process all traffic will not be routed through the firewall. 
         *
         * @see SoftLayer_Network_Vlan_Firewall::restoreDefaults
         */
        @ApiMethod(instanceRequired = true)
        public Transaction restoreDefaults();

        /**
         * This method will associate a comma separated list of tags with this object. 
         *
         * @see SoftLayer_Network_Vlan_Firewall::setTags
         */
        @ApiMethod(instanceRequired = true)
        public Boolean setTags(String tags);

        /**
         * Enable or disable route bypass for this context. If enabled, this will bypass the firewall entirely and all traffic will be routed directly to the host(s) behind it. If disabled, traffic will flow through the firewall normally. This feature is only available for Hardware Firewall (Dedicated) and dedicated appliances. 
         *
         * @see SoftLayer_Network_Vlan_Firewall::updateRouteBypass
         */
        @ApiMethod(instanceRequired = true)
        public Transaction updateRouteBypass(Boolean bypass);

        /**
         * The billing item for a Hardware Firewall (Dedicated).
         *
         * @see SoftLayer_Network_Vlan_Firewall::getBillingItem
         */
        @ApiMethod(instanceRequired = true)
        public Item getBillingItem();

        /**
         * The datacenter that the firewall resides in.
         *
         * @see SoftLayer_Network_Vlan_Firewall::getDatacenter
         */
        @ApiMethod(instanceRequired = true)
        public Location getDatacenter();

        /**
         * The firewall device type.
         *
         * @see SoftLayer_Network_Vlan_Firewall::getFirewallType
         */
        @ApiMethod(instanceRequired = true)
        public String getFirewallType();

        /**
         * A name reflecting the hostname and domain of the firewall. This is created from the combined values of the firewall's logical name and vlan number automatically, and thus can not be edited directly.
         *
         * @see SoftLayer_Network_Vlan_Firewall::getFullyQualifiedDomainName
         */
        @ApiMethod(instanceRequired = true)
        public String getFullyQualifiedDomainName();

        /**
         * The credentials to log in to a firewall device. This is only present for dedicated appliances.
         *
         * @see SoftLayer_Network_Vlan_Firewall::getManagementCredentials
         */
        @ApiMethod(instanceRequired = true)
        public Password getManagementCredentials();

        /**
         * The update requests made for this firewall.
         *
         * @see SoftLayer_Network_Vlan_Firewall::getNetworkFirewallUpdateRequests
         */
        @ApiMethod(instanceRequired = true)
        public List getNetworkFirewallUpdateRequests();

        /**
         * The VLAN object that a firewall is associated with and protecting.
         *
         * @see SoftLayer_Network_Vlan_Firewall::getNetworkVlan
         */
        @ApiMethod(instanceRequired = true)
        public Vlan getNetworkVlan();

        /**
         * The VLAN objects that a firewall is associated with and protecting.
         *
         * @see SoftLayer_Network_Vlan_Firewall::getNetworkVlans
         */
        @ApiMethod(instanceRequired = true)
        public List getNetworkVlans();

        /**
         * The currently running rule set of this network component firewall.
         *
         * @see SoftLayer_Network_Vlan_Firewall::getRules
         */
        @ApiMethod(instanceRequired = true)
        public List getRules();

        /**
         * @see SoftLayer_Network_Vlan_Firewall::getTagReferences
         */
        @ApiMethod(instanceRequired = true)
        public List getTagReferences();

    }

    public static interface ServiceAsync extends com.softlayer.api.ServiceAsync {

        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * Async version of {@link Service#getObject}
         */
        public Future getObject();

        public Future getObject(ResponseHandler callback);

        /**
         * Async version of {@link Service#restoreDefaults}
         */
        public Future restoreDefaults();

        public Future restoreDefaults(ResponseHandler callback);

        /**
         * Async version of {@link Service#setTags}
         */
        public Future setTags(String tags);

        public Future setTags(String tags, ResponseHandler callback);

        /**
         * Async version of {@link Service#updateRouteBypass}
         */
        public Future updateRouteBypass(Boolean bypass);

        public Future updateRouteBypass(Boolean bypass, ResponseHandler callback);

        /**
         * Async version of {@link Service#getBillingItem}
         */
        public Future getBillingItem();

        /**
         * Async callback version of {@link Service#getBillingItem}
         */
        public Future getBillingItem(ResponseHandler callback);

        /**
         * Async version of {@link Service#getDatacenter}
         */
        public Future getDatacenter();

        /**
         * Async callback version of {@link Service#getDatacenter}
         */
        public Future getDatacenter(ResponseHandler callback);

        /**
         * Async version of {@link Service#getFirewallType}
         */
        public Future getFirewallType();

        /**
         * Async callback version of {@link Service#getFirewallType}
         */
        public Future getFirewallType(ResponseHandler callback);

        /**
         * Async version of {@link Service#getFullyQualifiedDomainName}
         */
        public Future getFullyQualifiedDomainName();

        /**
         * Async callback version of {@link Service#getFullyQualifiedDomainName}
         */
        public Future getFullyQualifiedDomainName(ResponseHandler callback);

        /**
         * Async version of {@link Service#getManagementCredentials}
         */
        public Future getManagementCredentials();

        /**
         * Async callback version of {@link Service#getManagementCredentials}
         */
        public Future getManagementCredentials(ResponseHandler callback);

        /**
         * Async version of {@link Service#getNetworkFirewallUpdateRequests}
         */
        public Future> getNetworkFirewallUpdateRequests();

        /**
         * Async callback version of {@link Service#getNetworkFirewallUpdateRequests}
         */
        public Future getNetworkFirewallUpdateRequests(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getNetworkVlan}
         */
        public Future getNetworkVlan();

        /**
         * Async callback version of {@link Service#getNetworkVlan}
         */
        public Future getNetworkVlan(ResponseHandler callback);

        /**
         * Async version of {@link Service#getNetworkVlans}
         */
        public Future> getNetworkVlans();

        /**
         * Async callback version of {@link Service#getNetworkVlans}
         */
        public Future getNetworkVlans(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getRules}
         */
        public Future> getRules();

        /**
         * Async callback version of {@link Service#getRules}
         */
        public Future getRules(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getTagReferences}
         */
        public Future> getTagReferences();

        /**
         * Async callback version of {@link Service#getTagReferences}
         */
        public Future getTagReferences(ResponseHandler> callback);

    }

    public static class Mask extends com.softlayer.api.service.Entity.Mask {

        public com.softlayer.api.service.billing.Item.Mask billingItem() {
            return withSubMask("billingItem", com.softlayer.api.service.billing.Item.Mask.class);
        }

        public com.softlayer.api.service.Location.Mask datacenter() {
            return withSubMask("datacenter", com.softlayer.api.service.Location.Mask.class);
        }

        public Mask firewallType() {
            withLocalProperty("firewallType");
            return this;
        }

        public Mask fullyQualifiedDomainName() {
            withLocalProperty("fullyQualifiedDomainName");
            return this;
        }

        public com.softlayer.api.service.software.component.Password.Mask managementCredentials() {
            return withSubMask("managementCredentials", com.softlayer.api.service.software.component.Password.Mask.class);
        }

        public com.softlayer.api.service.network.firewall.update.Request.Mask networkFirewallUpdateRequests() {
            return withSubMask("networkFirewallUpdateRequests", com.softlayer.api.service.network.firewall.update.Request.Mask.class);
        }

        public com.softlayer.api.service.network.Vlan.Mask networkVlan() {
            return withSubMask("networkVlan", com.softlayer.api.service.network.Vlan.Mask.class);
        }

        public com.softlayer.api.service.network.Vlan.Mask networkVlans() {
            return withSubMask("networkVlans", com.softlayer.api.service.network.Vlan.Mask.class);
        }

        public com.softlayer.api.service.network.vlan.firewall.Rule.Mask rules() {
            return withSubMask("rules", com.softlayer.api.service.network.vlan.firewall.Rule.Mask.class);
        }

        public com.softlayer.api.service.tag.Reference.Mask tagReferences() {
            return withSubMask("tagReferences", com.softlayer.api.service.tag.Reference.Mask.class);
        }

        public Mask administrativeBypassFlag() {
            withLocalProperty("administrativeBypassFlag");
            return this;
        }

        public Mask customerManagedFlag() {
            withLocalProperty("customerManagedFlag");
            return this;
        }

        public Mask id() {
            withLocalProperty("id");
            return this;
        }

        public Mask primaryIpAddress() {
            withLocalProperty("primaryIpAddress");
            return this;
        }

        public Mask networkFirewallUpdateRequestCount() {
            withLocalProperty("networkFirewallUpdateRequestCount");
            return this;
        }

        public Mask networkVlanCount() {
            withLocalProperty("networkVlanCount");
            return this;
        }

        public Mask ruleCount() {
            withLocalProperty("ruleCount");
            return this;
        }

        public Mask tagReferenceCount() {
            withLocalProperty("tagReferenceCount");
            return this;
        }

    }

}