ServiceSupport (Camel :: API 3.0.0-M2 API)

java.lang.Object
- org.apache.camel.support.service.ServiceSupport

All Implemented Interfaces:

Service, ShutdownableService, StatefulService, SuspendableService

Direct Known Subclasses:

Transformer, Validator
```
public abstract class ServiceSupport
extends Object
implements StatefulService
```
A useful base class which ensures that a service is only initialized once and provides some helper methods for enquiring of its status.
Implementations can extend this base class and implement SuspendableService in case they support suspend/resume.
Important: You should override the lifecycle methods that start with do, eg doStart()}, doStop(), etc. where you implement your logic. The methods start(), stop() should NOT be overridden as they are used internally to keep track of the state of this service and properly invoke the operation in a safe manner.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`FAILED`
`protected static int`	`INITIALIZED`
`protected Object`	`lock`
`protected org.slf4j.Logger`	`log`
`protected static int`	`NEW`
`protected static int`	`SHUTDOWN`
`protected static int`	`SHUTTINGDOWN`
`protected static int`	`STARTED`
`protected static int`	`STARTING`
`protected int`	`status`
`protected static int`	`STOPPED`
`protected static int`	`STOPPING`
`protected static int`	`SUSPENDED`
`protected static int`	`SUSPENDING`

Constructor Summary

Constructors
Constructor and Description

ServiceSupport()

Constructors
Constructor and Description
`ServiceSupport()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`doInit()` Initialize the service.
`protected void`	`doResume()` Implementations override this method to support customized suspend/resume.
`protected void`	`doShutdown()` Implementations override this method to perform customized shutdown.
`protected abstract void`	`doStart()` Implementations override this method to support customized start/stop.
`protected abstract void`	`doStop()` Implementations override this method to support customized start/stop.
`protected void`	`doSuspend()` Implementations override this method to support customized suspend/resume.
`ServiceStatus`	`getStatus()` Returns the current status
`void`	`init()` Initialize the service
`boolean`	`isInit()`
`boolean`	`isNew()`
`boolean`	`isRunAllowed()` Helper methods so the service knows if it should keep running.
`boolean`	`isShutdown()`
`boolean`	`isStarted()` Whether the service is started
`boolean`	`isStarting()` Whether the service is starting
`boolean`	`isStartingOrStarted()` Is the service in progress of being suspended or already suspended
`boolean`	`isStopped()` Whether the service is stopped
`boolean`	`isStopping()` Whether the service is stopping
`boolean`	`isStoppingOrStopped()` Is the service in progress of being stopped or already stopped
`boolean`	`isSuspended()` Tests whether the service is suspended or not.
`boolean`	`isSuspending()` Whether the service is suspending
`boolean`	`isSuspendingOrSuspended()` Is the service in progress of being suspended or already suspended
`void`	`resume()` Important: You should override the lifecycle methods that start with `do`, eg `doStart()`, `doStop()`, etc.
`void`	`shutdown()` Important: You should override the lifecycle methods that start with `do`, eg `doStart()`, `doStop()`, etc.
`void`	`start()` Important: You should override the lifecycle methods that start with `do`, eg `doStart()`, `doStop()`, etc.
`void`	`stop()` Important: You should override the lifecycle methods that start with `do`, eg `doStart()`, `doStop()`, etc.
`void`	`suspend()` Important: You should override the lifecycle methods that start with `do`, eg `doStart()`, `doStop()`, etc.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NEW
```
protected static final int NEW
```
    See Also:
    
    Constant Field Values
  - INITIALIZED
```
protected static final int INITIALIZED
```
    See Also:
    
    Constant Field Values
  - STARTING
```
protected static final int STARTING
```
    See Also:
    
    Constant Field Values
  - STARTED
```
protected static final int STARTED
```
    See Also:
    
    Constant Field Values
  - SUSPENDING
```
protected static final int SUSPENDING
```
    See Also:
    
    Constant Field Values
  - SUSPENDED
```
protected static final int SUSPENDED
```
    See Also:
    
    Constant Field Values
  - STOPPING
```
protected static final int STOPPING
```
    See Also:
    
    Constant Field Values
  - STOPPED
```
protected static final int STOPPED
```
    See Also:
    
    Constant Field Values
  - SHUTTINGDOWN
```
protected static final int SHUTTINGDOWN
```
    See Also:
    
    Constant Field Values
  - SHUTDOWN
```
protected static final int SHUTDOWN
```
    See Also:
    
    Constant Field Values
  - FAILED
```
protected static final int FAILED
```
    See Also:
    
    Constant Field Values
  - log
```
protected final org.slf4j.Logger log
```
  - lock
```
protected final Object lock
```
  - status
```
protected volatile int status
```
- Constructor Detail
  - ServiceSupport
```
public ServiceSupport()
```
- Method Detail
  - init
```
public void init()
```
    Description copied from interface: Service
    
    Initialize the service
    
    Specified by:
    
    init in interface Service
  - start
```
public void start()
           throws Exception
```
    Important: You should override the lifecycle methods that start with do, eg doStart(), doStop(), etc. where you implement your logic. The methods start(), stop() should NOT be overriden as they are used internally to keep track of the state of this service and properly invoke the operation in a safe manner.
    
    Specified by:
    
    start in interface Service
    
    Throws:
    
    Exception - is thrown if starting failed
  - stop
```
public void stop()
          throws Exception
```
    Important: You should override the lifecycle methods that start with do, eg doStart(), doStop(), etc. where you implement your logic. The methods start(), stop() should NOT be overridden as they are used internally to keep track of the state of this service and properly invoke the operation in a safe manner.
    
    Specified by:
    
    stop in interface Service
    
    Throws:
    
    Exception - is thrown if stopping failed
  - suspend
```
public void suspend()
             throws Exception
