Package io.deephaven.proto.auth

Class AuthenticationResult

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.deephaven.proto.auth.AuthenticationResult
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, AuthenticationResultOrBuilder, Serializable
@Generated public final class AuthenticationResult extends com.google.protobuf.GeneratedMessage implements AuthenticationResultOrBuilder
 Servers respond to Authenticate* requests with an opaque cookie for the (client_id, user, effectiveUser) combination
 granted in the request.  clients remember and use the same cookie in subsequent RPCs to the server that intend to use
 those credentials. This cookie should be refreshed prior to the deadline, which is represented as milliseconds since
 epoch.  Clients are encouraged to refresh considerably in advance of the deadline, as to be able to continue
 operating under network delays.  The expected pattern is for clients to refresh half-way throught their
 available period from the last refresh to the deadline.
Protobuf type io.deephaven.proto.auth.AuthenticationResult
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    AuthenticationResult.Builder
    Servers respond to Authenticate* requests with an opaque cookie for the (client_id, user, effectiveUser) combination granted in the request.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    AUTHENTICATED_FIELD_NUMBER
     
    static final int
    COOKIE_DEADLINE_TIME_MILLIS_FIELD_NUMBER
     
    static final int
    COOKIE_FIELD_NUMBER
     
    static final int
    USERCONTEXT_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    boolean
    getAuthenticated()
    true if authentication was successful.
    com.google.protobuf.ByteString
    getCookie()
    the cookie that the client should remember and refresh before its deadline to remain authenticated.
    long
    getCookieDeadlineTimeMillis()
    the absolute time in milliseconds from the epoch when the cookie will expire.
    static AuthenticationResult
    getDefaultInstance()
     
    AuthenticationResult
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<AuthenticationResult>
    getParserForType()
     
    int
    getSerializedSize()
     
    UserContext
    getUserContext()
    the user context actually authenticated; if there was one in the request should match it.
    UserContextOrBuilder
    getUserContextOrBuilder()
    the user context actually authenticated; if there was one in the request should match it.
    int
    hashCode()
     
    boolean
    hasUserContext()
    the user context actually authenticated; if there was one in the request should match it.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static AuthenticationResult.Builder
    newBuilder()
     
    static AuthenticationResult.Builder
    newBuilder(AuthenticationResult prototype)
     
    AuthenticationResult.Builder
    newBuilderForType()
     
    protected AuthenticationResult.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static AuthenticationResult
    parseDelimitedFrom(InputStream input)
     
    static AuthenticationResult
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AuthenticationResult
    parseFrom(byte[] data)
     
    static AuthenticationResult
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AuthenticationResult
    parseFrom(com.google.protobuf.ByteString data)
     
    static AuthenticationResult
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AuthenticationResult
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static AuthenticationResult
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AuthenticationResult
    parseFrom(InputStream input)
     
    static AuthenticationResult
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AuthenticationResult
    parseFrom(ByteBuffer data)
     
    static AuthenticationResult
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<AuthenticationResult>
    parser()
     
    AuthenticationResult.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    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, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    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 com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • AUTHENTICATED_FIELD_NUMBER

      public static final int AUTHENTICATED_FIELD_NUMBER
      See Also:

    • USERCONTEXT_FIELD_NUMBER

      public static final int USERCONTEXT_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getAuthenticated

      public boolean getAuthenticated()
       true if authentication was successful.
      bool authenticated = 1;
      Specified by:
      getAuthenticated in interface AuthenticationResultOrBuilder
      Returns:
      The authenticated.

    • getCookie

      public com.google.protobuf.ByteString getCookie()
       the cookie that the client should remember and refresh before its deadline to remain authenticated.
      bytes cookie = 2;
      Specified by:
      getCookie in interface AuthenticationResultOrBuilder
      Returns:
      The cookie.

    • getCookieDeadlineTimeMillis

      public long getCookieDeadlineTimeMillis()
       the absolute time in milliseconds from the epoch when the cookie will expire.
      sfixed64 cookie_deadline_time_millis = 3;
      Specified by:
      getCookieDeadlineTimeMillis in interface AuthenticationResultOrBuilder
      Returns:
      The cookieDeadlineTimeMillis.

    • hasUserContext

      public boolean hasUserContext()
       the user context actually authenticated; if there was one in the request should match it.
      .io.deephaven.proto.auth.UserContext userContext = 4;
      Specified by:
      hasUserContext in interface AuthenticationResultOrBuilder
      Returns:
      Whether the userContext field is set.

    • getUserContext

      public UserContext getUserContext()
       the user context actually authenticated; if there was one in the request should match it.
      .io.deephaven.proto.auth.UserContext userContext = 4;
      Specified by:
      getUserContext in interface AuthenticationResultOrBuilder
      Returns:
      The userContext.

    • getUserContextOrBuilder

      public UserContextOrBuilder getUserContextOrBuilder()
       the user context actually authenticated; if there was one in the request should match it.
      .io.deephaven.proto.auth.UserContext userContext = 4;
      Specified by:
      getUserContextOrBuilder in interface AuthenticationResultOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

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

    • hashCode

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

    • parseFrom

      public static AuthenticationResult parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AuthenticationResult parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AuthenticationResult parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AuthenticationResult parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AuthenticationResult parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AuthenticationResult parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static AuthenticationResult parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseDelimitedFrom

      public static AuthenticationResult parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AuthenticationResult parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AuthenticationResult parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public AuthenticationResult.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static AuthenticationResult.Builder newBuilder()

    • newBuilder

      public static AuthenticationResult.Builder newBuilder(AuthenticationResult prototype)

    • toBuilder

      public AuthenticationResult.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected AuthenticationResult.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static AuthenticationResult getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<AuthenticationResult> parser()

    • getParserForType

      public com.google.protobuf.Parser<AuthenticationResult> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public AuthenticationResult getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder