com.google.common.util.concurrent

Class ForwardingService

java.lang.Object

com.google.common.collect.ForwardingObject

com.google.common.util.concurrent.ForwardingService

All Implemented Interfaces:

Service

Deprecated.

Instead of using a ForwardingService, consider using the Service.Listener functionality to hook into the Service lifecycle, or if you really do need to provide access to some Service methods, consider just providing the few that you actually need (e.g. just startAndWait()) and not implementing Service.

@Beta
@Deprecated
public abstract class ForwardingService
extends ForwardingObject
implements Service

A Service that forwards all method calls to another service.

Since:

1.0

Author:

Chris Nokleberg

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

Service.Listener, Service.State

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ForwardingService() Deprecated. Constructor for use by subclasses.

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(Service.Listener listener, Executor executor) Deprecated. Registers a Service.Listener to be executed on the given executor.
void	awaitRunning() Deprecated. Waits for the Service to reach the running state.
void	awaitRunning(long timeout, TimeUnit unit) Deprecated. Waits for the Service to reach the running state for no more than the given time.
void	awaitTerminated() Deprecated. Waits for the Service to reach the terminated state.
void	awaitTerminated(long timeout, TimeUnit unit) Deprecated. Waits for the Service to reach a terminal state (either terminated or failed) for no more than the given time.
protected abstract Service	delegate() Deprecated. Returns the backing delegate instance that methods are forwarded to.
Throwable	failureCause() Deprecated. Returns the Throwable that caused this service to fail.
boolean	isRunning() Deprecated. Returns true if this service is running.
protected Service.State	standardStartAndWait() Deprecated. A sensible default implementation of startAndWait(), in terms of start().
protected Service.State	standardStopAndWait() Deprecated. A sensible default implementation of stopAndWait(), in terms of stop().
ListenableFuture<Service.State>	start() Deprecated.
Service.State	startAndWait() Deprecated.
Service	startAsync() Deprecated. If the service state is Service.State.NEW, this initiates service startup and returns immediately.
Service.State	state() Deprecated. Returns the lifecycle state of the service.
ListenableFuture<Service.State>	stop() Deprecated.
Service.State	stopAndWait() Deprecated.
Service	stopAsync() Deprecated. If the service is starting or running, this initiates service shutdown and returns immediately.

Methods inherited from class com.google.common.collect.ForwardingObject

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ForwardingService

protected ForwardingService()

Deprecated.

Constructor for use by subclasses.

Method Detail

delegate

protected abstract Service delegate()

Deprecated.

Description copied from class: ForwardingObject

Returns the backing delegate instance that methods are forwarded to. Abstract subclasses generally override this method with an abstract method that has a more specific return type, such as ForwardingSet.delegate(). Concrete subclasses override this method to supply the instance being decorated.

Specified by:

delegate in class ForwardingObject

start

@Deprecated
public ListenableFuture<Service.State> start()

Deprecated.

Description copied from interface: Service

If the service state is Service.State.NEW, this initiates service startup and returns immediately. If the service has already been started, this method returns immediately without taking action. A stopped service may not be restarted.

Specified by:

start in interface Service

Returns:

a future for the startup result, regardless of whether this call initiated startup. Calling Future.get() will block until the service has finished starting, and returns one of Service.State.RUNNING, Service.State.STOPPING or Service.State.TERMINATED. If the service fails to start, Future.get() will throw an ExecutionException, and the service's state will be Service.State.FAILED. If it has already finished starting, Future.get() returns immediately. Cancelling this future has no effect on the service.

state

public Service.State state()

Deprecated.

Description copied from interface: Service

Returns the lifecycle state of the service.

Specified by:

state in interface Service

stop

@Deprecated
public ListenableFuture<Service.State> stop()

Deprecated.

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.

Specified by:

stop in interface Service

Returns:

a future for the shutdown result, regardless of whether this call initiated shutdown. Calling Future.get() will block until the service has finished shutting down, and either returns Service.State.TERMINATED or throws an ExecutionException. If it has already finished stopping, Future.get() returns immediately. Cancelling this future has no effect on the service.

