Package io.deephaven.proto.auth

Class AuthenticationResult

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.AuthenticationResult
All Implemented Interfaces:
AuthenticationResultOrBuilder, 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 AuthenticationResult extends io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3 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 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
    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 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)
     
    boolean
    getAuthenticated()
    true if authentication was successful.
    io.deephaven.shadow.core.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 io.deephaven.shadow.core.com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    io.deephaven.shadow.core.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 io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static AuthenticationResult.Builder
    newBuilder()
     
    static AuthenticationResult.Builder
    newBuilder(AuthenticationResult prototype)
     
    AuthenticationResult.Builder
    newBuilderForType()
     
    protected AuthenticationResult.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 AuthenticationResult
    parseDelimitedFrom(InputStream input)
     
    static AuthenticationResult
    parseDelimitedFrom(InputStream input, io.deephaven.shadow.core.com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AuthenticationResult
    parseFrom(byte[] data)
     
    static AuthenticationResult
    parseFrom(byte[] data, io.deephaven.shadow.core.com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AuthenticationResult
    parseFrom(io.deephaven.shadow.core.com.google.protobuf.ByteString data)
     
    static AuthenticationResult
    parseFrom(io.deephaven.shadow.core.com.google.protobuf.ByteString data, io.deephaven.shadow.core.com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AuthenticationResult
    parseFrom(io.deephaven.shadow.core.com.google.protobuf.CodedInputStream input)
     
    static AuthenticationResult
    parseFrom(io.deephaven.shadow.core.com.google.protobuf.CodedInputStream input, io.deephaven.shadow.core.com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AuthenticationResult
    parseFrom(InputStream input)
     
    static AuthenticationResult
    parseFrom(InputStream input, io.deephaven.shadow.core.com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AuthenticationResult
    parseFrom(ByteBuffer data)
     
    static AuthenticationResult
    parseFrom(ByteBuffer data, io.deephaven.shadow.core.com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static io.deephaven.shadow.core.com.google.protobuf.Parser<AuthenticationResult>
    parser()
     
    AuthenticationResult.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

    • 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

    • 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

    • getAuthenticated

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

    • getCookie

      public io.deephaven.shadow.core.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 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 AuthenticationResult parseFrom(ByteBuffer data) throws io.deephaven.shadow.core.com.google.protobuf.InvalidProtocolBufferException
      Throws:
      io.deephaven.shadow.core.com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AuthenticationResult 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 AuthenticationResult 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 AuthenticationResult 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 AuthenticationResult parseFrom(byte[] data) throws io.deephaven.shadow.core.com.google.protobuf.InvalidProtocolBufferException
      Throws:
      io.deephaven.shadow.core.com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AuthenticationResult 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 AuthenticationResult parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AuthenticationResult parseFrom(InputStream input, io.deephaven.shadow.core.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, io.deephaven.shadow.core.com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseFrom

      public static AuthenticationResult 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 AuthenticationResult.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 AuthenticationResult.Builder newBuilder()

    • newBuilder

      public static AuthenticationResult.Builder newBuilder(AuthenticationResult prototype)

    • toBuilder

      public AuthenticationResult.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 AuthenticationResult.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 AuthenticationResult getDefaultInstance()

    • parser

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

    • getParserForType

      public io.deephaven.shadow.core.com.google.protobuf.Parser<AuthenticationResult> 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 AuthenticationResult 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