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

Class SystemService

java.lang.Object

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

public class SystemService
extends Object

Service class for System endpoints

Constructor Summary

Constructors

Constructor	Description
SystemService()

Method Summary

Modifier and Type	Method	Description
protected boolean	canAdminister()
org.dom4j.Document	getAll()
org.dom4j.Document	getPermissions()	Returns XML for list of Permission.
org.dom4j.Document	getRoles()	Returns XML for list of roles.
List<String>	getRolesForUser(String user)	Returns a list of Roles for a given User.
static SystemService	getSystemService()
org.dom4j.Document	getUsers()	Returns XML for list of users in the platform.
List<String>	getUsersInRole(String role)	Returns a list of Users for a given Role.

Methods inherited from class java.lang.Object

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

Constructor Detail

SystemService

public SystemService()

Method Detail

getSystemService

public static SystemService getSystemService()

getUsers

public org.dom4j.Document getUsers()
                            throws javax.servlet.ServletException,
                                   IOException,
                                   IllegalAccessException

Returns XML for list of users in the platform.

Throws:

javax.servlet.ServletException

IOException

IllegalAccessException

getRoles

public org.dom4j.Document getRoles()
                            throws javax.servlet.ServletException,
                                   IOException

Returns XML for list of roles.

Throws:

javax.servlet.ServletException

IOException

getRolesForUser

public List<String> getRolesForUser(String user)

Returns a list of Roles for a given User.

getUsersInRole

public List<String> getUsersInRole(String role)

Returns a list of Users for a given Role.

getPermissions

public org.dom4j.Document getPermissions()
                                  throws javax.servlet.ServletException,
                                         IOException

Returns XML for list of Permission.

Throws:

javax.servlet.ServletException

IOException

getAll

public org.dom4j.Document getAll()
                          throws javax.servlet.ServletException,
                                 IOException,
                                 IllegalAccessException

Throws:

javax.servlet.ServletException

IOException

IllegalAccessException

canAdminister

protected boolean canAdminister()