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

Class SystemResource

java.lang.Object
org.pentaho.platform.web.http.api.resources.AbstractJaxRSResource
org.pentaho.platform.web.http.api.resources.SystemResource
@Path("/system/") public class SystemResource extends AbstractJaxRSResource
This api provides methods for discovering information about the system
Author:
pminutillo

  • Constructor Details

    • SystemResource

      public SystemResource()

    • SystemResource

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

  • Method Details

    • getAll

      @GET @Produces("application/xml") public jakarta.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

      @GET @Path("/authentication-provider") @Produces("application/json") public jakarta.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

      @GET @Path("/timezones") @Produces({"application/json","application/xml"}) 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

      @GET @Path("/locale") public jakarta.ws.rs.core.Response getLocale()
      Return the server side locale
      Returns:
      server's locale

    • setLocaleOverride

      @POST @Path("/locale") public jakarta.ws.rs.core.Response setLocaleOverride(String locale)
      Apply the selected locale to the user console
      Parameters:
      locale - (user console's locale)
      Returns:

    • getExecutableTypes

      @Path("/executableTypes") @GET @Produces({"application/xml","application/json"}) public org.pentaho.platform.api.repository2.unified.webservices.ExecutableFileTypeDtoWrapper getExecutableTypes()
      Retrieves the list of supported content type in the platform
      Returns:
      list of ExecutableFileTypeDto