org.onosproject.rest.resources

Class NetworkConfigWebResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.rest.resources.NetworkConfigWebResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

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

Manage network configurations.

Constructor Summary

Constructors

Constructor and Description
NetworkConfigWebResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	delete() Clear entire network configuration base.
javax.ws.rs.core.Response	delete(String subjectClassKey) Clear all network configurations for a subject class.
javax.ws.rs.core.Response	delete(String subjectClassKey, String subjectKey) Clear all network configurations for a subjectKey.
javax.ws.rs.core.Response	delete(String subjectClassKey, String subjectKey, String configKey) Clear specific network configuration for a subjectKey.
javax.ws.rs.core.Response	download() Gets entire network configuration base.
javax.ws.rs.core.Response	download(String subjectClassKey) Gets all network configuration for a subject class.
javax.ws.rs.core.Response	download(String subjectClassKey, String subjectKey) Gets all network configuration for a subjectKey.
javax.ws.rs.core.Response	download(String subjectClassKey, String subjectKey, String configKey) Gets specific network configuration for a subjectKey.
javax.ws.rs.core.Response	upload(InputStream request) Uploads bulk network configuration.
javax.ws.rs.core.Response	upload(String subjectClassKey, InputStream request) Upload multiple network configurations for a subject class.
javax.ws.rs.core.Response	upload(String subjectClassKey, String subjectKey, InputStream request) Upload mutliple network configurations for a subjectKey.
javax.ws.rs.core.Response	upload(String subjectClassKey, String subjectKey, String configKey, InputStream request) Upload specific network configuration for a subjectKey.

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

NetworkConfigWebResource

public NetworkConfigWebResource()

Method Detail

download

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

Gets entire network configuration base.

Returns:

200 OK with network configuration JSON

download

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

Gets all network configuration for a subject class.

Parameters:

subjectClassKey - subject class key

Returns:

200 OK with network configuration JSON

download

@GET
 @Path(value="{subjectClassKey}/{subjectKey}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response download(@PathParam(value="subjectClassKey")
                                                                                                                                   String subjectClassKey,
                                                                                                                                   @PathParam(value="subjectKey")
                                                                                                                                   String subjectKey)

Gets all network configuration for a subjectKey.

Parameters:

subjectClassKey - subjectKey class key

subjectKey - subjectKey key

Returns:

200 OK with network configuration JSON

download

@GET
 @Path(value="{subjectClassKey}/{subjectKey}/{configKey}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response download(@PathParam(value="subjectClassKey")
                                                                                                                                               String subjectClassKey,
                                                                                                                                               @PathParam(value="subjectKey")
                                                                                                                                               String subjectKey,
                                                                                                                                               @PathParam(value="configKey")
                                                                                                                                               String configKey)

Gets specific network configuration for a subjectKey.

Parameters:

subjectClassKey - subjectKey class key

subjectKey - subjectKey key

configKey - configuration class key

Returns:

200 OK with network configuration JSON

upload

@POST
 @Consumes(value="application/json")
public javax.ws.rs.core.Response upload(InputStream request)
                                                                            throws IOException

Uploads bulk network configuration.

Parameters:

request - network configuration JSON rooted at the top node

Returns:

200 OK

Throws:

IOException - if unable to parse the request

upload

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

Upload multiple network configurations for a subject class.

Parameters:

subjectClassKey - subject class key

request - network configuration JSON rooted at the top node

Returns:

200 OK

Throws:

IOException - if unable to parse the request

upload

@POST
 @Path(value="{subjectClassKey}/{subjectKey}")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response upload(@PathParam(value="subjectClassKey")
                                                                                                                                  String subjectClassKey,
                                                                                                                                  @PathParam(value="subjectKey")
                                                                                                                                  String subjectKey,
                                                                                                                                  InputStream request)
                                                                                                                           throws IOException

Upload mutliple network configurations for a subjectKey.

Parameters:

subjectClassKey - subjectKey class key

subjectKey - subjectKey key

request - network configuration JSON rooted at the top node

Returns:

200 OK

Throws:

IOException - if unable to parse the request

upload

@POST
 @Path(value="{subjectClassKey}/{subjectKey}/{configKey}")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response upload(@PathParam(value="subjectClassKey")
                                                                                                                                              String subjectClassKey,
                                                                                                                                              @PathParam(value="subjectKey")
                                                                                                                                              String subjectKey,
                                                                                                                                              @PathParam(value="configKey")
                                                                                                                                              String configKey,
                                                                                                                                              InputStream request)
                                                                                                                                       throws IOException

Upload specific network configuration for a subjectKey.

Parameters:

subjectClassKey - subjectKey class key

subjectKey - subjectKey key

configKey - configuration class key

request - network configuration JSON rooted at the top node

Returns:

200 OK

Throws:

IOException - if unable to parse the request

delete

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

Clear entire network configuration base.

Returns:

204 NO CONTENT

delete

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

Clear all network configurations for a subject class.

Parameters:

subjectClassKey - subject class key

Returns:

204 NO CONTENT

delete

@DELETE
 @Path(value="{subjectClassKey}/{subjectKey}")
public javax.ws.rs.core.Response delete(@PathParam(value="subjectClassKey")
                                                                                               String subjectClassKey,
                                                                                               @PathParam(value="subjectKey")
                                                                                               String subjectKey)

Clear all network configurations for a subjectKey.

Parameters:

subjectClassKey - subjectKey class key

subjectKey - subjectKey key

Returns:

204 NO CONTENT

delete

@DELETE
 @Path(value="{subjectClassKey}/{subjectKey}/{configKey}")
public javax.ws.rs.core.Response delete(@PathParam(value="subjectClassKey")
                                                                                                           String subjectClassKey,
                                                                                                           @PathParam(value="subjectKey")
                                                                                                           String subjectKey,
                                                                                                           @PathParam(value="configKey")
                                                                                                           String configKey)

Clear specific network configuration for a subjectKey.

Parameters:

subjectClassKey - subjectKey class key

subjectKey - subjectKey key

configKey - configuration class key

Returns:

204 NO CONTENT