Class AbstractApiService (2.38.0)

public abstract class AbstractApiService implements ApiService

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

Inheritance

java.lang.Object > AbstractApiService

Implements

ApiService

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

AbstractApiService()

protected AbstractApiService()

Methods

addListener(ApiService.Listener listener, Executor executor)

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

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

Parameters
Name	Description
`listener`	`ApiService.Listener`
`executor`	`Executor`

awaitRunning()

public void awaitRunning()

Waits for the ApiService to reach the running state.

awaitRunning(long timeout, TimeUnit unit)

public void awaitRunning(long timeout, TimeUnit unit)

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

Parameters
Name	Description
`timeout`	`long`
`unit`	`TimeUnit`

Exceptions
Type	Description
`TimeoutException`

awaitTerminated()

public void awaitTerminated()

Waits for the ApiService to reach the terminated state.

awaitTerminated(long timeout, TimeUnit unit)

public 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.

Parameters
Name	Description
`timeout`	`long`
`unit`	`TimeUnit`

Exceptions
Type	Description
`TimeoutException`

doStart()

protected abstract void doStart()

doStop()

protected abstract void doStop()

failureCause()

public Throwable failureCause()

Returns the Throwable that caused this service to fail.

Returns
Type	Description
`Throwable`

isRunning()

public boolean isRunning()

Returns true if this service is running.

Returns
Type	Description
`boolean`

notifyFailed(Throwable cause)

protected void notifyFailed(Throwable cause)

Parameter
Name	Description
`cause`	`Throwable`

notifyStarted()

protected void notifyStarted()

notifyStopped()

protected void notifyStopped()

startAsync()

public ApiService startAsync()

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

Returns
Type	Description
`ApiService`

state()

public ApiService.State state()

Returns the lifecycle state of the service.

Returns
Type	Description
`ApiService.State`

stopAsync()

public ApiService stopAsync()

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.

Returns
Type	Description
`ApiService`