```
    Important: You should override the lifecycle methods that start with do, eg doStart(), doStop(), etc. where you implement your logic. The methods start(), stop() should NOT be overridden as they are used internally to keep track of the state of this service and properly invoke the operation in a safe manner.
    
    Specified by:
    
    suspend in interface SuspendableService
    
    Throws:
    
    Exception - is thrown if suspending failed
  - resume
```
public void resume()
            throws Exception
```
    Important: You should override the lifecycle methods that start with do, eg doStart(), doStop(), etc. where you implement your logic. The methods start(), stop() should NOT be overriden as they are used internally to keep track of the state of this service and properly invoke the operation in a safe manner.
    
    Specified by:
    
    resume in interface SuspendableService
    
    Throws:
    
    Exception - is thrown if resuming failed
  - shutdown
```
public void shutdown()
              throws Exception
```
    Important: You should override the lifecycle methods that start with do, eg doStart(), doStop(), etc. where you implement your logic. The methods start(), stop() should NOT be overriden as they are used internally to keep track of the state of this service and properly invoke the operation in a safe manner.
    
    Specified by:
    
    shutdown in interface ShutdownableService
    
    Throws:
    
    Exception - thrown if shutting down failed
  - getStatus
```
public ServiceStatus getStatus()
```
    Description copied from interface: StatefulService
    
    Returns the current status
    
    Specified by:
    
    getStatus in interface StatefulService
    
    Returns:
    
    the current status
  - isNew
```
public boolean isNew()
```
  - isInit
```
public boolean isInit()
```
  - isStarted
```
public boolean isStarted()
```
    Description copied from interface: StatefulService
    
    Whether the service is started
    
    Specified by:
    
    isStarted in interface StatefulService
    
    Returns:
    
    true if this service has been started
  - isStarting
```
public boolean isStarting()
```
    Description copied from interface: StatefulService
    
    Whether the service is starting
    
    Specified by:
    
    isStarting in interface StatefulService
    
    Returns:
    
    true if this service is being started
  - isStopping
```
public boolean isStopping()
```
    Description copied from interface: StatefulService
    
    Whether the service is stopping
    
    Specified by:
    
    isStopping in interface StatefulService
    
    Returns:
    
    true if this service is in the process of stopping
  - isStopped
```
public boolean isStopped()
```
    Description copied from interface: StatefulService
    
    Whether the service is stopped
    
    Specified by:
    
    isStopped in interface StatefulService
    
    Returns:
    
    true if this service is stopped
  - isSuspending
```
public boolean isSuspending()
```
    Description copied from interface: StatefulService
    
    Whether the service is suspending
    
    Specified by:
    
    isSuspending in interface StatefulService
    
    Returns:
    
    true if this service is in the process of suspending
  - isSuspended
```
public boolean isSuspended()
```
    Description copied from interface: SuspendableService
    
    Tests whether the service is suspended or not.
    
    Specified by:
    
    isSuspended in interface SuspendableService
    
    Returns:
    
    true if suspended
  - isRunAllowed
```
public boolean isRunAllowed()
```
    Description copied from interface: StatefulService
    
    Helper methods so the service knows if it should keep running. Returns false if the service is being stopped or is stopped.
    
    Specified by:
    
    isRunAllowed in interface StatefulService
    
    Returns:
    
    true if the service should continue to run.
  - isShutdown
```
public boolean isShutdown()
```
  - isStoppingOrStopped
```
public boolean isStoppingOrStopped()
```
    Is the service in progress of being stopped or already stopped
  - isSuspendingOrSuspended
```
public boolean isSuspendingOrSuspended()
```
    Is the service in progress of being suspended or already suspended
  - isStartingOrStarted
```
public boolean isStartingOrStarted()
```
    Is the service in progress of being suspended or already suspended
  - doInit
```
protected void doInit()
```
    Initialize the service. This method will only be called once before starting.
  - doStart
```
protected abstract void doStart()
                         throws Exception
```
    Implementations override this method to support customized start/stop.
    Important: See doStop() for more details.
    
    Throws:
    
    Exception
    
    See Also:
    
    doStop()
  - doStop
```
protected abstract void doStop()
                        throws Exception
```
    Implementations override this method to support customized start/stop.
    Important: Camel will invoke this doStop() method when the service is being stopped. This method will also be invoked if the service is still in uninitialized state (eg has not been started). The method is always called to allow the service to do custom logic when the service is being stopped, such as when CamelContext is shutting down.
    
    Throws:
    
    Exception
    
    See Also:
    
    doStart()
  - doSuspend
```
protected void doSuspend()
                  throws Exception
```
    Implementations override this method to support customized suspend/resume.
    
    Throws:
    
    Exception
  - doResume
```
protected void doResume()
                 throws Exception
```
    Implementations override this method to support customized suspend/resume.
    
    Throws:
    
    Exception
  - doShutdown
```
protected void doShutdown()
                   throws Exception
```
    Implementations override this method to perform customized shutdown.
    
    Throws:
    
    Exception

Class ServiceSupport

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NEW

INITIALIZED

STARTING

STARTED

SUSPENDING

SUSPENDED

STOPPING

STOPPED

SHUTTINGDOWN

SHUTDOWN

FAILED

log

lock

status

Constructor Detail

ServiceSupport

Method Detail

init

start

stop

suspend

resume

shutdown

getStatus

isNew

isInit

isStarted

isStarting

isStopping

isStopped

isSuspending

isSuspended

isRunAllowed

isShutdown

isStoppingOrStopped

isSuspendingOrSuspended

isStartingOrStarted

doInit

doStart

doStop

doSuspend

doResume

doShutdown