Package com.xebialabs.deployit.engine.api

Interface ServerService

@Path("/server") @Produces({"text/xml","application/xml","application/json"}) public interface ServerService
Services related to the operation of the XL Deploy server process.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    gc()
    Runs the garbage collector on the repository.
    ServerInfo
    getInfo()
    Returns information about the configuration of the sever.
    ServerState
    getState()
    Returns the information about the current server state (is it RUNNING or in MAINTENANCE mode).
    void
    licenseReload()
    Reload and validate the license file from disk.
    void
    logout()
    Logs out the current user.
    Long
    shutdown()
    Stops the server process in a graceful manner.
    void
    startMaintenance()
    Put server into MAINTENANCE mode (prepare for shutdown).
    void
    stopMaintenance()
    Put server into RUNNING mode.
    void
    viewAs(String username, List<String> roles)
    View as user.

  • Method Details

    • getInfo

      @GET @Path("info") ServerInfo getInfo()
      Returns information about the configuration of the sever. For example: version, plugins, and classpath.
      Returns:
      an information object.

    • gc

      @POST @Path("gc") void gc()
      Runs the garbage collector on the repository.
      Permission:
      admin

    • licenseReload

      @POST @Path("license/reload") void licenseReload()
      Reload and validate the license file from disk.
      Permission:
      admin

    • logout

      @POST @Path("logout") void logout()
      Logs out the current user.

    • viewAs

      @PUT @Path("view-as") void viewAs(@QueryParam("user") String username, @QueryParam("role") List<String> roles)
      View as user.
      Permission:
      admin

    • shutdown

      @POST @Path("shutdown") @Produces("text/plain") Long shutdown()
      Stops the server process in a graceful manner.
      Returns:
      PID of the JVM process
      Permission:
      admin

    • startMaintenance

      @POST @Path("maintenance/start") void startMaintenance()
      Put server into MAINTENANCE mode (prepare for shutdown).
      Permission:
      admin

    • stopMaintenance

      @POST @Path("maintenance/stop") void stopMaintenance()
      Put server into RUNNING mode.
      Permission:
      admin

    • getState

      @GET @Path("state") ServerState getState()
      Returns the information about the current server state (is it RUNNING or in MAINTENANCE mode).
      Returns:
      server state (RUNNING, MAINTENANCE)