Package org.opendaylight.neutron.northbound.api

Class NeutronSecurityRulesNorthbound

java.lang.Object

org.opendaylight.neutron.northbound.api.AbstractNeutronNorthbound<NeutronSecurityRule,NeutronSecurityRuleRequest,INeutronSecurityRuleCRUD>

org.opendaylight.neutron.northbound.api.NeutronSecurityRulesNorthbound

@Singleton
@Path("/security-group-rules")
public final class NeutronSecurityRulesNorthbound
extends AbstractNeutronNorthbound<NeutronSecurityRule,NeutronSecurityRuleRequest,INeutronSecurityRuleCRUD>

Neutron Northbound REST APIs for Security Rule.

Field Summary

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

HTTP_OK_BOTTOM, HTTP_OK_TOP

Constructor Summary

Constructors

Constructor	Description
NeutronSecurityRulesNorthbound(INeutronSecurityRuleCRUD neutronCRUD)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	createSecurityRules(NeutronSecurityRuleRequest input)	Creates new Security Rule.
javax.ws.rs.core.Response	deleteSecurityRule(String securityRuleUUID)	Deletes a Security Rule.
protected String	getResourceName()
javax.ws.rs.core.Response	listRules(List<String> fields, String querySecurityRuleUUID, String querySecurityRuleDirection, String querySecurityRuleProtocol, Integer querySecurityRulePortMin, Integer querySecurityRulePortMax, String querySecurityRuleEthertype, String querySecurityRuleIpPrefix, String querySecurityRemoteGroupID, String querySecurityRuleGroupID, String querySecurityRuleTenantID, String limit, String marker, String pageReverse)	Returns a list of all Security Rules.
javax.ws.rs.core.Response	showSecurityRule(String securityRuleUUID, List<String> fields)	Returns a specific Security Rule.
javax.ws.rs.core.Response	updateSecurityRule(String securityRuleUUID, NeutronSecurityRuleRequest input)	Updates a Security 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

NeutronSecurityRulesNorthbound

@Inject
public NeutronSecurityRulesNorthbound(INeutronSecurityRuleCRUD neutronCRUD)

Method Detail

getResourceName

protected String getResourceName()

Specified by:

getResourceName in class AbstractNeutronNorthbound<NeutronSecurityRule,NeutronSecurityRuleRequest,INeutronSecurityRuleCRUD>

listRules

@GET
@Produces("application/json")
public javax.ws.rs.core.Response listRules(@QueryParam("fields")
                                           List<String> fields,
                                           @QueryParam("id")
                                           String querySecurityRuleUUID,
                                           @QueryParam("direction")
                                           String querySecurityRuleDirection,
                                           @QueryParam("protocol")
                                           String querySecurityRuleProtocol,
                                           @QueryParam("port_range_min")
                                           Integer querySecurityRulePortMin,
                                           @QueryParam("port_range_max")
                                           Integer querySecurityRulePortMax,
                                           @QueryParam("ethertype")
                                           String querySecurityRuleEthertype,
                                           @QueryParam("remote_ip_prefix")
                                           String querySecurityRuleIpPrefix,
                                           @QueryParam("remote_group_id")
                                           String querySecurityRemoteGroupID,
                                           @QueryParam("security_group_id")
                                           String querySecurityRuleGroupID,
                                           @QueryParam("tenant_id")
                                           String querySecurityRuleTenantID,
                                           @QueryParam("limit")
                                           String limit,
                                           @QueryParam("marker")
                                           String marker,
                                           @QueryParam("page_reverse")
                                           String pageReverse)

Returns a list of all Security Rules.

showSecurityRule

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

Returns a specific Security Rule.

createSecurityRules

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

Creates new Security Rule.

updateSecurityRule

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

Updates a Security Rule.

deleteSecurityRule

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

Deletes a Security Rule.