com.google.api.core.ApiService Maven / Gradle / Ivy
Show all versions of api-common Show documentation
/*
* Copyright 2017, Google Inc.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.google.api.core;
import java.util.concurrent.Executor;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
/**
* An object with an operational state, plus asynchronous {@link #startAsync()} and {@link
* #stopAsync()} lifecycle methods to transition between states. Example services include
* webservers, RPC servers and timers.
*
* The normal lifecycle of a service is:
*
*
* - {@linkplain State#NEW NEW} ->
*
- {@linkplain State#STARTING STARTING} ->
*
- {@linkplain State#RUNNING RUNNING} ->
*
- {@linkplain State#STOPPING STOPPING} ->
*
- {@linkplain State#TERMINATED TERMINATED}
*
*
* There are deviations from this if there are failures or if {@link ApiService#stopAsync} is
* called before the {@link ApiService} reaches the {@linkplain State#RUNNING RUNNING} state. The
* set of legal transitions form a DAG, therefore every method of the
* listener will be called at most once. N.B. The {@link State#FAILED} and {@link State#TERMINATED}
* states are terminal states, once a service enters either of these states it cannot ever leave
* them.
*
*
Implementors of this interface are strongly encouraged to extend {@link AbstractApiService}
* which implement this interface and make the threading and state management easier.
*
*
Similar to Guava's {@code Service}, but redeclared so that Guava could be shaded.
*/
public interface ApiService {
/**
* Registers a {@link Listener} to be {@linkplain Executor#execute 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.
*
*
{@code 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 {@code Executor.execute} (e.g., a {@code RejectedExecutionException}) will be caught and
* logged.
*
* @param listener the listener to run when the service changes state is complete
* @param executor the executor in which the listeners callback methods will be run.
*/
void addListener(Listener listener, Executor executor);
/**
* Waits for the {@link ApiService} to reach the {@linkplain State#RUNNING running state}.
*
* @throws IllegalStateException if the service reaches a state from which it is not possible to
* enter the {@link State#RUNNING} state. e.g. if the {@code state} is {@code
* State#TERMINATED} when this method is called then this will throw an IllegalStateException.
*/
void awaitRunning();
/**
* Waits for the {@link ApiService} to reach the {@linkplain State#RUNNING running state} for no
* more than the given time.
*
* @param timeout the maximum time to wait
* @param unit the time unit of the timeout argument
* @throws TimeoutException if the service has not reached the given state within the deadline
* @throws IllegalStateException if the service reaches a state from which it is not possible to
* enter the {@link State#RUNNING RUNNING} state. e.g. if the {@code state} is {@code
* State#TERMINATED} when this method is called then this will throw an IllegalStateException.
*/
void awaitRunning(long timeout, TimeUnit unit) throws TimeoutException;
/**
* Waits for the {@link ApiService} to reach the {@linkplain State#TERMINATED terminated state}.
*
* @throws IllegalStateException if the service {@linkplain State#FAILED fails}.
*/
void awaitTerminated();
/**
* Waits for the {@link ApiService} to reach a terminal state (either {@link State#TERMINATED
* terminated} or {@link State#FAILED failed}) for no more than the given time.
*
* @param timeout the maximum time to wait
* @param unit the time unit of the timeout argument
* @throws TimeoutException if the service has not reached the given state within the deadline
* @throws IllegalStateException if the service {@linkplain State#FAILED fails}.
*/
void awaitTerminated(long timeout, TimeUnit unit) throws TimeoutException;
/**
* Returns the {@link Throwable} that caused this service to fail.
*
* @throws IllegalStateException if this service's state isn't {@linkplain State#FAILED FAILED}.
*/
Throwable failureCause();
/** Returns {@code true} if this service is {@linkplain State#RUNNING running}. */
boolean isRunning();
/**
* If the service state is {@link State#NEW}, this initiates service startup and returns
* immediately. A stopped service may not be restarted.
*
* @return this
* @throws IllegalStateException if the service is not {@link State#NEW}
*/
ApiService startAsync();
/** Returns the lifecycle state of the service. */
State state();
/**
* If the service is {@linkplain State#STARTING starting} or {@linkplain State#RUNNING running},
* this initiates service shutdown and returns immediately. If the service is {@linkplain
* State#NEW new}, it is {@linkplain State#TERMINATED terminated} without having been started nor
* stopped. If the service has already been stopped, this method returns immediately without
* taking action.
*
* @return this
*/
ApiService stopAsync();
/**
* The lifecycle states of a service.
*
*
The ordering of the {@link State} enum is defined such that if there is a state transition
* from {@code A -> B} then {@code A.compareTo(B) < 0}. N.B. The converse is not true, i.e. if
* {@code A.compareTo(B) < 0} then there is not guaranteed to be a valid state transition
* {@code A -> B}.
*/
enum State {
/**
* A service in this state has encountered a problem and may not be operational. It cannot be
* started nor stopped.
*/
FAILED,
/** A service in this state is inactive. It does minimal work and consumes minimal resources. */
NEW,
/** A service in this state is operational. */
RUNNING,
/** A service in this state is transitioning to {@link #RUNNING}. */
STARTING,
/** A service in this state is transitioning to {@link #TERMINATED}. */
STOPPING,
/**
* A service in this state has completed execution normally. It does minimal work and consumes
* minimal resources.
*/
TERMINATED
}
/**
* A listener for the various state changes that a {@link ApiService} goes through in its
* lifecycle.
*
*
All methods are no-ops by default, implementors should override the ones they care about.
*/
abstract class Listener {
/**
* Called when the service transitions to the {@linkplain State#FAILED FAILED} state. The
* {@linkplain State#FAILED FAILED} state is a terminal state in the transition diagram.
* Therefore, if this method is called, no other methods will be called on the {@link Listener}.
*
* @param from The previous state that is being transitioned from. Failure can occur in any
* state with the exception of {@linkplain State#NEW NEW} or {@linkplain State#TERMINATED
* TERMINATED}.
* @param failure The exception that caused the failure.
*/
public void failed(State from, Throwable failure) {}
/**
* Called when the service transitions from {@linkplain State#STARTING STARTING} to {@linkplain
* State#RUNNING RUNNING}. This occurs when a service has successfully started.
*/
public void running() {}
/**
* Called when the service transitions from {@linkplain State#NEW NEW} to {@linkplain
* State#STARTING STARTING}. This occurs when {@link ApiService#startAsync} is called the first
* time.
*/
public void starting() {}
/**
* Called when the service transitions to the {@linkplain State#STOPPING STOPPING} state. The
* only valid values for {@code from} are {@linkplain State#STARTING STARTING} or {@linkplain
* State#RUNNING RUNNING}. This occurs when {@link ApiService#stopAsync} is called.
*
* @param from The previous state that is being transitioned from.
*/
public void stopping(State from) {}
/**
* Called when the service transitions to the {@linkplain State#TERMINATED TERMINATED} state.
* The {@linkplain State#TERMINATED TERMINATED} state is a terminal state in the transition
* diagram. Therefore, if this method is called, no other methods will be called on the {@link
* Listener}.
*
* @param from The previous state that is being transitioned from. The only valid values for
* this are {@linkplain State#NEW NEW}, {@linkplain State#RUNNING RUNNING} or {@linkplain
* State#STOPPING STOPPING}.
*/
public void terminated(State from) {}
}
}