Package org.apache.synapse
Interface ServerManagerViewMBean
-
- All Known Implementing Classes:
ServerManagerView
public interface ServerManagerViewMBean
A simple MBean for managing the Synapse Server.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
endMaintenance()
Finishes the maintenance and put the server online.String
getServerState()
Shows the current state of the server.void
restart()
Restart the Server.void
shutdown()
Shutdown the Server.void
start()
Starts the Server.void
startMaintenance()
Puts the server into the maintenance mode.void
stop()
Stops the Server without shutting it down.void
stopGracefully(long waitSeconds)
Stops the Server gracefully.
-
-
-
Method Detail
-
getServerState
String getServerState()
Shows the current state of the server.- Returns:
- the current state of the server
-
stop
void stop() throws Exception
Stops the Server without shutting it down.- Throws:
Exception
- if an error occurs
-
shutdown
void shutdown() throws Exception
Shutdown the Server.- Throws:
Exception
- if an error occurs
-
stopGracefully
void stopGracefully(long waitSeconds) throws Exception
Stops the Server gracefully. This includes putting the server in maintenance and stopping it.- Parameters:
waitSeconds
- number of seconds to wait for a graceful stop before initiating a hard stop- Throws:
Exception
- if an error occurs
-
startMaintenance
void startMaintenance() throws Exception
Puts the server into the maintenance mode.- Throws:
Exception
- if an error occurs
-
-