startAndWait

@Deprecated
public Service.State startAndWait()

Deprecated.

Description copied from interface: Service

Initiates service startup (if necessary), returning once the service has finished starting. Unlike calling start().get(), this method throws no checked exceptions, and it cannot be interrupted.

Specified by:

startAndWait in interface Service

Returns:

the state of the service when startup finished.

stopAndWait

@Deprecated
public Service.State stopAndWait()

Deprecated.

Description copied from interface: Service

Initiates service shutdown (if necessary), returning once the service has finished stopping. If this is Service.State.STARTING, startup will be cancelled. If this is Service.State.NEW, it is terminated without having been started nor stopped. Unlike calling stop().get(), this method throws no checked exceptions.

Specified by:

stopAndWait in interface Service

Returns:

the state of the service when shutdown finished.

isRunning

public boolean isRunning()

Deprecated.

Description copied from interface: Service

Returns true if this service is running.

Specified by:

isRunning in interface Service

addListener

public void addListener(Service.Listener listener,
               Executor executor)

Deprecated.

Description copied from interface: Service

Registers a Service.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.

There is no guaranteed ordering of execution of listeners, but any listener added through this method is guaranteed to be called whenever there is a state change.

Exceptions thrown by a listener will be propagated up to the executor. Any exception thrown during Executor.execute (e.g., a RejectedExecutionException or an exception thrown by inline execution) will be caught and logged.

Specified by:

addListener in interface Service

Parameters:

listener - the listener to run when the service changes state is complete

executor - the executor in which the listeners callback methods will be run. For fast, lightweight listeners that would be safe to execute in any thread, consider MoreExecutors.sameThreadExecutor().

Since:

13.0

failureCause

public Throwable failureCause()

Deprecated.

Description copied from interface: Service

Returns the Throwable that caused this service to fail.

Specified by:

failureCause in interface Service

Since:

14.0

startAsync

public Service startAsync()

Deprecated.

Description copied from interface: Service

If the service state is Service.State.NEW, this initiates service startup and returns immediately. A stopped service may not be restarted.

Specified by:

startAsync in interface Service

Returns:

this

Since:

15.0

stopAsync

public Service stopAsync()

Deprecated.

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.

Specified by:

stopAsync in interface Service

Returns:

this

Since:

15.0

awaitRunning

public void awaitRunning()

Deprecated.

Description copied from interface: Service

Waits for the Service to reach the running state.

Specified by:

awaitRunning in interface Service

Since:

15.0

awaitRunning

public void awaitRunning(long timeout,
                TimeUnit unit)
                  throws TimeoutException

Deprecated.

Description copied from interface: Service

Waits for the Service to reach the running state for no more than the given time.

Specified by:

awaitRunning in interface Service

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Throws:

TimeoutException - if the service has not reached the given state within the deadline

Since:

15.0

awaitTerminated

public void awaitTerminated()

Deprecated.

Description copied from interface: Service

Waits for the Service to reach the terminated state.

Specified by:

awaitTerminated in interface Service

Since:

15.0

awaitTerminated

public void awaitTerminated(long timeout,
                   TimeUnit unit)
                     throws TimeoutException

Deprecated.

Description copied from interface: Service

Waits for the Service to reach a terminal state (either terminated or failed) for no more than the given time.

Specified by:

awaitTerminated in interface Service

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Throws:

TimeoutException - if the service has not reached the given state within the deadline

Since:

15.0

standardStartAndWait

protected Service.State standardStartAndWait()

Deprecated.

A sensible default implementation of startAndWait(), in terms of start(). If you override start(), you may wish to override startAndWait() to forward to this implementation.

Since:

9.0

standardStopAndWait

protected Service.State standardStopAndWait()

Deprecated.

A sensible default implementation of stopAndWait(), in terms of stop(). If you override stop(), you may wish to override stopAndWait() to forward to this implementation.

Since:

9.0