org.openstack4j.model.network.ext.FirewallPolicy Maven / Gradle / Ivy
The newest version!
package org.openstack4j.model.network.ext;
import java.util.List;
import org.openstack4j.common.Buildable;
import org.openstack4j.model.ModelEntity;
import org.openstack4j.model.network.ext.builder.FirewallPolicyBuilder;
/**
* Networking (Neutron) FwaaS Firewall Policy Extension API
*
* Represents an ordered collection of firewall rules. A firewall policy can be shared across tenants.
* Thus it can also be made part of an audit workflow wherein the firewall_policy can be audited by the
* relevant entity that is authorized (and can be different from the tenants which create or use the firewall policy).
*
*
* @author Vishvesh Deshmukh
*/
public interface FirewallPolicy extends ModelEntity, Buildable {
/**
* @return id : Unique identifier for the firewall policy.
*/
public String getId();
/**
* @return name : Human readable name for the FirewallPolicy (255 characters limit). Does not have to be unique.
*/
public String getName();
/**
* @return tenantId : Owner of the Firewall Policy. Only an administrative user can
* specify a tenant ID other than its own.
*/
public String getTenantId();
/**
* @return description : Human readable description for the FirewallPolicy (1024 characters limit).
*/
public String getDescription();
/**
* @return shared : When set to True makes this FirewallPolicy visible to tenants other
* than its owner, and can be used in FirewallPolicy not owned by its tenant.
*/
public Boolean isShared();
/**
* @return audited : When set to True by the policy owner indicates that the firewall policy has been audited.
* This attribute is meant to aid in the firewall policy audit workflows.
* Each time the firewall policy or the associated firewall rules are changed,
* this attribute will be set to False and will have to be explicitly set
* to True through an update operation.
*/
public Boolean isAudited();
/**
* @return firewallRules(UUID)List : This is an ordered list of firewall rule uuids.
* The firewall applies the rules in the order in which they appear in this list.
*/
public List getFirewallRuleIds();
/**
* @return firewallList(UUID)List : This is a list of Firewalls associated with Firewall Policy.
* This is returned when a firewall rule is added or removed from a firewall policy.
*/
public List getFirewallList();
/**
* @see FirewallRule
* @return neutronFirewallRulesList : This is an ordered list of firewall rules (by uuid).
* The firewall applies the rules in the order in which they appear in this list.
*/
public List getNeutronFirewallRules();
}