org.adroitlogic.x.management.rest.service

Class ServerManagementService

java.lang.Object

org.adroitlogic.x.management.rest.service.ServerManagementService

public class ServerManagementService
extends Object

Service class to obtain server related resources

Since:

17.07

Author:

Udith Gunaratna

Constructor Summary

Constructors

Constructor and Description
ServerManagementService()

Method Summary

Modifier and Type	Method and Description
ServerResource	getServerInfo() Retrieves configuration information of this UltraESB-X server instance
Status	getServerStatus() Retrieves the current status of the server instance
void	gracefulShutdown(long waitTimeMillis) Shutdown the XServer gracefully within the specified grace period.
void	shutdownServer() Shutdowns this UltraESB-X server instance
void	startMaintenance() Starts the maintenance mode of XServer
void	startServer() Starts this UltraESB-X server instance
void	stopMaintenance() Resume normal operations from maintenance mode
void	stopServer() Stops this UltraESB-X server instance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServerManagementService

public ServerManagementService()

Method Detail

startServer

public void startServer()
                 throws ManagementServiceException

Starts this UltraESB-X server instance

Throws:

ManagementServiceException - on failure

stopServer

public void stopServer()
                throws ManagementServiceException

Stops this UltraESB-X server instance

Throws:

ManagementServiceException - on failure

shutdownServer

public void shutdownServer()
                    throws ManagementServiceException

Shutdowns this UltraESB-X server instance

Throws:

ManagementServiceException - on failure

startMaintenance

public void startMaintenance()
                      throws ManagementServiceException

Starts the maintenance mode of XServer

Throws:

ManagementServiceException - on failure

stopMaintenance

public void stopMaintenance()
                     throws ManagementServiceException

Resume normal operations from maintenance mode

Throws:

ManagementServiceException - on failure

gracefulShutdown

public void gracefulShutdown(long waitTimeMillis)
                      throws ManagementServiceException

Shutdown the XServer gracefully within the specified grace period. If the server failed to reach the idle state within the grace period, hard shutdown will be executed at that point.

Parameters:

waitTimeMillis - the maximum time period (in milliseconds ) that the shutdown action will wait for the server to become idle after entering the maintenance mode

Throws:

ManagementServiceException - on failure

getServerStatus

public Status getServerStatus()
                       throws ManagementServiceException

Retrieves the current status of the server instance

Returns:

Status enum representing the current status

Throws:

ManagementServiceException - on failure

getServerInfo

public ServerResource getServerInfo()
                             throws ManagementServiceException

Retrieves configuration information of this UltraESB-X server instance

Returns:

configuration information of this UltraESB-X server instance

Throws:

ManagementServiceException - on failure