com.google.api.core

Class AbstractApiService

java.lang.Object

com.google.api.core.AbstractApiService

All Implemented Interfaces:

ApiService

@BetaApi
public abstract class AbstractApiService
extends Object
implements ApiService

Base class for ApiService. Similar to Guava's AbstractService but redeclared to that Guava can be shaded.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.api.core.ApiService

ApiService.Listener, ApiService.State

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractApiService()

Method Summary

Modifier and Type	Method and Description
void	addListener(ApiService.Listener listener, Executor executor) Registers a ApiService.Listener to be executed on the given executor.
void	awaitRunning() Waits for the ApiService to reach the running state.
void	awaitRunning(long timeout, TimeUnit unit) Waits for the ApiService to reach the running state for no more than the given time.
void	awaitTerminated() Waits for the ApiService to reach the terminated state.
void	awaitTerminated(long timeout, TimeUnit unit) Waits for the ApiService to reach a terminal state (either terminated or failed) for no more than the given time.
protected abstract void	doStart()
protected abstract void	doStop()
Throwable	failureCause() Returns the Throwable that caused this service to fail.
boolean	isRunning() Returns true if this service is running.
protected void	notifyFailed(Throwable cause)
protected void	notifyStarted()
protected void	notifyStopped()
ApiService	startAsync() If the service state is ApiService.State.NEW, this initiates service startup and returns immediately.
ApiService.State	state() Returns the lifecycle state of the service.
ApiService	stopAsync() If the service is starting or running, this initiates service shutdown and returns immediately.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractApiService

protected AbstractApiService()

Method Detail

doStart

protected abstract void doStart()

doStop

protected abstract void doStop()

addListener

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

Description copied from interface: ApiService

Registers a ApiService.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., a RejectedExecutionException) will be caught and logged.

Specified by:

addListener in interface ApiService

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.

awaitRunning

public void awaitRunning()

Description copied from interface: ApiService

Waits for the ApiService to reach the running state.

Specified by:

awaitRunning in interface ApiService

awaitRunning

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

Description copied from interface: ApiService

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

Specified by:

awaitRunning in interface ApiService

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

awaitTerminated

public void awaitTerminated()

Description copied from interface: ApiService

Waits for the ApiService to reach the terminated state.

Specified by:

awaitTerminated in interface ApiService

awaitTerminated

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

Description copied from interface: ApiService

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

Specified by:

awaitTerminated in interface ApiService

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

failureCause

public Throwable failureCause()

Description copied from interface: ApiService

Returns the Throwable that caused this service to fail.

Specified by:

failureCause in interface ApiService

isRunning

public boolean isRunning()

Description copied from interface: ApiService

Returns true if this service is running.

Specified by:

isRunning in interface ApiService

startAsync

public ApiService startAsync()

Description copied from interface: ApiService

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

Specified by:

startAsync in interface ApiService

Returns:

this

state

public ApiService.State state()

Description copied from interface: ApiService

Returns the lifecycle state of the service.

Specified by:

state in interface ApiService

stopAsync

public ApiService stopAsync()

Description copied from interface: ApiService

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 ApiService

Returns:

this

notifyStarted

protected void notifyStarted()

notifyStopped

protected void notifyStopped()

notifyFailed

protected void notifyFailed(Throwable cause)