grpcstarter.server.feature.exceptionhandling.annotation.GrpcExceptionHandler Maven / Gradle / Ivy

Go to download
package grpcstarter.server.feature.exceptionhandling.annotation;

import io.grpc.Metadata;
import io.grpc.ServerCall;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * {@link GrpcExceptionHandler} is used to mark an exception handler method.
 *
 *  Supported return types are:
 * 

 *     {@link io.grpc.Status}
 *     {@link io.grpc.StatusException}
 *     {@link io.grpc.StatusRuntimeException}
 *     {@link Throwable}
 * 
 *
 *  Basic usage:
 * 
{@code
 * @GrpcAdvice
 * public class ExceptionAdvice {
 *     @GrpcExceptionHandler
 *     public StatusRuntimeException handleRuntimeException(RuntimeException e) {
 *         return Status.INTERNAL.withDescription(e.getMessage()).asRuntimeException();
 *     }
 * }
 * }
 *
 *  Inject {@link ServerCall} and {@link Metadata}:
 *
 * 
{@code
 * @GrpcAdvice
 * public class ExceptionAdvice {
 *     @GrpcExceptionHandler
 *     public StatusRuntimeException handleRuntimeException(RuntimeException e, ServerCall call, Metadata headers) {
 *         return Status.INTERNAL.withDescription(e.getMessage()).asRuntimeException();
 *     }
 * }
 * }
 *
 * @author Freeman
 */
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface GrpcExceptionHandler {
    /**
     * Exceptions handled by the annotated method. If empty, will default to any
     * exceptions listed in the method argument list.
     */
    Class[] value() default {};
}