Package io.deephaven.proto.auth

Interface ClientIdOrBuilder

All Superinterfaces:
io.deephaven.shadow.core.com.google.protobuf.MessageLiteOrBuilder, io.deephaven.shadow.core.com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ClientId, ClientId.Builder
public interface ClientIdOrBuilder extends io.deephaven.shadow.core.com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    A string to identify this client in server side log files.
    io.deephaven.shadow.core.com.google.protobuf.ByteString
    getNameBytes()
    A string to identify this client in server side log files.
    io.deephaven.shadow.core.com.google.protobuf.ByteString
    getUuid()
    A client uuid in bytes is created by client library code and used for the lifetime of that client process.

    Methods inherited from interface io.deephaven.shadow.core.com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface io.deephaven.shadow.core.com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getName

      String getName()
       A string to identify this client in server side log files.
 This has no relation to username in authentication, it is exclusively a way for client programs
 to provide support for ease of debugging, by providing descriptive text.
 A good example could be `python reconciliation script running on machine a.b.c.d`.
 The server will only use this string in the initial logging for a client connection.
 The intent is to facilitate debugging when an administrator or user of this API needs to find
 the entries for a given client program in server logs.
 The protocol is designed so that uuid is enough for tracing unique clients, so this string
 is not strictly necessary; it may save effort for an admin (or yourself) in tracking down
 a uuid in a sea of machines however.
 Libraries built on top of this proto are expected to allow users to provide their own string
 (hopefully including explanatory documentation for the purpose in their API definition).
 When users do not provide one, libraries are expected to provide sensible defaults
 (eg, "python client running on machine a.b.c.d").
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      io.deephaven.shadow.core.com.google.protobuf.ByteString getNameBytes()
       A string to identify this client in server side log files.
 This has no relation to username in authentication, it is exclusively a way for client programs
 to provide support for ease of debugging, by providing descriptive text.
 A good example could be `python reconciliation script running on machine a.b.c.d`.
 The server will only use this string in the initial logging for a client connection.
 The intent is to facilitate debugging when an administrator or user of this API needs to find
 the entries for a given client program in server logs.
 The protocol is designed so that uuid is enough for tracing unique clients, so this string
 is not strictly necessary; it may save effort for an admin (or yourself) in tracking down
 a uuid in a sea of machines however.
 Libraries built on top of this proto are expected to allow users to provide their own string
 (hopefully including explanatory documentation for the purpose in their API definition).
 When users do not provide one, libraries are expected to provide sensible defaults
 (eg, "python client running on machine a.b.c.d").
      string name = 1;
      Returns:
      The bytes for name.

    • getUuid

      io.deephaven.shadow.core.com.google.protobuf.ByteString getUuid()
       A client uuid in bytes is created by client library code and used for the lifetime of that client process.
 A client's uuid is expected by the server to be unique across all live client channels.
 If the same client process during its lifetime connects to different server processes,
 be it on different machines or different server process instances
 on the same machine (eg, server bounce), the client process is expected to use the same uuid to all servers.
 Note that uuids are a means for clients and servers to uniquely identify clients in log files;
 a uuid on its own is not enough to uniquely identify and trust a client session in the server.
 See 'cookie' in other messages below for a unique, and secret, client session identifier.
 The uuid is a user-visible unique name for a client, that can be used across non-overlapping sessions.
 The cookie is not user-visible and is provided by the protocol and required by the server to trust messages
 to have a particular client as origin.
      bytes uuid = 2;
      Returns:
      The uuid.