Package com.google.api.core

Class AbstractApiService

  • All Implemented Interfaces:
    ApiService
    public abstract class AbstractApiService
extends Object
implements ApiService
    Base class for ApiService. Similar to Guava's AbstractService but redeclared so that Guava can be shaded.

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

      • 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

      • 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)