org.onosproject.acl

Class AclWebResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.acl.AclWebResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

@Path(value="rules")
public class AclWebResource
extends org.onosproject.rest.AbstractWebResource

Manage ACL rules.

Constructor Summary

Constructors

Constructor and Description
AclWebResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addAclRule(InputStream stream) Add a new ACL rule.
javax.ws.rs.core.Response	clearAcl() Remove all ACL rules.
javax.ws.rs.core.Response	queryAclRule() Get all ACL rules.
javax.ws.rs.core.Response	removeAclRule(String id) Remove ACL rule.

Methods inherited from class org.onosproject.rest.AbstractWebResource

codec, encodeArray, getService, mapper, newArray, newObject

Methods inherited from class org.onlab.rest.BaseResource

get, ok, setServiceDirectory

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.codec.CodecContext

decode, encode

Constructor Detail

AclWebResource

public AclWebResource()

Method Detail

queryAclRule

@GET
public javax.ws.rs.core.Response queryAclRule()

Get all ACL rules. Returns array of all ACL rules.

Returns:

200 OK

addAclRule

@POST
 @Consumes(value="application/json")
public javax.ws.rs.core.Response addAclRule(InputStream stream)
                                                                                throws URISyntaxException

Add a new ACL rule.

Parameters:

stream - JSON data describing the rule

Returns:

200 OK

Throws:

URISyntaxException - uri syntax exception

removeAclRule

@DELETE
 @Path(value="{id}")
public javax.ws.rs.core.Response removeAclRule(@PathParam(value="id")
                                                                            String id)

Remove ACL rule.

Parameters:

id - ACL rule id (in hex string format)

Returns:

204 NO CONTENT

clearAcl

@DELETE
public javax.ws.rs.core.Response clearAcl()

Remove all ACL rules.

Returns:

204 NO CONTENT