Class AbstractService
- java.lang.Object
-
- com.google.common.util.concurrent.AbstractService
-
- All Implemented Interfaces:
Service
- Direct Known Subclasses:
AbstractIdleService.DelegateService
,AbstractScheduledService.ServiceDelegate
,ServiceManager.NoOpService
public abstract class AbstractService extends java.lang.Object implements Service
Base class for implementing services that can handledoStart()
anddoStop()
requests, responding to them withnotifyStarted()
andnotifyStopped()
callbacks. Its subclasses must manage threads manually; considerAbstractExecutionThreadService
if you need only a single execution thread.- Since:
- 1.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private class
AbstractService.HasReachedRunningGuard
private class
AbstractService.IsStartableGuard
private class
AbstractService.IsStoppableGuard
private class
AbstractService.IsStoppedGuard
private static class
AbstractService.StateSnapshot
An immutable snapshot of the current state of the service.-
Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service
Service.Listener, Service.State
-
-
Field Summary
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractService()
Constructor for use by subclasses.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
addListener(Service.Listener listener, java.util.concurrent.Executor executor)
Registers aService.Listener
to be executed on the given executor.void
awaitRunning()
Waits for theService
to reach the running state.void
awaitRunning(long timeout, java.util.concurrent.TimeUnit unit)
Waits for theService
to reach the running state for no more than the given time.void
awaitRunning(java.time.Duration timeout)
Waits for theService
to reach the running state for no more than the given time.void
awaitTerminated()
Waits for theService
to reach the terminated state.void
awaitTerminated(long timeout, java.util.concurrent.TimeUnit unit)
Waits for theService
to reach a terminal state (eitherterminated
orfailed
) for no more than the given time.void
awaitTerminated(java.time.Duration timeout)
Waits for theService
to reach a terminal state (eitherterminated
orfailed
) for no more than the given time.private void
checkCurrentState(Service.State expected)
Checks that the current state is equal to the expected state.private void
dispatchListenerEvents()
protected void
doCancelStart()
This method is called bystopAsync()
when the service is still starting (i.e.protected abstract void
doStart()
This method is called bystartAsync()
to initiate service startup.protected abstract void
doStop()
This method should be used to initiate service shutdown.private void
enqueueFailedEvent(Service.State from, java.lang.Throwable cause)
private void
enqueueRunningEvent()
private void
enqueueStartingEvent()
private void
enqueueStoppingEvent(Service.State from)
private void
enqueueTerminatedEvent(Service.State from)
java.lang.Throwable
failureCause()
Returns theThrowable
that caused this service to fail.boolean
isRunning()
Returnstrue
if this service is running.protected void
notifyFailed(java.lang.Throwable cause)
Invoke this method to transition the service to theService.State.FAILED
.protected void
notifyStarted()
Implementing classes should invoke this method once their service has started.protected void
notifyStopped()
Implementing classes should invoke this method once their service has stopped.Service
startAsync()
If the service state isService.State.NEW
, this initiates service startup and returns immediately.Service.State
state()
Returns the lifecycle state of the service.Service
stopAsync()
private static ListenerCallQueue.Event<Service.Listener>
stoppingEvent(Service.State from)
private static ListenerCallQueue.Event<Service.Listener>
terminatedEvent(Service.State from)
java.lang.String
toString()
-
-
-
Field Detail
-
STARTING_EVENT
private static final ListenerCallQueue.Event<Service.Listener> STARTING_EVENT
-
RUNNING_EVENT
private static final ListenerCallQueue.Event<Service.Listener> RUNNING_EVENT
-
STOPPING_FROM_STARTING_EVENT
private static final ListenerCallQueue.Event<Service.Listener> STOPPING_FROM_STARTING_EVENT
-
STOPPING_FROM_RUNNING_EVENT
private static final ListenerCallQueue.Event<Service.Listener> STOPPING_FROM_RUNNING_EVENT
-
TERMINATED_FROM_NEW_EVENT
private static final ListenerCallQueue.Event<Service.Listener> TERMINATED_FROM_NEW_EVENT
-
TERMINATED_FROM_STARTING_EVENT
private static final ListenerCallQueue.Event<Service.Listener> TERMINATED_FROM_STARTING_EVENT
-
TERMINATED_FROM_RUNNING_EVENT
private static final ListenerCallQueue.Event<Service.Listener> TERMINATED_FROM_RUNNING_EVENT
-
TERMINATED_FROM_STOPPING_EVENT
private static final ListenerCallQueue.Event<Service.Listener> TERMINATED_FROM_STOPPING_EVENT
-
monitor
private final Monitor monitor
-
isStartable
private final Monitor.Guard isStartable
-
isStoppable
private final Monitor.Guard isStoppable
-
hasReachedRunning
private final Monitor.Guard hasReachedRunning
-
isStopped
private final Monitor.Guard isStopped
-
listeners
private final ListenerCallQueue<Service.Listener> listeners
The listeners to notify during a state transition.
-
snapshot
private volatile AbstractService.StateSnapshot snapshot
The current state of the service. This should be written with the lock held but can be read without it because it is an immutable object in a volatile field. This is desirable so that methods likestate()
,failureCause()
and notablytoString()
can be run without grabbing the lock.To update this field correctly the lock must be held to guarantee that the state is consistent.
-
-
Method Detail
-
terminatedEvent
private static ListenerCallQueue.Event<Service.Listener> terminatedEvent(Service.State from)
-
stoppingEvent
private static ListenerCallQueue.Event<Service.Listener> stoppingEvent(Service.State from)
-
doStart
protected abstract void doStart()
This method is called bystartAsync()
to initiate service startup. The invocation of this method should cause a call tonotifyStarted()
, either during this method's run, or after it has returned. If startup fails, the invocation should cause a call tonotifyFailed(Throwable)
instead.This method should return promptly; prefer to do work on a different thread where it is convenient. It is invoked exactly once on service startup, even when
startAsync()
is called multiple times.
-
doStop
protected abstract void doStop()
This method should be used to initiate service shutdown. The invocation of this method should cause a call tonotifyStopped()
, either during this method's run, or after it has returned. If shutdown fails, the invocation should cause a call tonotifyFailed(Throwable)
instead.This method should return promptly; prefer to do work on a different thread where it is convenient. It is invoked exactly once on service shutdown, even when
stopAsync()
is called multiple times.If
stopAsync()
is called on aService.State.STARTING
service, this method is not invoked immediately. Instead, it will be deferred until after the service isService.State.RUNNING
. Services that need to cancel startup work can overridedoCancelStart()
.
-
doCancelStart
protected void doCancelStart()
This method is called bystopAsync()
when the service is still starting (i.e.startAsync()
has been called butnotifyStarted()
has not). Subclasses can override the method to cancel pending work and then callnotifyStopped()
to stop the service.This method should return promptly; prefer to do work on a different thread where it is convenient. It is invoked exactly once on service shutdown, even when
stopAsync()
is called multiple times.When this method is called
state()
will returnService.State.STOPPING
, which is the external state observable by the caller ofstopAsync()
.- Since:
- 27.0
-
startAsync
public final Service startAsync()
Description copied from interface:Service
If the service state isService.State.NEW
, this initiates service startup and returns immediately. A stopped service may not be restarted.- Specified by:
startAsync
in interfaceService
- Returns:
- this
-
stopAsync
public final Service stopAsync()
Description copied from interface:Service
If the service is starting or running, this initiates service shutdown and returns immediately. If the service is new, it is terminated without having been started nor stopped. If the service has already been stopped, this method returns immediately without taking action.
-
awaitRunning
public final void awaitRunning()
Description copied from interface:Service
Waits for theService
to reach the running state.- Specified by:
awaitRunning
in interfaceService
-
awaitRunning
public final void awaitRunning(java.time.Duration timeout) throws java.util.concurrent.TimeoutException
Description copied from interface:Service
Waits for theService
to reach the running state for no more than the given time.- Specified by:
awaitRunning
in interfaceService
- Parameters:
timeout
- the maximum time to wait- Throws:
java.util.concurrent.TimeoutException
- if the service has not reached the given state within the deadline- Since:
- 28.0
-
awaitRunning
public final void awaitRunning(long timeout, java.util.concurrent.TimeUnit unit) throws java.util.concurrent.TimeoutException
Description copied from interface:Service
Waits for theService
to reach the running state for no more than the given time.- Specified by:
awaitRunning
in interfaceService
- Parameters:
timeout
- the maximum time to waitunit
- the time unit of the timeout argument- Throws:
java.util.concurrent.TimeoutException
- if the service has not reached the given state within the deadline
-
awaitTerminated
public final void awaitTerminated()
Description copied from interface:Service
Waits for theService
to reach the terminated state.- Specified by:
awaitTerminated
in interfaceService
-
awaitTerminated
public final void awaitTerminated(java.time.Duration timeout) throws java.util.concurrent.TimeoutException
Description copied from interface:Service
Waits for theService
to reach a terminal state (eitherterminated
orfailed
) for no more than the given time.- Specified by:
awaitTerminated
in interfaceService
- Parameters:
timeout
- the maximum time to wait- Throws:
java.util.concurrent.TimeoutException
- if the service has not reached the given state within the deadline- Since:
- 28.0
-
awaitTerminated
public final void awaitTerminated(long timeout, java.util.concurrent.TimeUnit unit) throws java.util.concurrent.TimeoutException
Description copied from interface:Service
Waits for theService
to reach a terminal state (eitherterminated
orfailed
) for no more than the given time.- Specified by:
awaitTerminated
in interfaceService
- Parameters:
timeout
- the maximum time to waitunit
- the time unit of the timeout argument- Throws:
java.util.concurrent.TimeoutException
- if the service has not reached the given state within the deadline
-
checkCurrentState
private void checkCurrentState(Service.State expected)
Checks that the current state is equal to the expected state.
-
notifyStarted
protected final void notifyStarted()
Implementing classes should invoke this method once their service has started. It will cause the service to transition fromService.State.STARTING
toService.State.RUNNING
.- Throws:
java.lang.IllegalStateException
- if the service is notService.State.STARTING
.
-
notifyStopped
protected final void notifyStopped()
Implementing classes should invoke this method once their service has stopped. It will cause the service to transition fromService.State.STARTING
orService.State.STOPPING
toService.State.TERMINATED
.- Throws:
java.lang.IllegalStateException
- if the service is not one ofService.State.STOPPING
,Service.State.STARTING
, orService.State.RUNNING
.
-
notifyFailed
protected final void notifyFailed(java.lang.Throwable cause)
Invoke this method to transition the service to theService.State.FAILED
. The service will not be stopped if it is running. Invoke this method when a service has failed critically or otherwise cannot be started nor stopped.
-
isRunning
public final boolean isRunning()
Description copied from interface:Service
Returnstrue
if this service is running.
-
state
public final Service.State state()
Description copied from interface:Service
Returns the lifecycle state of the service.
-
failureCause
public final java.lang.Throwable failureCause()
Description copied from interface:Service
Returns theThrowable
that caused this service to fail.- Specified by:
failureCause
in interfaceService
- Since:
- 14.0
-
addListener
public final void addListener(Service.Listener listener, java.util.concurrent.Executor executor)
Description copied from interface:Service
Registers aService.Listener
to be executed on the given executor. The listener will have the corresponding transition method called whenever the service changes state. The listener will not have previous state changes replayed, so it is suggested that listeners are added before the service starts.addListener
guarantees execution ordering across calls to a given listener but not across calls to multiple listeners. Specifically, a given listener will have its callbacks invoked in the same order as the underlying service enters those states. Additionally, at most one of the listener's callbacks will execute at once. However, multiple listeners' callbacks may execute concurrently, and listeners may execute in an order different from the one in which they were registered.RuntimeExceptions thrown by a listener will be caught and logged. Any exception thrown during
Executor.execute
(e.g., aRejectedExecutionException
) will be caught and logged.- Specified by:
addListener
in interfaceService
- Parameters:
listener
- the listener to run when the service changes state is completeexecutor
- the executor in which the listeners callback methods will be run. For fast, lightweight listeners that would be safe to execute in any thread, considerMoreExecutors.directExecutor()
.- Since:
- 13.0
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
dispatchListenerEvents
private void dispatchListenerEvents()
-
enqueueStartingEvent
private void enqueueStartingEvent()
-
enqueueRunningEvent
private void enqueueRunningEvent()
-
enqueueStoppingEvent
private void enqueueStoppingEvent(Service.State from)
-
enqueueTerminatedEvent
private void enqueueTerminatedEvent(Service.State from)
-
enqueueFailedEvent
private void enqueueFailedEvent(Service.State from, java.lang.Throwable cause)
-
-