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

Class SystemResource

  • public class SystemResource
extends AbstractJaxRSResource
    This api provides methods for discovering information about the system
    Author:
    pminutillo

    • Constructor Detail

      • SystemResource

        public SystemResource()

      • SystemResource

        public SystemResource​(org.pentaho.platform.api.engine.ISystemConfig systemConfig)

    • Method Detail

      • getAll

        public javax.ws.rs.core.Response getAll()
                                 throws Exception
        Returns all users, roles, and ACLs in an XML document. Moved here from now removed SystemAllResource class Response Sample: joe Admin Update 8
        Returns:
        Response containing roles, users, and acls
        Throws:
        Exception

      • getAuthenticationProvider

        public javax.ws.rs.core.Response getAuthenticationProvider()
                                                    throws Exception
        Return JSON string reporting which authentication provider is currently in use Response sample: { "authenticationType": "JCR_BASED_AUTHENTICATION" }
        Returns:
        AuthenticationProvider represented as JSON response
        Throws:
        Exception

      • getTimeZones

        public TimeZoneWrapper getTimeZones()
        Returns a list of TimeZones ensuring that the server (default) timezone is at the top of the list (0th element)
        Returns:
        a list of TimeZones ensuring that the server (default) timezone is at the top of the list (0th element)

      • getLocale

        public javax.ws.rs.core.Response getLocale()
        Return the server side locale
        Returns:
        server's locale

      • 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:

      • getExecutableTypes

        public javax.ws.rs.core.Response getExecutableTypes()
        Retrieves the list of supported content type in the platform
        Returns:
        list of ExecutableFileTypeDto