Package org.opendaylight.neutron.northbound.api

Class NeutronFirewallRulesNorthbound

java.lang.Object

org.opendaylight.neutron.northbound.api.AbstractNeutronNorthbound<NeutronFirewallRule,NeutronFirewallRuleRequest,INeutronFirewallRuleCRUD>

org.opendaylight.neutron.northbound.api.NeutronFirewallRulesNorthbound

@Singleton
@Path("fw/firewall_rules")
public final class NeutronFirewallRulesNorthbound
extends AbstractNeutronNorthbound<NeutronFirewallRule,NeutronFirewallRuleRequest,INeutronFirewallRuleCRUD>

Neutron Northbound REST APIs for Firewall Rule.

Field Summary

Fields inherited from class org.opendaylight.neutron.northbound.api.AbstractNeutronNorthbound

HTTP_OK_BOTTOM, HTTP_OK_TOP

Constructor Summary

Constructors

Constructor	Description
NeutronFirewallRulesNorthbound(INeutronFirewallRuleCRUD neutronCRUD)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	createFirewallRules(NeutronFirewallRuleRequest input)	Creates new Firewall Rule.
javax.ws.rs.core.Response	deleteFirewallRule(String firewallRuleUUID)	Deletes a Firewall Rule.
protected String	getResourceName()
javax.ws.rs.core.Response	listRules(List<String> fields, String queryFirewallRuleUUID, String queryFirewallRuleTenantID, String queryFirewallRuleName, Boolean queryFirewallRuleIsShared, String queryFirewallRulePolicyID, String queryFirewallRuleProtocol, Integer queryFirewallRuleIpVer, String queryFirewallRuleSrcIpAddr, String queryFirewallRuleDstIpAddr, Integer queryFirewallRuleSrcPortRangeMin, Integer queryFirewallRuleSrcPortRangeMax, Integer queryFirewallRuleDstPortRangeMin, Integer queryFirewallRuleDstPortRangeMax, Integer queryFirewallRulePosition, String queryFirewallRuleAction, Boolean queryFirewallRuleIsEnabled, String limit, String marker, String pageReverse)	Returns a list of all Firewall Rules.
javax.ws.rs.core.Response	showFirewallRule(String firewallRuleUUID, List<String> fields)	Returns a specific Firewall Rule.
javax.ws.rs.core.Response	updateFirewallRule(String firewallRuleUUID, NeutronFirewallRuleRequest input)	Updates a Firewall Rule.

Methods inherited from class org.opendaylight.neutron.northbound.api.AbstractNeutronNorthbound

create, delete, getNeutronCRUD, serviceUnavailable, show, update, updateDelta, uuidNoExist

Methods inherited from class java.lang.Object

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

Constructor Detail

NeutronFirewallRulesNorthbound

@Inject
public NeutronFirewallRulesNorthbound(INeutronFirewallRuleCRUD neutronCRUD)

Method Detail

getResourceName

protected String getResourceName()

Specified by:

getResourceName in class AbstractNeutronNorthbound<NeutronFirewallRule,NeutronFirewallRuleRequest,INeutronFirewallRuleCRUD>

listRules

@GET
@Produces("application/json")
public javax.ws.rs.core.Response listRules(@QueryParam("fields")
                                           List<String> fields,
                                           @QueryParam("id")
                                           String queryFirewallRuleUUID,
                                           @QueryParam("tenant_id")
                                           String queryFirewallRuleTenantID,
                                           @QueryParam("name")
                                           String queryFirewallRuleName,
                                           @QueryParam("shared")
                                           Boolean queryFirewallRuleIsShared,
                                           @QueryParam("firewall_policy_id")
                                           String queryFirewallRulePolicyID,
                                           @QueryParam("protocol")
                                           String queryFirewallRuleProtocol,
                                           @QueryParam("ip_version")
                                           Integer queryFirewallRuleIpVer,
                                           @QueryParam("source_ip_address")
                                           String queryFirewallRuleSrcIpAddr,
                                           @QueryParam("destination_ip_address")
                                           String queryFirewallRuleDstIpAddr,
                                           @QueryParam("source_port_range_min")
                                           Integer queryFirewallRuleSrcPortRangeMin,
                                           @QueryParam("source_port_range_max")
                                           Integer queryFirewallRuleSrcPortRangeMax,
                                           @QueryParam("destination_port_range_min")
                                           Integer queryFirewallRuleDstPortRangeMin,
                                           @QueryParam("destination_port_range_max")
                                           Integer queryFirewallRuleDstPortRangeMax,
                                           @QueryParam("position")
                                           Integer queryFirewallRulePosition,
                                           @QueryParam("action")
                                           String queryFirewallRuleAction,
                                           @QueryParam("enabled")
                                           Boolean queryFirewallRuleIsEnabled,
                                           @QueryParam("limit")
                                           String limit,
                                           @QueryParam("marker")
                                           String marker,
                                           @QueryParam("page_reverse")
                                           String pageReverse)

Returns a list of all Firewall Rules.

showFirewallRule

@Path("{firewallRuleUUID}")
@GET
@Produces("application/json")
public javax.ws.rs.core.Response showFirewallRule(@PathParam("firewallRuleUUID")
                                                  String firewallRuleUUID,
                                                  @QueryParam("fields")
                                                  List<String> fields)

Returns a specific Firewall Rule.

createFirewallRules

@POST
@Produces("application/json")
@Consumes("application/json")
public javax.ws.rs.core.Response createFirewallRules(NeutronFirewallRuleRequest input)

Creates new Firewall Rule.

updateFirewallRule

@Path("{firewallRuleUUID}")
@PUT
@Produces("application/json")
@Consumes("application/json")
public javax.ws.rs.core.Response updateFirewallRule(@PathParam("firewallRuleUUID")
                                                    String firewallRuleUUID,
                                                    NeutronFirewallRuleRequest input)

Updates a Firewall Rule.

deleteFirewallRule

@Path("{firewallRuleUUID}")
@DELETE
public javax.ws.rs.core.Response deleteFirewallRule(@PathParam("firewallRuleUUID")
                                                    String firewallRuleUUID)

Deletes a Firewall Rule.