net.devh.boot.grpc.server.security.authentication

Class BasicGrpcAuthenticationReader

java.lang.Object

net.devh.boot.grpc.server.security.authentication.BasicGrpcAuthenticationReader

All Implemented Interfaces:

GrpcAuthenticationReader

public class BasicGrpcAuthenticationReader
extends Object
implements GrpcAuthenticationReader

Reads basic auth credentials from the request.

Constructor Summary

Constructors

Constructor and Description
BasicGrpcAuthenticationReader()

Method Summary

Modifier and Type	Method and Description
Authentication	readAuthentication(io.grpc.ServerCall<?,?> call, io.grpc.Metadata headers) Tries to read the Authentication information from the given call and metadata.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicGrpcAuthenticationReader

public BasicGrpcAuthenticationReader()

Method Detail

readAuthentication

public Authentication readAuthentication(io.grpc.ServerCall<?,?> call,
                                         io.grpc.Metadata headers)
                                  throws AuthenticationException

Description copied from interface: GrpcAuthenticationReader

Tries to read the Authentication information from the given call and metadata.

Note: Implementations are free to throw an AuthenticationException if no credentials could be found in the call. If an exception is thrown by an implementation then the authentication attempt should be considered as failed and no subsequent GrpcAuthenticationReaders should be called. Additionally, the call will fail as Status.UNAUTHENTICATED. If the call instead returns null, then the call processing will proceed unauthenticated.

Specified by:

readAuthentication in interface GrpcAuthenticationReader

Parameters:

call - The call to get that send the request.

headers - The metadata/headers as sent by the client.

Returns:

The authentication object or null if no authentication is present.

Throws:

AuthenticationException - If the authentication details are malformed or incomplete and thus the authentication attempt should be aborted.