org.openstack4j.model.network.ext

Interface FirewallPolicy

All Superinterfaces:

Buildable<FirewallPolicyBuilder>, ModelEntity, Serializable

All Known Implementing Classes:

AbstractNeutronFirewallPolicy, NeutronFirewallPolicy, NeutronFirewallPolicyRule

public interface FirewallPolicy
extends ModelEntity, Buildable<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

Nested Class Summary

Nested classes/interfaces inherited from interface org.openstack4j.common.Buildable

Buildable.Builder<T extends Buildable.Builder<T,M>,M extends Buildable<?>>

Method Summary

Modifier and Type	Method and Description
String	getDescription()
List<String>	getFirewallList()
List<String>	getFirewallRuleIds()
String	getId()
String	getName()
List<? extends FirewallRule>	getNeutronFirewallRules()
String	getTenantId()
Boolean	isAudited()
Boolean	isShared()

Methods inherited from interface org.openstack4j.common.Buildable

toBuilder

Method Detail

getId

String getId()

Returns:

id : Unique identifier for the firewall policy.

getName

String getName()

Returns:

name : Human readable name for the FirewallPolicy (255 characters limit). Does not have to be unique.

getTenantId

String getTenantId()

Returns:

tenantId : Owner of the Firewall Policy. Only an administrative user can specify a tenant ID other than its own.

getDescription

String getDescription()

Returns:

description : Human readable description for the FirewallPolicy (1024 characters limit).

isShared

Boolean isShared()

Returns:

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.

isAudited

Boolean isAudited()

Returns:

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.

getFirewallRuleIds

List<String> getFirewallRuleIds()

Returns:

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.

getFirewallList

List<String> getFirewallList()

Returns:

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.

getNeutronFirewallRules

List<? extends FirewallRule> getNeutronFirewallRules()

Returns:

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.

See Also:

FirewallRule