Package org.jclouds.openstack.neutron.v2.extensions

Interface FWaaSApi

@Beta
@Path("/fw")
@Consumes("application/json")
public interface FWaaSApi

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

See Also:

api doc, extension info

Method Summary

Modifier and Type	Method	Description
Firewall	create(CreateFirewall firewall)	Create a new firewall
FirewallPolicy	createFirewallPolicy(CreateFirewallPolicy firewallPolicy)
FirewallRule	createFirewallRule(CreateFirewallRule firewallRule)
boolean	delete(String id)	Deletes the specified firewall
boolean	deleteFirewallPolicy(String id)
boolean	deleteFirewallRule(String id)
Firewall	get(String id)	Returns the details for a specific firewall.
FirewallPolicy	getFirewallPolicy(String id)
FirewallRule	getFirewallRule(String firewallRuleId)
FirewallPolicy	insertFirewallRuleToPolicy(String policyId, String firewallRuleId)
PagedIterable<Firewall>	list()	Returns the list of all routers currently defined in Neutron for the current tenant.
PaginatedCollection<Firewall>	list(PaginationOptions options)
PagedIterable<FirewallPolicy>	listFirewallPolicies()
PaginatedCollection<FirewallPolicy>	listFirewallPolicies(PaginationOptions options)
PagedIterable<FirewallRule>	listFirewallRules()
PaginatedCollection<FirewallRule>	listFirewallRules(PaginationOptions options)
FirewallPolicy	removeFirewallRuleFromPolicy(String policyId, String firewallRuleId)
Firewall	update(String id, UpdateFirewall updateFirewall)	Update a firewall
FirewallPolicy	updateFirewallPolicy(String id, UpdateFirewallPolicy updateFirewallPolicy)
FirewallRule	updateFirewallRule(String id, UpdateFirewallRule updateFirewallRule)

Method Detail

list

@Named("fw:list")
@GET
@Path("/firewalls")
PagedIterable<Firewall> list()

Returns the list of all routers currently defined in Neutron for the current tenant. The list provides the unique identifier of each firewall configured for the tenant

Returns:

the list of all firewall references configured for the tenant.

list

@Named("firewall:list")
@GET
@Path("/firewalls")
PaginatedCollection<Firewall> list(PaginationOptions options)

Returns:

the list of all firewall references configured for the tenant.

get

@Named("firewall:get")
@GET
@Path("/firewalls/{id}")
@Nullable
Firewall get(@PathParam("id")
             String id)

Returns the details for a specific firewall.

Parameters:

id - the id of the firewall to return

Returns:

firewall or empty if not found

create

@Named("firewall:create")
@POST
@Path("/firewalls")
Firewall create(CreateFirewall firewall)

Create a new firewall

Parameters:

firewall - Options for creating a firewall

Returns:

the newly created firewall

update

@Named("firewall:update")
@PUT
@Path("/firewalls/{id}")
Firewall update(@PathParam("id")
                String id,
                UpdateFirewall updateFirewall)

Update a firewall

Parameters:

id - the id of the firewall to update

updateFirewall - Contains only the attributes to update

Returns:

The modified firewall

delete

@Named("firewall:delete")
@DELETE
@Path("/firewalls/{id}")
boolean delete(@PathParam("id")
               String id)

Deletes the specified firewall

Parameters:

id - the id of the firewall to delete

Returns:

true if delete successful, false if not

createFirewallPolicy

@Named("firewall:createPolicy")
@POST
@Path("/firewall_policies")
FirewallPolicy createFirewallPolicy(CreateFirewallPolicy firewallPolicy)

listFirewallPolicies

@Named("firewall:listPolicies")
@GET
@Path("/firewall_policies")
PagedIterable<FirewallPolicy> listFirewallPolicies()

listFirewallPolicies

@Named("firewall:listPolicies")
@GET
@Path("/firewall_policies")
PaginatedCollection<FirewallPolicy> listFirewallPolicies(PaginationOptions options)

getFirewallPolicy

@Named("firewall:getPolicy")
@GET
@Path("/firewall_policies/{id}")
FirewallPolicy getFirewallPolicy(@PathParam("id")
                                 String id)

updateFirewallPolicy

@Named("firewall:updatePolicy")
@PUT
@Path("/firewall_policies/{id}")
FirewallPolicy updateFirewallPolicy(@PathParam("id")
                                    String id,
                                    UpdateFirewallPolicy updateFirewallPolicy)

deleteFirewallPolicy

@Named("firewall:deletePolicy")
@DELETE
@Path("/firewall_policies/{id}")
boolean deleteFirewallPolicy(@PathParam("id")
                             String id)

createFirewallRule

@Named("firewall:createFirewallRule")
@POST
@Path("/firewall_rules")
FirewallRule createFirewallRule(CreateFirewallRule firewallRule)

listFirewallRules

@Named("firewall:listFirewallRules")
@GET
@Path("/firewall_rules")
PagedIterable<FirewallRule> listFirewallRules()

listFirewallRules

@Named("firewall:listFirewallRules")
@GET
@Path("/firewall_rules")
PaginatedCollection<FirewallRule> listFirewallRules(PaginationOptions options)

getFirewallRule

@Named("firewall:getFirewallRule")
@GET
@Path("/firewall_rules/{id}")
@Nullable
FirewallRule getFirewallRule(@PathParam("id")
                             String firewallRuleId)

updateFirewallRule

@Named("firewall:updateFirewallRule")
@PUT
@Path("/firewall_rules/{id}")
FirewallRule updateFirewallRule(@PathParam("id")
                                String id,
                                UpdateFirewallRule updateFirewallRule)

deleteFirewallRule

@Named("firewall:deleteFirewallRule")
@DELETE
@Path("/firewall_rules/{id}")
boolean deleteFirewallRule(@PathParam("id")
                           String id)

insertFirewallRuleToPolicy

@Named("firewall:insertFirewallRuleToPolicy")
@PUT
@Path("/firewall_policies/{id}/insert_rule")
FirewallPolicy insertFirewallRuleToPolicy(@PathParam("id")
                                          String policyId,
                                          String firewallRuleId)

removeFirewallRuleFromPolicy

@Named("firewall:removeFirewallRuleFromPolicy")
@DELETE
@Path("/firewall_policies/{id}/remove_rule")
@Nullable
FirewallPolicy removeFirewallRuleFromPolicy(@PathParam("id")
                                            String policyId,
                                            String firewallRuleId)