public interface Controllable extends ClassLoaderAware
Modifier and Type | Method and Description |
---|---|
void |
configure(XmlElement xml)
Deprecated.
|
boolean |
isRunning()
Determine whether or not the controllable service is running.
|
void |
shutdown()
Stop the controllable service.
|
void |
start()
Start the controllable service.
|
void |
stop()
Hard-stop the controllable service.
|
getContextClassLoader, setContextClassLoader
@Deprecated void configure(XmlElement xml)
This method can only be called before the controllable service is started.
xml
- an XmlElement carrying configuration information
specific to the Controllable objectIllegalStateException
- thrown if the service is
already runningIllegalArgumentException
- thrown if the configuration
information is invalidvoid start()
This method should only be called once per the life cycle of the Controllable service. This method has no affect if the service is already running.
IllegalStateException
- thrown if a service does not support
being re-started, and the service was already started and
subsequently stopped and then an attempt is made to start
the service again; also thrown if the Controllable service
has not been configuredboolean isRunning()
void shutdown()
stop()
method.
This method should only be called once per the life cycle of the controllable service. Calling this method for a service that has already stopped has no effect.
void stop()
shutdown()
for normal service termination. Calling this method for a service
that has already stopped has no effect.