/*
* 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.hive.common.classification;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* These annotations are meant to indicate how to handle retry logic.
* Initially meant for Metastore API when made across a network, i.e. asynchronously where
* the response may not reach the caller and thus it cannot know if the operation was actually
* performed on the server.
*/
@InterfaceStability.Evolving
@InterfaceAudience.LimitedPrivate("Hive developer")
public class RetrySemantics {
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Idempotent {
String[] value() default "";
int maxRetryCount() default Integer.MAX_VALUE;
int delayMs() default 100;
}
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface ReadOnly {/*trivially retry-able*/}
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface CannotRetry {}
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface SafeToRetry {
/*may not be Idempotent but is safe to retry*/
String[] value() default "";
}
}