MyPreferencesResource (Silverpeas Core 6.3 API)

java.lang.Object
- org.silverpeas.core.web.rs.RESTWebService
- - org.silverpeas.core.webapi.preferences.MyPreferencesResource

All Implemented Interfaces:

ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource
```
@WebService
@Path("mypreferences")
@Authenticated
public class MyPreferencesResource
extends RESTWebService
```
The preferences of the current user in Silverpeas. This web service provides a way to get and to change its preferences. Currently, only the change of the language is implemented.

Author:

mmoquillon

Nested Class Summary
- Nested classes/interfaces inherited from class org.silverpeas.core.web.rs.RESTWebService
  RESTWebService.WebProcess<R>, RESTWebService.WebTreatment<R>

Field Summary
- Fields inherited from class org.silverpeas.core.web.rs.RESTWebService
  RESPONSE_HEADER_ARRAYSIZE
- Fields inherited from interface org.silverpeas.core.web.SilverpeasWebResource
  BASE_PATH

Constructor Summary

Constructors
Constructor Description

MyPreferencesResource()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getComponentId()`	Gets the identifier of the component instance to which the requested resource belongs to.
`protected String`	`getResourceBasePath()`	Gets the base path of the web resource relative to the root path of all of the web resources in Silverpeas as given by `SilverpeasWebResource.getBasePath()`.
`UserPreferencesEntity`	`setMyPreferences(UserPreferencesEntity preferences)`	Updates the preferences of the user behind the current request.

Methods inherited from class org.silverpeas.core.web.rs.RESTWebService
fromPage, getBundle, getBundleLocation, getHighestUserRole, getHttpRequest, getHttpServletRequest, getHttpServletResponse, getOrganisationController, getSilverpeasContext, getUri, getUser, getUserPreferences, getUserRoles, identifiedBy, identifiedBy, initContext, initWebResourceUri, isUserDefined, process

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.silverpeas.core.web.rs.ProtectedWebResource
validateUserAuthorization

Methods inherited from interface org.silverpeas.core.web.rs.WebAuthenticationValidation
validateUserAuthentication

- Constructor Detail
  - MyPreferencesResource
```
public MyPreferencesResource()
```
- Method Detail
  - getComponentId
```
public String getComponentId()
```
    Description copied from interface: SilverpeasWebResource
    
    Gets the identifier of the component instance to which the requested resource belongs to.
    
    Returns:
    
    the identifier of the Silverpeas component instance.
  - setMyPreferences
```
@PUT
@Consumes("application/json")
@Produces("application/json")
public UserPreferencesEntity setMyPreferences(UserPreferencesEntity preferences)
```
    Updates the preferences of the user behind the current request.
    
    Parameters:
    
    preferences - the user preferences to set.
    
    Returns:
    
    the updated user preferences.
  - getResourceBasePath
```
protected String getResourceBasePath()
```
    Description copied from class: RESTWebService
    
    Gets the base path of the web resource relative to the root path of all of the web resources in Silverpeas as given by SilverpeasWebResource.getBasePath().
    
    Specified by:
    
    getResourceBasePath in class RESTWebService
    
    Returns:
    
    the relative path that identifies this REST web service among all other REST web services.