org.openstack4j.openstack.networking.domain.ext

Class NeutronFirewallRule

java.lang.Object

org.openstack4j.openstack.networking.domain.ext.NeutronFirewallRule

All Implemented Interfaces:

Serializable, Buildable<FirewallRuleBuilder>, ModelEntity, FirewallRule

public class NeutronFirewallRule
extends Object
implements FirewallRule

A Neutron Firewall (FwaaS) : Firewall Rule Entity.

Author:

Vishvesh Deshmukh

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NeutronFirewallRule.FirewallRuleAction Action of a Neutron (Firewall Rule - FwaaS) entity.
static class	NeutronFirewallRule.FirewallRuleConcreteBuilder
static class	NeutronFirewallRule.FirewallRules
static class	NeutronFirewallRule.IPProtocol IPProtocolType of a Neutron (Firewall Rule - FwaaS) entity.

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

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

Constructor Summary

Constructors

Constructor and Description
NeutronFirewallRule()

Method Summary

Modifier and Type	Method and Description
static FirewallRuleBuilder	builder()
NeutronFirewallRule.FirewallRuleAction	getAction()
String	getDescription()
String	getDestinationIpAddress()
String	getDestinationPort()
String	getId()
IPVersionType	getIpVersion()
String	getName()
String	getPolicy()
Integer	getPosition()
NeutronFirewallRule.IPProtocol	getProtocol()
String	getSourceIpAddress()
String	getSourcePort()
String	getTenantId()
Boolean	isEnabled()
Boolean	isShared()
FirewallRuleBuilder	toBuilder() Wrap this FirewallRule to a builder
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

NeutronFirewallRule

public NeutronFirewallRule()

Method Detail

toBuilder

public FirewallRuleBuilder toBuilder()

Wrap this FirewallRule to a builder

Specified by:

toBuilder in interface Buildable<FirewallRuleBuilder>

Returns:

FirewallRuleBuilder

builder

public static FirewallRuleBuilder builder()

Returns:

FirewallRuleBuilder

getId

public String getId()

Specified by:

getId in interface FirewallRule

Returns:

id : Unique identifier for the firewall rule object.

getName

public String getName()

Specified by:

getName in interface FirewallRule

Returns:

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

getTenantId

public String getTenantId()

Specified by:

getTenantId in interface FirewallRule

Returns:

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

getDescription

public String getDescription()

Specified by:

getDescription in interface FirewallRule

Returns:

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

isShared

public Boolean isShared()

Specified by:

isShared in interface FirewallRule

Returns:

shared : When set to True makes this firewall rule visible to tenants other than its owner, and can be used in firewall policies not owned by its tenant.

getPolicy

public String getPolicy()

Specified by:

getPolicy in interface FirewallRule

Returns:

policyid : This is a read-only attribute which gets populated with the uuid of the firewall policy when this firewall rule is associated with a firewall policy. A firewall rule can be associated with one firewall policy at a time. The association can however be updated to a different firewall policy. This attribute can be null if the rule is not associated with any firewall policy.

getProtocol

public NeutronFirewallRule.IPProtocol getProtocol()

Specified by:

getProtocol in interface FirewallRule

Returns:

protocol : IP Protocol : Possible values are ICMP/TCP/UDP/NONE(ANY).

See Also:

NeutronFirewallRule.IPProtocol

getIpVersion

public IPVersionType getIpVersion()

Specified by:

getIpVersion in interface FirewallRule

Returns:

ipVersion : IP Protocol Version : Possible values are 4/6.

See Also:

IPVersionType

getSourceIpAddress

public String getSourceIpAddress()

Specified by:

getSourceIpAddress in interface FirewallRule

Returns:

sourceIpAddress or CIDR : Valid IP address (v4 or v6), or CIDR.

getDestinationIpAddress

public String getDestinationIpAddress()

Specified by:

getDestinationIpAddress in interface FirewallRule

Returns:

destinationIpAddress or CIDR : Valid IP address (v4 or v6), or CIDR.

getSourcePort

public String getSourcePort()

Specified by:

getSourcePort in interface FirewallRule

Returns:

sourcePort : Valid port number (integer or string), or port range in the format of a ':' separated range). In the case of port range, both ends of the range are included.

getDestinationPort

public String getDestinationPort()

Specified by:

getDestinationPort in interface FirewallRule

Returns:

destinationPort : Valid port number (integer or string), or port range in the format of a ':' separated range). In the case of port range, both ends of the range are included.

getPosition

public Integer getPosition()

Specified by:

getPosition in interface FirewallRule

Returns:

position : This is a read-only attribute that gets assigned to this rule when the rule is associated with a firewall policy. It indicates the position of this rule in that firewall policy. This position number starts at 1. The position can be null if the firewall rule is not associated with any policy.

getAction

public NeutronFirewallRule.FirewallRuleAction getAction()

Specified by:

getAction in interface FirewallRule

Returns:

action : Action to be performed on the traffic matching the rule (allow, deny).

See Also:

NeutronFirewallRule.FirewallRuleAction

isEnabled

public Boolean isEnabled()

Specified by:

isEnabled in interface FirewallRule

Returns:

enabled : When set to False will disable this rule in the firewall policy. Facilitates selectively turning off rules without having to disassociate the rule from the firewall policy.

toString

public String toString()

Overrides:

toString in class Object