Class UserSettingsResource
- java.lang.Object
-
- org.pentaho.platform.web.http.api.resources.AbstractJaxRSResource
-
- org.pentaho.platform.web.http.api.resources.UserSettingsResource
-
public class UserSettingsResource extends AbstractJaxRSResource
This resource manages the user settings of the platform. User settings are persisted across user sessions and shared by all active sessions of a user. Contrast this with user session variables, accessed viaUserConsoleResource
, which are reset at every new user session, and are local to each user session. The state changing operations of this service are protected against CSRF attacks, and thus require a CSRF token to be called.- See Also:
UserConsoleResource
-
-
Field Summary
-
Fields inherited from class org.pentaho.platform.web.http.api.resources.AbstractJaxRSResource
acceptableMediaTypes, httpServletRequest, httpServletResponse, TEXT_HTML
-
-
Constructor Summary
Constructors Constructor Description UserSettingsResource()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description javax.ws.rs.core.Response
getUserSetting(String setting)
Retrieve a particular user setting for the current userArrayList<Setting>
getUserSettings()
Retrieve the global settings and the user settings for the current userjavax.ws.rs.core.Response
setUserSetting(String setting, String settingValue)
Save the value of a particular setting for the current user.-
Methods inherited from class org.pentaho.platform.web.http.api.resources.AbstractJaxRSResource
setHttpHeaders
-
-
-
-
Method Detail
-
getUserSettings
public ArrayList<Setting> getUserSettings()
Retrieve the global settings and the user settings for the current user- Returns:
- list of settings for the platform
-
getUserSetting
public javax.ws.rs.core.Response getUserSetting(String setting)
Retrieve a particular user setting for the current user- Parameters:
setting
- (Name of the setting)- Returns:
- value of the setting for the user
-
-