• Home
• com.softlayer.api
• softlayer-api-client
• 0.3.4
• 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.component.Firewall Maven / Gradle / Ivy

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

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.billing.Item;
import com.softlayer.api.service.network.Component;
import com.softlayer.api.service.network.Subnet;
import com.softlayer.api.service.network.component.firewall.Rule;
import com.softlayer.api.service.network.firewall.update.Request;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.Future;

/**
 * The SoftLayer_Network_Component_Firewall data type contains general information relating to a single SoftLayer network component 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_Component_Firewall
 */
@ApiType("SoftLayer_Network_Component_Firewall")
public class Firewall extends Entity {

    /**
     * The additional subnets linked to this network component firewall, that inherit rules from the host that the context slot is attached to.
     */
    @ApiProperty
    protected List applyServerRuleSubnets;

    public List getApplyServerRuleSubnets() {
        if (applyServerRuleSubnets == null) {
            applyServerRuleSubnets = new ArrayList();
        }
        return applyServerRuleSubnets;
    }

    /**
     * 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 network component of the guest virtual server that this network component firewall belongs to.
     */
    @ApiProperty
    protected com.softlayer.api.service.virtual.guest.network.Component guestNetworkComponent;

    public com.softlayer.api.service.virtual.guest.network.Component getGuestNetworkComponent() {
        return guestNetworkComponent;
    }

    public void setGuestNetworkComponent(com.softlayer.api.service.virtual.guest.network.Component guestNetworkComponent) {
        this.guestNetworkComponent = guestNetworkComponent;
    }

    /**
     * The network component of the switch interface that this network component firewall belongs to.
     */
    @ApiProperty
    protected Component networkComponent;

    public Component getNetworkComponent() {
        return networkComponent;
    }

    public void setNetworkComponent(Component networkComponent) {
        this.networkComponent = networkComponent;
    }

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

    public List getNetworkFirewallUpdateRequest() {
        if (networkFirewallUpdateRequest == null) {
            networkFirewallUpdateRequest = new ArrayList();
        }
        return networkFirewallUpdateRequest;
    }

    /**
     * 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;
    }

    /**
     * The additional subnets linked to this network component firewall.
     */
    @ApiProperty
    protected List subnets;

    public List getSubnets() {
        if (subnets == null) {
            subnets = new ArrayList();
        }
        return subnets;
    }

