Package io.deephaven.proto.auth

Class ClientId

java.lang.Object
io.deephaven.shadow.core.com.google.protobuf.AbstractMessageLite
io.deephaven.shadow.core.com.google.protobuf.AbstractMessage
io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3
io.deephaven.proto.auth.ClientId
All Implemented Interfaces:
ClientIdOrBuilder, io.deephaven.shadow.core.com.google.protobuf.Message, io.deephaven.shadow.core.com.google.protobuf.MessageLite, io.deephaven.shadow.core.com.google.protobuf.MessageLiteOrBuilder, io.deephaven.shadow.core.com.google.protobuf.MessageOrBuilder, Serializable
public final class ClientId extends io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3 implements ClientIdOrBuilder
 A unique client identifier sent by clients to introduce themselves to servers.
Protobuf type io.deephaven.proto.auth.ClientId
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ClientId.Builder
    A unique client identifier sent by clients to introduce themselves to servers.

    Nested classes/interfaces inherited from class io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3

    io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.BuilderParent, io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class io.deephaven.shadow.core.com.google.protobuf.AbstractMessageLite

    io.deephaven.shadow.core.com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    UUID_FIELD_NUMBER
     

    Fields inherited from class io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class io.deephaven.shadow.core.com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class io.deephaven.shadow.core.com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static ClientId
    getDefaultInstance()
     
    ClientId
    getDefaultInstanceForType()
     
    static final io.deephaven.shadow.core.com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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.Parser<ClientId>
    getParserForType()
     
    int
    getSerializedSize()
     
    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.
    int
    hashCode()
     
    protected io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static ClientId.Builder
    newBuilder()
     
    static ClientId.Builder
    newBuilder(ClientId prototype)
     
    ClientId.Builder
    newBuilderForType()
     
    protected ClientId.Builder
    newBuilderForType(io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static ClientId
    parseDelimitedFrom(InputStream input)
     
    static ClientId
    parseDelimitedFrom(InputStream input, io.deephaven.shadow.core.com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ClientId
    parseFrom(byte[] data)
     
    static ClientId
    parseFrom(byte[] data, io.deephaven.shadow.core.com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ClientId
    parseFrom(io.deephaven.shadow.core.com.google.protobuf.ByteString data)
     
    static ClientId
    parseFrom(io.deephaven.shadow.core.com.google.protobuf.ByteString data, io.deephaven.shadow.core.com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ClientId
    parseFrom(io.deephaven.shadow.core.com.google.protobuf.CodedInputStream input)
     
    static ClientId
    parseFrom(io.deephaven.shadow.core.com.google.protobuf.CodedInputStream input, io.deephaven.shadow.core.com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ClientId
    parseFrom(InputStream input)
     
    static ClientId
    parseFrom(InputStream input, io.deephaven.shadow.core.com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ClientId
    parseFrom(ByteBuffer data)
     
    static ClientId
    parseFrom(ByteBuffer data, io.deephaven.shadow.core.com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static io.deephaven.shadow.core.com.google.protobuf.Parser<ClientId>
    parser()
     
    ClientId.Builder
    toBuilder()
     
    void
    writeTo(io.deephaven.shadow.core.com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class io.deephaven.shadow.core.com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class io.deephaven.shadow.core.com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

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

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

    toByteArray, toByteString, writeDelimitedTo, writeTo

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

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

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final io.deephaven.shadow.core.com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3

    • getName

      public 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;
      Specified by:
      getName in interface ClientIdOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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;
      Specified by:
      getNameBytes in interface ClientIdOrBuilder
      Returns:
      The bytes for name.

    • getUuid

      public 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;
      Specified by:
      getUuid in interface ClientIdOrBuilder
      Returns:
      The uuid.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface io.deephaven.shadow.core.com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(io.deephaven.shadow.core.com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface io.deephaven.shadow.core.com.google.protobuf.MessageLite
      Overrides:
      writeTo in class io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface io.deephaven.shadow.core.com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface io.deephaven.shadow.core.com.google.protobuf.Message
      Overrides:
      equals in class io.deephaven.shadow.core.com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface io.deephaven.shadow.core.com.google.protobuf.Message
      Overrides:
      hashCode in class io.deephaven.shadow.core.com.google.protobuf.AbstractMessage

    • parseFrom

      public static ClientId parseFrom(ByteBuffer data) throws io.deephaven.shadow.core.com.google.protobuf.InvalidProtocolBufferException
      Throws:
      io.deephaven.shadow.core.com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ClientId parseFrom(ByteBuffer data, io.deephaven.shadow.core.com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws io.deephaven.shadow.core.com.google.protobuf.InvalidProtocolBufferException
      Throws:
      io.deephaven.shadow.core.com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ClientId parseFrom(io.deephaven.shadow.core.com.google.protobuf.ByteString data) throws io.deephaven.shadow.core.com.google.protobuf.InvalidProtocolBufferException
      Throws:
      io.deephaven.shadow.core.com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ClientId parseFrom(io.deephaven.shadow.core.com.google.protobuf.ByteString data, io.deephaven.shadow.core.com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws io.deephaven.shadow.core.com.google.protobuf.InvalidProtocolBufferException
      Throws:
      io.deephaven.shadow.core.com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ClientId parseFrom(byte[] data) throws io.deephaven.shadow.core.com.google.protobuf.InvalidProtocolBufferException
      Throws:
      io.deephaven.shadow.core.com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ClientId parseFrom(byte[] data, io.deephaven.shadow.core.com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws io.deephaven.shadow.core.com.google.protobuf.InvalidProtocolBufferException
      Throws:
      io.deephaven.shadow.core.com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ClientId parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ClientId parseFrom(InputStream input, io.deephaven.shadow.core.com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ClientId parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ClientId parseDelimitedFrom(InputStream input, io.deephaven.shadow.core.com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ClientId parseFrom(io.deephaven.shadow.core.com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ClientId parseFrom(io.deephaven.shadow.core.com.google.protobuf.CodedInputStream input, io.deephaven.shadow.core.com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ClientId.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface io.deephaven.shadow.core.com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface io.deephaven.shadow.core.com.google.protobuf.MessageLite

    • newBuilder

      public static ClientId.Builder newBuilder()

    • newBuilder

      public static ClientId.Builder newBuilder(ClientId prototype)

    • toBuilder

      public ClientId.Builder toBuilder()
      Specified by:
      toBuilder in interface io.deephaven.shadow.core.com.google.protobuf.Message
      Specified by:
      toBuilder in interface io.deephaven.shadow.core.com.google.protobuf.MessageLite

    • newBuilderForType

      protected ClientId.Builder newBuilderForType(io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static ClientId getDefaultInstance()

    • parser

      public static io.deephaven.shadow.core.com.google.protobuf.Parser<ClientId> parser()

    • getParserForType

      public io.deephaven.shadow.core.com.google.protobuf.Parser<ClientId> getParserForType()
      Specified by:
      getParserForType in interface io.deephaven.shadow.core.com.google.protobuf.Message
      Specified by:
      getParserForType in interface io.deephaven.shadow.core.com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public ClientId getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface io.deephaven.shadow.core.com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface io.deephaven.shadow.core.com.google.protobuf.MessageOrBuilder