org.pentaho.platform.web.http.api.resources

Class UserConsoleResource

java.lang.Object

org.pentaho.platform.web.http.api.resources.AbstractJaxRSResource

org.pentaho.platform.web.http.api.resources.UserConsoleResource

public class UserConsoleResource
extends AbstractJaxRSResource

The UserConsoleResource service provides the ability to check whether the current user is authenticated and/or is an administrator.

Field Summary

Fields

Modifier and Type	Field and Description
protected static UserConsoleService	userConsoleService

Fields inherited from class org.pentaho.platform.web.http.api.resources.AbstractJaxRSResource

acceptableMediaTypes, httpServletRequest, httpServletResponse, TEXT_HTML

Constructor Summary

Constructors

Constructor and Description
UserConsoleResource()

Method Summary

Modifier and Type	Method and Description
protected javax.ws.rs.core.Response	buildOkResponse(Object entity)
javax.ws.rs.core.Response	clearSessionVariable(String key) Deletes the value of a session variable.
List<Setting>	getAdminContent() Returns the list of admin related settings
javax.ws.rs.core.Response	getLocale() Return the server side locale
List<Setting>	getMantleSettings() Return the current user console settings
List<Cube>	getMondrianCatalogs() Return the list of mondrian cubes in the platform
javax.ws.rs.core.Response	getSessionVariable(String key) Gets the value of a session variable.
javax.ws.rs.core.Response	isAdministrator() Returns whether the current user is an administrator.
javax.ws.rs.core.Response	isAuthenticated() Returns whether the user is sn authenticated user or not.
javax.ws.rs.core.Response	registeredPlugins()
javax.ws.rs.core.Response	setLocaleOverride(String locale) Apply the selected locale to the user console.
javax.ws.rs.core.Response	setSessionVariable(String key, String value) Sets the value of a session variable.

Methods inherited from class org.pentaho.platform.web.http.api.resources.AbstractJaxRSResource

setHttpHeaders

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

userConsoleService

protected static UserConsoleService userConsoleService

Constructor Detail

UserConsoleResource

public UserConsoleResource()

Method Detail

isAdministrator

public javax.ws.rs.core.Response isAdministrator()

Returns whether the current user is an administrator.

Example Request:
GET pentaho/api/mantle/isAdministrator

Returns:

String true if the user is an administrator, or false otherwise.

Example Response:

     true
  

isAuthenticated

public javax.ws.rs.core.Response isAuthenticated()

Returns whether the user is sn authenticated user or not.

Example Request:
GET pentaho/api/mantle/isAuthenticated

Returns:

String true if the user is an administrator, or false otherwise.

Example Response:

     true
  

getAdminContent

public List<Setting> getAdminContent()

Returns the list of admin related settings

Returns:

list of settings

getMantleSettings

public List<Setting> getMantleSettings()

Return the current user console settings

Returns:

current settings

getMondrianCatalogs

public List<Cube> getMondrianCatalogs()

Return the list of mondrian cubes in the platform

Returns:

list of cubes

setLocaleOverride

public javax.ws.rs.core.Response setLocaleOverride(String locale)

Apply the selected locale to the user console.

Parameters:

locale - (user console's locale)

Returns:

getLocale

public javax.ws.rs.core.Response getLocale()

Return the server side locale

Returns:

server's locale

setSessionVariable

public javax.ws.rs.core.Response setSessionVariable(String key,
                                                    String value)

Sets the value of a session variable.

Parameters:

key - The name of the session variable

value - The value of the session variable

Returns:

getSessionVariable

public javax.ws.rs.core.Response getSessionVariable(String key)

Gets the value of a session variable.

Parameters:

key - The name of the session variable

Returns:

clearSessionVariable

public javax.ws.rs.core.Response clearSessionVariable(String key)

Deletes the value of a session variable.

Parameters:

key - The name of the session variable

Returns:

registeredPlugins

public javax.ws.rs.core.Response registeredPlugins()

buildOkResponse

protected javax.ws.rs.core.Response buildOkResponse(Object entity)