Package org.opensearch.core.action

Class NotifyOnceListener<Response>

java.lang.Object

org.opensearch.core.action.NotifyOnceListener<Response>

All Implemented Interfaces:

ActionListener<Response>

@PublicApi(since="1.0.0")
public abstract class NotifyOnceListener<Response>
extends Object
implements ActionListener<Response>

A listener that ensures that only one of onResponse or onFailure is called. And the method the is called is only called once. Subclasses should implement notification logic with innerOnResponse and innerOnFailure.

Opensearch.api:

Constructor Summary

Constructors

Constructor	Description
NotifyOnceListener()

Method Summary

Modifier and Type	Method	Description
protected abstract void	innerOnFailure(Exception e)
protected abstract void	innerOnResponse(Response response)
final void	onFailure(Exception e)	A failure caused by an exception at some phase of the task.
final void	onResponse(Response response)	Handle action response.

Methods inherited from class java.lang.Object

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

Constructor Details

NotifyOnceListener

public NotifyOnceListener()

Method Details

innerOnResponse

protected abstract void innerOnResponse(Response response)

innerOnFailure

protected abstract void innerOnFailure(Exception e)

onResponse

public final void onResponse(Response response)

Description copied from interface: ActionListener

Handle action response. This response may constitute a failure or a success but it is up to the listener to make that decision.

Specified by:

onResponse in interface ActionListener<Response>

onFailure

public final void onFailure(Exception e)

Description copied from interface: ActionListener

A failure caused by an exception at some phase of the task.

Specified by:

onFailure in interface ActionListener<Response>