RetryingCallerInterceptor (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.client.RetryingCallerInterceptor

Direct Known Subclasses:

NoOpRetryableCallerInterceptor, PreemptiveFastFailInterceptor
```
@InterfaceAudience.Private
abstract class RetryingCallerInterceptor
extends Object
```
This class is designed to fit into the RetryingCaller class which forms the central piece of intelligence for the client side retries for most calls. One can extend this class and intercept the RetryingCaller and add additional logic into the execution of a simple HTable operations like get, delete etc. Concrete implementations of this calls are supposed to the thread safe. The object is used across threads to identify the fast failing threads. For a concrete use case see PreemptiveFastFailInterceptor Example use case : try { interceptor.intercept doAction() } catch (Exception e) { interceptor.handleFailure } finally { interceptor.updateFaulireInfo } The RetryingCallerInterceptor also acts as a factory for getting a new RetryingCallerInterceptorContext.

Constructor Summary

Constructors
Modifier Constructor and Description

protected RetryingCallerInterceptor()

Constructors
Modifier	Constructor and Description
`protected`	`RetryingCallerInterceptor()`

Method Summary

Methods
Modifier and Type	Method and Description
`abstract RetryingCallerInterceptorContext`	`createEmptyContext()` This returns the context object for the current call.
`abstract void`	`handleFailure(RetryingCallerInterceptorContext context, Throwable t)` Call this function in case we caught a failure during retries.
`abstract void`	`intercept(RetryingCallerInterceptorContext abstractRetryingCallerInterceptorContext)` Call this function alongside the actual call done on the callable.
`abstract String`	`toString()`
`abstract void`	`updateFailureInfo(RetryingCallerInterceptorContext context)` Call this function to update at the end of the retry.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RetryingCallerInterceptor
```
protected RetryingCallerInterceptor()
```
- Method Detail
  - createEmptyContext
```
public abstract RetryingCallerInterceptorContext createEmptyContext()
```
    This returns the context object for the current call.
    
    Returns:
    context : the context that needs to be used during this call.
  - handleFailure
```
public abstract void handleFailure(RetryingCallerInterceptorContext context,
                 Throwable t)
                            throws IOException
```
    Call this function in case we caught a failure during retries.
    
    Parameters:
    context - : The context object that we obtained previously.
    t - : The exception that we caught in this particular try
    
    Throws:
    
    IOException
  - intercept
```
public abstract void intercept(RetryingCallerInterceptorContext abstractRetryingCallerInterceptorContext)
                        throws IOException
```
    Call this function alongside the actual call done on the callable.
    
    Parameters:
    abstractRetryingCallerInterceptorContext -
    
    Throws:
    
    PreemptiveFastFailException
    
    IOException
  - updateFailureInfo
```
public abstract void updateFailureInfo(RetryingCallerInterceptorContext context)
```
    Call this function to update at the end of the retry. This is not necessary to happen.
    
    Parameters:
    context -
  - toString
```
public abstract String toString()
```
    Overrides:
    
    toString in class Object

Class RetryingCallerInterceptor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RetryingCallerInterceptor

Method Detail

createEmptyContext

handleFailure

intercept

updateFailureInfo

toString