Package com.google.api.core

Class ApiService.Listener

java.lang.Object

com.google.api.core.ApiService.Listener

Enclosing interface:

ApiService

@BetaApi
public abstract static class ApiService.Listener
extends Object

A listener for the various state changes that a ApiService goes through in its lifecycle.

All methods are no-ops by default, implementors should override the ones they care about.

Constructor Summary

Constructors

Constructor	Description
Listener()

Method Summary

Modifier and Type	Method	Description
void	failed(ApiService.State from, Throwable failure)	Called when the service transitions to the FAILED state.
void	running()	Called when the service transitions from STARTING to RUNNING.
void	starting()	Called when the service transitions from NEW to STARTING.
void	stopping(ApiService.State from)	Called when the service transitions to the STOPPING state.
void	terminated(ApiService.State from)	Called when the service transitions to the TERMINATED state.

Methods inherited from class java.lang.Object

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

Constructor Detail

Listener

public Listener()

Method Detail

failed

public void failed(ApiService.State from,
                   Throwable failure)

Called when the service transitions to the FAILED state. The FAILED state is a terminal state in the transition diagram. Therefore, if this method is called, no other methods will be called on the ApiService.Listener.

Parameters:

from - The previous state that is being transitioned from. Failure can occur in any state with the exception of NEW or TERMINATED.

failure - The exception that caused the failure.

running

public void running()

Called when the service transitions from STARTING to RUNNING. This occurs when a service has successfully started.

starting

public void starting()

Called when the service transitions from NEW to STARTING. This occurs when ApiService.startAsync() is called the first time.

stopping

public void stopping(ApiService.State from)

Called when the service transitions to the STOPPING state. The only valid values for from are STARTING or RUNNING. This occurs when ApiService.stopAsync() is called.

Parameters:

from - The previous state that is being transitioned from.

terminated

public void terminated(ApiService.State from)

Called when the service transitions to the TERMINATED state. The TERMINATED state is a terminal state in the transition diagram. Therefore, if this method is called, no other methods will be called on the ApiService.Listener.

Parameters:

from - The previous state that is being transitioned from. The only valid values for this are NEW, RUNNING or STOPPING.