org.bytedeco.arrow_flight

Class ServerAuthHandler

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow_flight.ServerAuthHandler

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

NoOpAuthHandler

@Namespace(value="arrow::flight")
 @Properties(inherit=arrow_flight.class)
public class ServerAuthHandler
extends Pointer

\brief An authentication implementation for a Flight service. Authentication includes both an initial negotiation and a per-call token validation. Implementations may choose to use either or both mechanisms. An implementation may need to track some state, e.g. a mapping of client tokens to authenticated identities.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
ServerAuthHandler(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Status	Authenticate(ServerAuthSender outgoing, ServerAuthReader incoming) \brief Authenticate the client on initial connection.
Status	IsValid(BytePointer token, BytePointer peer_identity)
Status	IsValid(String token, BytePointer peer_identity) \brief Validate a per-call client token.

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ServerAuthHandler

public ServerAuthHandler(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

Authenticate

@ByVal
public Status Authenticate(ServerAuthSender outgoing,
                                   ServerAuthReader incoming)

\brief Authenticate the client on initial connection. The server can send and read responses from the client at any time.

IsValid

@ByVal
public Status IsValid(@StdString
                              String token,
                              @StdString @Cast(value={"char*","std::string*"})
                              BytePointer peer_identity)

\brief Validate a per-call client token.

Parameters:

token - [in] The client token. May be the empty string if the client does not provide a token.

peer_identity - [out] The identity of the peer, if this authentication method supports it.

Returns:

Status OK if the token is valid, any other status if validation failed

IsValid

@ByVal
public Status IsValid(@StdString
                              BytePointer token,
                              @StdString @Cast(value={"char*","std::string*"})
                              BytePointer peer_identity)