org.apache.hadoop.hbase.client.RetryingCallerInterceptorContext Maven / Gradle / Ivy
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.hadoop.hbase.client;
import org.apache.yetus.audience.InterfaceAudience;
/**
* The context object used in the {@link RpcRetryingCaller} to enable
* {@link RetryingCallerInterceptor} to intercept calls.
* {@link RetryingCallerInterceptorContext} is the piece of information unique
* to a retrying call that transfers information from the call into the
* {@link RetryingCallerInterceptor} so that {@link RetryingCallerInterceptor}
* can take appropriate action according to the specific logic
*
*/
@InterfaceAudience.Private
abstract class RetryingCallerInterceptorContext {
protected RetryingCallerInterceptorContext() {
}
/**
* This function clears the internal state of the context object.
*/
public abstract void clear();
/**
* This prepares the context object by populating it with information specific
* to the implementation of the {@link RetryingCallerInterceptor} along with
* which this will be used.
*
* @param callable
* : The {@link RetryingCallable} that contains the information about
* the call that is being made.
* @return A new {@link RetryingCallerInterceptorContext} object that can be
* used for use in the current retrying call
*/
public abstract RetryingCallerInterceptorContext prepare(RetryingCallable callable);
/**
* Telescopic extension that takes which of the many retries we are currently
* in.
*
* @param callable
* : The {@link RetryingCallable} that contains the information about
* the call that is being made.
* @param tries
* : The retry number that we are currently in.
* @return A new context object that can be used for use in the current
* retrying call
*/
public abstract RetryingCallerInterceptorContext prepare(RetryingCallable callable, int tries);
}