Package com.gentics.contentnode.rest.resource

Interface AdminResource

@Path("/admin") @Produces("application/json") public interface AdminResource
Resource for various tasks used by the administrator (like retrieving version numbers)

  • Method Details

    • currentVersion

      @GET @Path("/version") VersionResponse currentVersion() throws Exception
      Get the current version of the REST API on the server

      Apart from the CMS version a map with version information about CMP components for each node will be included.

      Returns:
      VersionResponse
      Throws:
      Exception

    • featureInfo

      @GET @Path("/features/{name}") FeatureResponse featureInfo(@PathParam("name") String name)
      Get info about a feature activation
      Parameters:
      name - name of the feature
      Returns:
      feature response

    • tools

      @GET @Path("/tools") ToolsResponse tools() throws Exception
      Get the tools, that shall be shown in the UI
      Returns:
      list of tools
      Throws:
      Exception

    • publishInfo

      @GET @Path("/publishInfo") PublishInfoResponse publishInfo() throws Exception
      Get information of the current publish process. Since collecting the statistics may be resource intensive, this is not done during this request but the statistics are collected in a background job. The delay between the jobs can be configured with the variable $PUBLISH_QUEUE_STATS["refresh_delay"] and defaults to 60000 milliseconds (one minute).
      Returns:
      publish info response
      Throws:
      Exception

    • updatesAvailable

      @GET @Path("/updates") UpdatesInfoResponse updatesAvailable() throws Exception
      Get available updates
      Returns:
      response containing available updates
      Throws:
      Exception

    • publicKey

      @GET @Path("/publicKey") com.fasterxml.jackson.databind.JsonNode publicKey() throws Exception
      Get the public server key as JWK
      Returns:
      Public server key as JWK
      Throws:
      Exception

    • getActionLog

      @GET @Path("/actionlog") ActionLogEntryList getActionLog(@BeanParam PagingParameterBean paging, @BeanParam ActionLogParameterBean query) throws Exception
      Get the action log
      Parameters:
      paging - paging parameter
      query - query parameter
      Returns:
      response containing log entries
      Throws:
      Exception

    • getActionLogTypes

      @GET @Path("/actionlog/types") ActionLogTypeList getActionLogTypes(@BeanParam FilterParameterBean filter, @BeanParam SortParameterBean sorting, @BeanParam PagingParameterBean paging) throws Exception
      Get the object types, that are logged.
      The result can be filtered by
      • name
      • label
      and sorted by
      • name
      • label
      Parameters:
      filter - filter parameter
      sorting - sorting parameter
      paging - paging parameter
      Returns:
      response containing a list of object types
      Throws:
      Exception

    • getActionLogActions

      @GET @Path("/actionlog/actions") ActionModelList getActionLogActions(@BeanParam FilterParameterBean filter, @BeanParam SortParameterBean sorting, @BeanParam PagingParameterBean paging) throws Exception
      Get the actions, which are logged.
      The result can be filtered by
      • name
      • label
      and sorted by
      • name
      • label
      Parameters:
      filter - filter parameter
      sorting - sorting parameter
      paging - paging parameter
      Returns:
      response containing a list of actions
      Throws:
      Exception

    • getErrorLog

      @GET @Path("/errorlog") ErrorLogEntryList getErrorLog(@BeanParam FilterParameterBean filter, @BeanParam PagingParameterBean paging) throws Exception
      Get error log
      Parameters:
      filter - filter parameter
      paging - paging parameter
      Returns:
      response containing list of logged errors
      Throws:
      Exception

    • getPublishQueue

      @GET @Path("/content/publishqueue") PublishQueueResponse getPublishQueue() throws Exception
      Get publish queue information. Since collecting the statistics may be resource intensive, this is not done during this request but the statistics are collected in a background job. The delay between the jobs can be configured with the variable $PUBLISH_QUEUE_STATS["refresh_delay"] and defaults to 60000 milliseconds (one minute).
      Returns:
      response containing object counts per node and type
      Throws:
      Exception

    • performContentMaintenanceAction

      @POST @Path("/content/publishqueue") GenericResponse performContentMaintenanceAction(ContentMaintenanceActionRequest request) throws Exception
      Perform a maintenance action on the publish queue
      Parameters:
      request - maintenance action request
      Returns:
      response
      Throws:
      Exception

    • getDirtQueue

      @GET @Path("/content/dirtqueue") DirtQueueEntryList getDirtQueue(@BeanParam PagingParameterBean paging, @BeanParam DirtQueueParameterBean filter) throws Exception
      Get the sorted list of dirt queue entries
      Parameters:
      paging - paging parameters
      filter - filter parameters
      Returns:
      response containing a list of dirt queue entries
      Throws:
      Exception

    • getDirtQueueSummary

      @GET @Path("/content/dirtqueue/summary") DirtQueueSummaryResponse getDirtQueueSummary() throws Exception
      Get a sorted summary of current dirt queue entries
      Returns:
      response containing a sorted summary
      Throws:
      Exception

    • deleteDirtQueueEntry

      @DELETE @Path("/content/dirtqueue/{id}") javax.ws.rs.core.Response deleteDirtQueueEntry(@PathParam("id") int entryId) throws Exception
      Delete the failed dirt queue entry with given ID
      Parameters:
      entryId - entry ID
      Returns:
      empty response
      Throws:
      Exception

    • deleteDirtQueueEntries

      @DELETE @Path("/content/dirtqueue") javax.ws.rs.core.Response deleteDirtQueueEntries(@BeanParam DirtQueueParameterBean filter) throws Exception
      Batch delete dirt queue entries based on filters
      Parameters:
      filter - filter parameters
      Returns:
      empty response
      Throws:
      Exception

    • redoDirtQueueEntry

      @PUT @Path("/content/dirtqueue/{id}/redo") javax.ws.rs.core.Response redoDirtQueueEntry(@PathParam("id") int entryId) throws Exception
      Repeat the failed dirt queue entry with given ID
      Parameters:
      entryId - entry ID
      Returns:
      empty response
      Throws:
      Exception

    • reloadConfiguration

      @PUT @Path("/config/reload") GenericResponse reloadConfiguration() throws Exception
      Reload the configuration
      Returns:
      generic response
      Throws:
      Exception

    • setMaintenanceMode

      @POST @Path("/maintenance") MaintenanceResponse setMaintenanceMode(MaintenanceModeRequest request) throws Exception
      Set or unset the maintenancemode, including the maintenance message. When the maintenance mode is enabled, all other sessions will be invalidated.
      Parameters:
      request - request
      Returns:
      response
      Throws:
      Exception