net.devh.boot.grpc.server.security.interceptors

Class ExceptionTranslatingServerInterceptor

java.lang.Object

net.devh.boot.grpc.server.security.interceptors.ExceptionTranslatingServerInterceptor

All Implemented Interfaces:

io.grpc.ServerInterceptor

@GrpcGlobalServerInterceptor
 @Order(value=5000)
public class ExceptionTranslatingServerInterceptor
extends Object
implements io.grpc.ServerInterceptor

Server interceptor that translates any AuthenticationException and AccessDeniedException to appropriate grpc status responses.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCESS_DENIED_DESCRIPTION A constant that contains the response message for calls with insufficient permissions.
static String	UNAUTHENTICATED_DESCRIPTION A constant that contains the response message for unauthenticated calls.

Constructor Summary

Constructors

Constructor and Description
ExceptionTranslatingServerInterceptor()

Method Summary

Modifier and Type	Method and Description
protected void	closeCallAccessDenied(io.grpc.ServerCall<?,?> call, AccessDeniedException aex) Close the call with Status.PERMISSION_DENIED.
protected void	closeCallUnauthenticated(io.grpc.ServerCall<?,?> call, AuthenticationException aex) Close the call with Status.UNAUTHENTICATED.
<ReqT,RespT> io.grpc.ServerCall.Listener<ReqT>	interceptCall(io.grpc.ServerCall<ReqT,RespT> call, io.grpc.Metadata headers, io.grpc.ServerCallHandler<ReqT,RespT> next)
protected <ReqT> io.grpc.ServerCall.Listener<ReqT>	noOpCallListener() Creates a new no-op call listener because you can neither return null nor throw an exception in interceptCall(ServerCall, Metadata, ServerCallHandler).

Methods inherited from class java.lang.Object

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

Field Detail

UNAUTHENTICATED_DESCRIPTION

public static final String UNAUTHENTICATED_DESCRIPTION

A constant that contains the response message for unauthenticated calls.

See Also:

Constant Field Values

ACCESS_DENIED_DESCRIPTION

public static final String ACCESS_DENIED_DESCRIPTION

A constant that contains the response message for calls with insufficient permissions.

See Also:

Constant Field Values

Constructor Detail

ExceptionTranslatingServerInterceptor

public ExceptionTranslatingServerInterceptor()

Method Detail

interceptCall

public <ReqT,RespT> io.grpc.ServerCall.Listener<ReqT> interceptCall(io.grpc.ServerCall<ReqT,RespT> call,
                                                                    io.grpc.Metadata headers,
                                                                    io.grpc.ServerCallHandler<ReqT,RespT> next)

Specified by:

interceptCall in interface io.grpc.ServerInterceptor

noOpCallListener

protected <ReqT> io.grpc.ServerCall.Listener<ReqT> noOpCallListener()

Creates a new no-op call listener because you can neither return null nor throw an exception in interceptCall(ServerCall, Metadata, ServerCallHandler).

Type Parameters:

ReqT - The type of the request.

Returns:

The newly created dummy listener.

closeCallUnauthenticated

protected void closeCallUnauthenticated(io.grpc.ServerCall<?,?> call,
                                        AuthenticationException aex)

Close the call with Status.UNAUTHENTICATED.

Parameters:

call - The call to close.

aex - The exception that was the cause.

closeCallAccessDenied

protected void closeCallAccessDenied(io.grpc.ServerCall<?,?> call,
                                     AccessDeniedException aex)

Close the call with Status.PERMISSION_DENIED.

Parameters:

call - The call to close.

aex - The exception that was the cause.