    /**
     * Unique ID for the network component of the switch interface that this network component firewall is attached to.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long guestNetworkComponentId;

    public Long getGuestNetworkComponentId() {
        return guestNetworkComponentId;
    }

    public void setGuestNetworkComponentId(Long guestNetworkComponentId) {
        guestNetworkComponentIdSpecified = true;
        this.guestNetworkComponentId = guestNetworkComponentId;
    }

    protected boolean guestNetworkComponentIdSpecified;

    public boolean isGuestNetworkComponentIdSpecified() {
        return guestNetworkComponentIdSpecified;
    }

    public void unsetGuestNetworkComponentId() {
        guestNetworkComponentId = null;
        guestNetworkComponentIdSpecified = false;
    }

    /**
     * Unique ID for the network component firewall.
     */
    @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;
    }

    /**
     * Unique ID for the network component of the switch interface that this network component firewall is attached to.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long networkComponentId;

    public Long getNetworkComponentId() {
        return networkComponentId;
    }

    public void setNetworkComponentId(Long networkComponentId) {
        networkComponentIdSpecified = true;
        this.networkComponentId = networkComponentId;
    }

    protected boolean networkComponentIdSpecified;

    public boolean isNetworkComponentIdSpecified() {
        return networkComponentIdSpecified;
    }

    public void unsetNetworkComponentId() {
        networkComponentId = null;
        networkComponentIdSpecified = false;
    }

    /**
     * Current status of the network component firewall. Status "no_edit" means this host is not protected by a hardware firewall. Status "allow_edit" means this host is protected by a hardware firewall and processing firewall rules. Status "bypass" means this host is provisioned behind a hardware firewall, but bypassing the firewall rules. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String status;

    public String getStatus() {
        return status;
    }

    public void setStatus(String status) {
        statusSpecified = true;
        this.status = status;
    }

    protected boolean statusSpecified;

    public boolean isStatusSpecified() {
        return statusSpecified;
    }

    public void unsetStatus() {
        status = null;
        statusSpecified = false;
    }

    /**
     * A count of the additional subnets linked to this network component firewall, that inherit rules from the host that the context slot is attached to.
     */
    @ApiProperty
    protected Long applyServerRuleSubnetCount;

    public Long getApplyServerRuleSubnetCount() {
        return applyServerRuleSubnetCount;
    }

    public void setApplyServerRuleSubnetCount(Long applyServerRuleSubnetCount) {
        this.applyServerRuleSubnetCount = applyServerRuleSubnetCount;
    }

    /**
     * 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 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 the additional subnets linked to this network component firewall.
     */
    @ApiProperty
    protected Long subnetCount;

    public Long getSubnetCount() {
        return subnetCount;
    }

    public void setSubnetCount(Long subnetCount) {
        this.subnetCount = subnetCount;
    }

    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_Component_Firewall service accesses general information relating to a single SoftLayer network component 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_Component_Firewall
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Network_Component_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_Firewall_Module_Context_Interface_AccessControlList_Network_Component object. You can only get objects for servers attached to your account that have a network firewall enabled. 
         *
         * @see SoftLayer_Network_Component_Firewall::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Firewall getObject();

        /**
         * Check for active transactions for the shared Firewall. 
         *
         * @see SoftLayer_Network_Component_Firewall::hasActiveTransactions
         */
        @ApiMethod(instanceRequired = true)
        public Boolean hasActiveTransactions();

        /**
         * The additional subnets linked to this network component firewall, that inherit rules from the host that the context slot is attached to.
         *
         * @see SoftLayer_Network_Component_Firewall::getApplyServerRuleSubnets
         */
        @ApiMethod(instanceRequired = true)
        public List getApplyServerRuleSubnets();

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

        /**
         * The network component of the guest virtual server that this network component firewall belongs to.
         *
         * @see SoftLayer_Network_Component_Firewall::getGuestNetworkComponent
         */
        @ApiMethod(instanceRequired = true)
        public com.softlayer.api.service.virtual.guest.network.Component getGuestNetworkComponent();

        /**
         * The network component of the switch interface that this network component firewall belongs to.
         *
         * @see SoftLayer_Network_Component_Firewall::getNetworkComponent
         */
        @ApiMethod(instanceRequired = true)
        public Component getNetworkComponent();

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

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

        /**
         * The additional subnets linked to this network component firewall.
         *
         * @see SoftLayer_Network_Component_Firewall::getSubnets
         */
        @ApiMethod(instanceRequired = true)
        public List getSubnets();

    }

    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#hasActiveTransactions}
         */
        public Future hasActiveTransactions();

        public Future hasActiveTransactions(ResponseHandler callback);

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

        /**
         * Async callback version of {@link Service#getApplyServerRuleSubnets}
         */
        public Future getApplyServerRuleSubnets(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#getGuestNetworkComponent}
         */
        public Future getGuestNetworkComponent();

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

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

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

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

        /**
         * Async callback version of {@link Service#getNetworkFirewallUpdateRequest}
         */
        public Future getNetworkFirewallUpdateRequest(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#getSubnets}
         */
        public Future> getSubnets();

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

    }

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

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

        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.virtual.guest.network.Component.Mask guestNetworkComponent() {
            return withSubMask("guestNetworkComponent", com.softlayer.api.service.virtual.guest.network.Component.Mask.class);
        }

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

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

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

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

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

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

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

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

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

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

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

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

    }

}