org.onosproject.rest.resources

Class ApplicationsWebResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.rest.resources.ApplicationsWebResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

@Path(value="applications")
public class ApplicationsWebResource
extends org.onosproject.rest.AbstractWebResource

Manage inventory of applications.

Constructor Summary

Constructors

Constructor and Description
ApplicationsWebResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	activateApp(String name) Activate application.
javax.ws.rs.core.Response	deactivateApp(String name) De-activate application.
javax.ws.rs.core.Response	getApp(String name) Get application details.
javax.ws.rs.core.Response	getAppBits(String name) Get application OAR/JAR file.
javax.ws.rs.core.Response	getAppIdByName(String id, String name) Gets applicationId entry by either id or name.
javax.ws.rs.core.Response	getAppIds() Gets a collection of application ids.
javax.ws.rs.core.Response	getApps() Get all installed applications.
javax.ws.rs.core.Response	installApp(boolean activate, InputStream stream) Install a new application.
javax.ws.rs.core.Response	installApp(InputStream raw) Install a new application.
javax.ws.rs.core.Response	registerAppId(String name) Registers an on or off platform application.
javax.ws.rs.core.Response	uninstallApp(String name) Uninstall application.

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

ApplicationsWebResource

public ApplicationsWebResource()

Method Detail

getApps

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

Get all installed applications. Returns array of all installed applications.

Returns:

200 OK

onos model

Applications

getApp

@GET
 @Path(value="{name}")
public javax.ws.rs.core.Response getApp(@PathParam(value="name")
                                                                    String name)

Get application details. Returns details of the specified application.

Parameters:

name - application name

Returns:

200 OK; 404; 401

onos model

Application

installApp

@POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response installApp(InputStream raw)

Install a new application. Uploads application archive stream and optionally activates the application.

Parameters:

raw - json object containing location (url) of application oar

Returns:

200 OK; 404; 401

installApp

@POST
 @Consumes(value="application/octet-stream")
 @Produces(value="application/json")
public javax.ws.rs.core.Response installApp(@QueryParam(value="activate") @DefaultValue(value="false")
                                                                                                                                    boolean activate,
                                                                                                                                    InputStream stream)

Install a new application. Uploads application archive stream and optionally activates the application.

Parameters:

activate - true to activate app also

stream - application archive stream

Returns:

200 OK; 404; 401

uninstallApp

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

Uninstall application. Uninstalls the specified application deactivating it first if necessary.

Parameters:

name - application name

Returns:

204 NO CONTENT

activateApp

@POST
 @Produces(value="application/json")
 @Path(value="{name}/active")
public javax.ws.rs.core.Response activateApp(@PathParam(value="name")
                                                                                                                      String name)

Activate application. Activates the specified application.

Parameters:

name - application name

Returns:

200 OK; 404; 401

deactivateApp

@DELETE
 @Produces(value="application/json")
 @Path(value="{name}/active")
public javax.ws.rs.core.Response deactivateApp(@PathParam(value="name")
                                                                                                                          String name)

De-activate application. De-activates the specified application.

Parameters:

name - application name

Returns:

204 NO CONTENT

registerAppId

@POST
 @Produces(value="application/json")
 @Path(value="{name}/register")
public javax.ws.rs.core.Response registerAppId(@PathParam(value="name")
                                                                                                                          String name)

Registers an on or off platform application.

Parameters:

name - application name

Returns:

200 OK; 404; 401

onos model

ApplicationId

getAppBits

@GET
 @Produces(value="application/octet-stream")
 @Path(value="{name}/bits")
public javax.ws.rs.core.Response getAppBits(@PathParam(value="name")
                                                                                                                          String name)

Get application OAR/JAR file. Returns the OAR/JAR file used to install the specified application.

Parameters:

name - application name

Returns:

200 OK; 404; 401

getAppIdByName

@GET
 @Produces(value="application/json")
 @Path(value="ids/entry")
public javax.ws.rs.core.Response getAppIdByName(@QueryParam(value="id")
                                                                                                                    String id,
                                                                                                                    @QueryParam(value="name")
                                                                                                                    String name)

Gets applicationId entry by either id or name.

Parameters:

id - id of application

name - name of application

Returns:

200 OK; 404; 401

onos model

ApplicationId

getAppIds

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

Gets a collection of application ids. Returns array of all registered application ids.

Returns:

200 OK; 404; 401

onos model

ApplicationIds