org.onosproject.rest.resources

Class UiPreferencesWebResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.rest.resources.UiPreferencesWebResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

@Path(value="ui/preferences")
public class UiPreferencesWebResource
extends org.onosproject.rest.AbstractWebResource

Manage user preferences.

Constructor Summary

Constructors

Constructor and Description
UiPreferencesWebResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	download() Gets all user preferences.
javax.ws.rs.core.Response	download(String user) Gets user preferences for the given user.
javax.ws.rs.core.Response	download(String user, String pref) Gets the specified user preferences for the given user.
javax.ws.rs.core.Response	remove(String user, String pref) Removes the specified user preferences for the given user.
javax.ws.rs.core.Response	upload(String user, String pref, String request) Gets the specified user preferences for the given user.

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

UiPreferencesWebResource

public UiPreferencesWebResource()

Method Detail

download

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

Gets all user preferences.

Returns:

200 OK with user preferences JSON

download

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

Gets user preferences for the given user.

Parameters:

user - user name

Returns:

200 OK with user preferences JSON

download

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

Gets the specified user preferences for the given user.

Parameters:

user - user name

pref - preferences name

Returns:

200 OK with user preferences JSON

upload

@PUT
 @Path(value="{user}/{pref}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response upload(@PathParam(value="user")
                                                                                                                String user,
                                                                                                                @PathParam(value="pref")
                                                                                                                String pref,
                                                                                                                String request)
                                                                                                         throws IOException

Gets the specified user preferences for the given user.

Parameters:

user - user name

pref - preferences name

request - preferences JSON

Returns:

200 OK

Throws:

IOException - if given JSON is invalid

remove

@DELETE
 @Path(value="{user}/{pref}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response remove(@PathParam(value="user")
                                                                                                                   String user,
                                                                                                                   @PathParam(value="pref")
                                                                                                                   String pref)

Removes the specified user preferences for the given user.

Parameters:

user - user name

pref - preferences name

Returns:

204 no content