org.openstack4j.openstack.networking.domain.ext

Class AbstractNeutronFirewallPolicy

java.lang.Object

org.openstack4j.openstack.networking.domain.ext.AbstractNeutronFirewallPolicy

All Implemented Interfaces:

Serializable, Buildable<FirewallPolicyBuilder>, ModelEntity, FirewallPolicy

Direct Known Subclasses:

NeutronFirewallPolicy, NeutronFirewallPolicyRule

public class AbstractNeutronFirewallPolicy
extends Object
implements FirewallPolicy

A Neutron Firewall (FwaaS) : Firewall Policy Entity.

This is the Parent class which is extended by NeutronFirewallPolicy & NeutronFirewalPolicyRule classes. Prior has `@JsonRootName("firewall_policy")` attribute whereas the later doesn't have (which is used by `rule_insert/rule_remove` calls - which doesn't require JsonRootName).

Author:

Vishvesh Deshmukh

See Also:

NeutronFirewallPolicy, NeutronFirewallPolicyRule, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractNeutronFirewallPolicy.FirewallPolicies
static class	AbstractNeutronFirewallPolicy.FirewallPolicyConcreteBuilder

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	audited
protected String	description
protected List<String>	firewallRules
protected String	id
protected String	name
protected List<NeutronFirewallRule>	neutronFirewallRules
protected Boolean	shared
protected String	tenantId

Constructor Summary

Constructors

Constructor and Description
AbstractNeutronFirewallPolicy()

Method Summary

Modifier and Type	Method and Description
static FirewallPolicyBuilder	builder()
String	getDescription()
List<String>	getFirewallList()
List<String>	getFirewallRuleIds()
String	getId()
String	getName()
List<? extends FirewallRule>	getNeutronFirewallRules()
String	getTenantId()
Boolean	isAudited()
Boolean	isShared()
FirewallPolicyBuilder	toBuilder() Wrap this FirewallPolicy to a builder
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

id

protected String id

name

protected String name

tenantId

protected String tenantId

description

protected String description

shared

protected Boolean shared

audited

protected Boolean audited

firewallRules

protected List<String> firewallRules

neutronFirewallRules

protected List<NeutronFirewallRule> neutronFirewallRules

Constructor Detail

AbstractNeutronFirewallPolicy

public AbstractNeutronFirewallPolicy()

Method Detail

toBuilder

public FirewallPolicyBuilder toBuilder()

Wrap this FirewallPolicy to a builder

Specified by:

toBuilder in interface Buildable<FirewallPolicyBuilder>

Returns:

FirewallPolicyBuilder

builder

public static FirewallPolicyBuilder builder()

Returns:

FirewallPolicyBuilder

getId

public String getId()

Specified by:

getId in interface FirewallPolicy

Returns:

id : Unique identifier for the firewall policy.

getName

public String getName()

Specified by:

getName in interface FirewallPolicy

Returns:

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

getTenantId

public String getTenantId()

Specified by:

getTenantId in interface FirewallPolicy

Returns:

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

getDescription

public String getDescription()

Specified by:

getDescription in interface FirewallPolicy

Returns:

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

isShared

public Boolean isShared()

Specified by:

isShared in interface FirewallPolicy

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

public Boolean isAudited()

Specified by:

isAudited in interface FirewallPolicy

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

public List<String> getFirewallRuleIds()

Specified by:

getFirewallRuleIds in interface FirewallPolicy

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.

getNeutronFirewallRules

public List<? extends FirewallRule> getNeutronFirewallRules()

Specified by:

getNeutronFirewallRules in interface FirewallPolicy

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

getFirewallList

public List<String> getFirewallList()

Specified by:

getFirewallList in interface FirewallPolicy

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.

toString

public String toString()

Overrides:

toString in class Object