org.onosproject.rest.resources

Class ComponentConfigWebResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.rest.resources.ComponentConfigWebResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

@Path(value="configuration")
public class ComponentConfigWebResource
extends org.onosproject.rest.AbstractWebResource

Manage component configurations.

Constructor Summary

Constructors

Constructor and Description
ComponentConfigWebResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getComponentConfigs() Gets all component configurations.
javax.ws.rs.core.Response	getComponentConfigs(String component) Gets configuration of the specified component.
javax.ws.rs.core.Response	setConfigs(String component, boolean preset, InputStream request) Selectively sets configuration properties.
javax.ws.rs.core.Response	unsetConfigs(String component, InputStream request) Selectively clears configuration properties.

Methods inherited from class org.onosproject.rest.AbstractWebResource

codec, encodeArray, getService, mapper, newArray, newObject

Methods inherited from class org.onlab.rest.BaseResource

get, ok

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

ComponentConfigWebResource

public ComponentConfigWebResource()

Method Detail

getComponentConfigs

@GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response getComponentConfigs()

Gets all component configurations. Returns collection of all registered component configurations.

Returns:

200 OK with a collection of component configurations

getComponentConfigs

@GET
 @Path(value="{component}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getComponentConfigs(@PathParam(value="component")
                                                                                                                           String component)

Gets configuration of the specified component.

Parameters:

component - component name

Returns:

200 OK with a collection of component configurations

setConfigs

@POST
 @Consumes(value="application/json")
 @Path(value="{component}")
public javax.ws.rs.core.Response setConfigs(@PathParam(value="component")
                                                                                                                   String component,
                                                                                                                   @DefaultValue(value="false") @QueryParam(value="preset")
                                                                                                                   boolean preset,
                                                                                                                   InputStream request)
                                                                                                            throws IOException

Selectively sets configuration properties. Sets only the properties present in the JSON request.

Parameters:

component - component name

preset - preset the property if true

request - JSON configuration

Returns:

200 OK

Throws:

IOException - to signify bad request

unsetConfigs

@DELETE
 @Consumes(value="application/json")
 @Path(value="{component}")
public javax.ws.rs.core.Response unsetConfigs(@PathParam(value="component")
                                                                                                                       String component,
                                                                                                                       InputStream request)
                                                                                                                throws IOException

Selectively clears configuration properties. Clears only the properties present in the JSON request.

Parameters:

component - component name

request - JSON configuration

Returns:

204 NO CONTENT

Throws:

IOException - to signify bad request