Package org.openstack4j.api.networking.ext

Interface FirewallPolicyService

All Superinterfaces:

RestService

All Known Implementing Classes:

FirewallPolicyServiceImpl

public interface FirewallPolicyService
extends RestService

Networking (Neutron) FwaaS FirewallPolicy Policy Extension API

Represents an ordered collection of FirewallPolicy rules. A FirewallPolicy 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 FirewallPolicy policy).

The FWaaS extension provides OpenStack users with the ability to deploy firewalls to protect their networks. The FWaaS extension enables you to:

• Apply FirewallPolicy rules on traffic entering and leaving tenant networks.
• Support for applying tcp, udp, icmp, or protocol agnostic rules.
• Creation and sharing of FirewallPolicy policies which hold an ordered collection of the FirewallPolicy rules.
• Audit FirewallPolicy rules and policies.

Author:

Vishvesh Deshmukh

Method Summary

Modifier and Type	Method	Description
FirewallPolicy	create(FirewallPolicy firewallPolicy)	Create a FirewallPolicy
ActionResponse	delete(String firewallPolicyId)	Delete the specified FirewallPolicy by ID
FirewallPolicy	get(String firewallPolicyId)	Get the specified FirewallPolicy by ID
FirewallPolicy	insertFirewallRuleInPolicy(String firewallPolicyId, String firewallRuleId, FirewallRuleStrategy.RuleInsertStrategyType type, String insertAfterOrBeforeRuleId)	Inserts a firewall rule in a firewall policy relative to the position of other rules.
List<? extends FirewallPolicy>	list()	List all FirewallPolicy(s) that the current tenant has access to.
List<? extends FirewallPolicy>	list(Map<String,String> filteringParams)	Returns list of FirewallPolicy(s) filtered by parameters.
FirewallPolicy	removeFirewallRuleFromPolicy(String firewallPolicyId, String firewallRuleId)	Removes a firewall rule from a firewall policy.
FirewallPolicy	update(String firewallPolicyId, FirewallPolicyUpdate firewallPolicyUpdate)	Update a FirewallPolicy

Method Detail

list

List<? extends FirewallPolicy> list()

List all FirewallPolicy(s) that the current tenant has access to.

Returns:

list of all FirewallPolicy(s)

list

List<? extends FirewallPolicy> list(Map<String,String> filteringParams)

Returns list of FirewallPolicy(s) filtered by parameters.

Parameters:

filteringParams - map (name, value) of filtering parameters

Returns:

filtered list of FirewallPolicy(s)

get

FirewallPolicy get(String firewallPolicyId)

Get the specified FirewallPolicy by ID

Parameters:

firewallPolicyId - the FirewallPolicy identifier

Returns:

the FirewallPolicy or null if not found

delete

ActionResponse delete(String firewallPolicyId)

Delete the specified FirewallPolicy by ID

Parameters:

firewallPolicyId - the FirewallPolicy identifier

Returns:

the action response

create

FirewallPolicy create(FirewallPolicy firewallPolicy)

Create a FirewallPolicy

Returns:

FirewallPolicy

update

FirewallPolicy update(String firewallPolicyId,
                      FirewallPolicyUpdate firewallPolicyUpdate)

Update a FirewallPolicy

Parameters:

firewallPolicyId - the FirewallPolicy identifier

firewallPolicyUpdate - FirewallUpdate

Returns:

FirewallPolicy

insertFirewallRuleInPolicy

FirewallPolicy insertFirewallRuleInPolicy(String firewallPolicyId,
                                          String firewallRuleId,
                                          FirewallRuleStrategy.RuleInsertStrategyType type,
                                          String insertAfterOrBeforeRuleId)

Inserts a firewall rule in a firewall policy relative to the position of other rules.

Parameters:

firewallPolicyId - rule inserted in FirewallPolicy

firewallRuleId - rule to be inserted

type - FirewallRuleStrategy.RuleInsertStrategyType

insertAfterOrBeforeRuleId - rule id where the new firewallRule will be inserted/switched from

Returns:

FirewallPolicy

removeFirewallRuleFromPolicy

FirewallPolicy removeFirewallRuleFromPolicy(String firewallPolicyId,
                                            String firewallRuleId)

Removes a firewall rule from a firewall policy.

Parameters:

firewallRuleId - rule to be deleted.

Returns:

FirewallPolicy