Package org.opendaylight.neutron.northbound.api

Class NeutronSecurityGroupsNorthbound

java.lang.Object

org.opendaylight.neutron.northbound.api.AbstractNeutronNorthbound<NeutronSecurityGroup,NeutronSecurityGroupRequest,INeutronSecurityGroupCRUD>

org.opendaylight.neutron.northbound.api.NeutronSecurityGroupsNorthbound

@Singleton
@Path("/security-groups")
public final class NeutronSecurityGroupsNorthbound
extends AbstractNeutronNorthbound<NeutronSecurityGroup,NeutronSecurityGroupRequest,INeutronSecurityGroupCRUD>

Neutron Northbound REST APIs for Security Group.

Field Summary

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

HTTP_OK_BOTTOM, HTTP_OK_TOP

Constructor Summary

Constructors

Constructor	Description
NeutronSecurityGroupsNorthbound(INeutronSecurityGroupCRUD neutronCRUD)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	createSecurityGroups(NeutronSecurityGroupRequest input)	Creates new Security Group.
javax.ws.rs.core.Response	deleteSecurityGroup(String securityGroupUUID)	Deletes a Security Group.
protected String	getResourceName()
javax.ws.rs.core.Response	listGroups(List<String> fields, String querySecurityGroupUUID, String querySecurityGroupName, String querySecurityTenantID, String limit, String marker, String pageReverse)	Returns a list of all Security Groups.
javax.ws.rs.core.Response	showSecurityGroup(String securityGroupUUID, List<String> fields)	Returns a specific Security Group.
javax.ws.rs.core.Response	updateSecurityGroup(String securityGroupUUID, NeutronSecurityGroupRequest input)	Updates a Security Group.

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

NeutronSecurityGroupsNorthbound

@Inject
public NeutronSecurityGroupsNorthbound(INeutronSecurityGroupCRUD neutronCRUD)

Method Detail

getResourceName

protected String getResourceName()

Specified by:

getResourceName in class AbstractNeutronNorthbound<NeutronSecurityGroup,NeutronSecurityGroupRequest,INeutronSecurityGroupCRUD>

listGroups

@GET
@Produces("application/json")
public javax.ws.rs.core.Response listGroups(@QueryParam("fields")
                                            List<String> fields,
                                            @QueryParam("id")
                                            String querySecurityGroupUUID,
                                            @QueryParam("name")
                                            String querySecurityGroupName,
                                            @QueryParam("tenant_id")
                                            String querySecurityTenantID,
                                            @QueryParam("limit")
                                            String limit,
                                            @QueryParam("marker")
                                            String marker,
                                            @QueryParam("page_reverse")
                                            String pageReverse)

Returns a list of all Security Groups.

showSecurityGroup

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

Returns a specific Security Group.

createSecurityGroups

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

Creates new Security Group.

updateSecurityGroup

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

Updates a Security Group.

deleteSecurityGroup

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

Deletes a Security Group.