com.xebialabs.deployit.engine.api

Interface ServerService

@Path(value="/server")
@Produces(value={"text/xml","application/xml"})
public interface ServerService

Services related to the operation of the XL Deploy server process.

Method Summary

Methods

Modifier and Type	Method and Description
void	gc() Runs the garbage collector on the repository.
ServerInfo	getInfo() Returns information about the configuration of the sever.
ServerState	getState() Return information about 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.
void	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.

Method Detail

getInfo

@GET
@Path(value="info")
ServerInfo getInfo()

Returns information about the configuration of the sever. For example: version, plugins, and classpath.

Returns:

an information object.

gc

@POST
@Path(value="gc")
void gc()

Runs the garbage collector on the repository.

Permission:

admin

licenseReload

@POST
@Path(value="license/reload")
void licenseReload()

Reload and validate the license file from disk.

Permission:

admin

logout

@POST
@Path(value="logout")
void logout()

Logs out the current user.

shutdown

@POST
@Path(value="shutdown")
void shutdown()

Stops the server process in a graceful manner.

Permission:

admin

startMaintenance

@POST
@Path(value="maintenance/start")
void startMaintenance()

Put server into MAINTENANCE mode (prepare for shutdown).

Permission:

admin

stopMaintenance

@POST
@Path(value="maintenance/stop")
void stopMaintenance()

Put server into RUNNING mode.

Permission:

admin

getState

@GET
@Path(value="state")
ServerState getState()

Return information about current server state (is it RUNNING or in MAINTENANCE mode).

Returns:

server state (RUNNING, MAINTENANCE)