Class JwtLocation

  • All Implemented Interfaces:
    JwtLocationOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable

    public final class JwtLocation
    extends com.google.protobuf.GeneratedMessageV3
    implements JwtLocationOrBuilder
     Specifies a location to extract JWT from an API request.
     
    Protobuf type google.api.JwtLocation
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  JwtLocation.Builder
      Specifies a location to extract JWT from an API request.
      static class  JwtLocation.InCase  
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

        com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionSerializer, com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionWriter
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

        com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,​T extends java.lang.Object>
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int COOKIE_FIELD_NUMBER  
      static int HEADER_FIELD_NUMBER  
      static int QUERY_FIELD_NUMBER  
      static int VALUE_PREFIX_FIELD_NUMBER  
      • Fields inherited from class com.google.protobuf.GeneratedMessage

        alwaysUseFieldBuilders, unknownFields
      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize
      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getCookie()
      Specifies cookie name to extract JWT token.
      com.google.protobuf.ByteString getCookieBytes()
      Specifies cookie name to extract JWT token.
      static JwtLocation getDefaultInstance()  
      JwtLocation getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      java.lang.String getHeader()
      Specifies HTTP header name to extract JWT token.
      com.google.protobuf.ByteString getHeaderBytes()
      Specifies HTTP header name to extract JWT token.
      JwtLocation.InCase getInCase()  
      com.google.protobuf.Parser<JwtLocation> getParserForType()  
      java.lang.String getQuery()
      Specifies URL query parameter name to extract JWT token.
      com.google.protobuf.ByteString getQueryBytes()
      Specifies URL query parameter name to extract JWT token.
      int getSerializedSize()  
      java.lang.String getValuePrefix()
      The value prefix.
      com.google.protobuf.ByteString getValuePrefixBytes()
      The value prefix.
      boolean hasCookie()
      Specifies cookie name to extract JWT token.
      int hashCode()  
      boolean hasHeader()
      Specifies HTTP header name to extract JWT token.
      boolean hasQuery()
      Specifies URL query parameter name to extract JWT token.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static JwtLocation.Builder newBuilder()  
      static JwtLocation.Builder newBuilder​(JwtLocation prototype)  
      JwtLocation.Builder newBuilderForType()  
      protected JwtLocation.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static JwtLocation parseDelimitedFrom​(java.io.InputStream input)  
      static JwtLocation parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static JwtLocation parseFrom​(byte[] data)  
      static JwtLocation parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static JwtLocation parseFrom​(com.google.protobuf.ByteString data)  
      static JwtLocation parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static JwtLocation parseFrom​(com.google.protobuf.CodedInputStream input)  
      static JwtLocation parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static JwtLocation parseFrom​(java.io.InputStream input)  
      static JwtLocation parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static JwtLocation parseFrom​(java.nio.ByteBuffer data)  
      static JwtLocation parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<JwtLocation> parser()  
      JwtLocation.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  
      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType
      • Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

        extensionsAreInitialized, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasField, newExtensionSerializer, newExtensionWriter, newMessageSetExtensionSerializer, newMessageSetExtensionWriter
      • Methods inherited from class com.google.protobuf.GeneratedMessage

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getDescriptorForType, getOneofFieldDescriptor, getUnknownFields, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, 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
    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Overrides:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • hasHeader

        public boolean hasHeader()
         Specifies HTTP header name to extract JWT token.
         
        string header = 1;
        Specified by:
        hasHeader in interface JwtLocationOrBuilder
        Returns:
        Whether the header field is set.
      • getHeader

        public java.lang.String getHeader()
         Specifies HTTP header name to extract JWT token.
         
        string header = 1;
        Specified by:
        getHeader in interface JwtLocationOrBuilder
        Returns:
        The header.
      • getHeaderBytes

        public com.google.protobuf.ByteString getHeaderBytes()
         Specifies HTTP header name to extract JWT token.
         
        string header = 1;
        Specified by:
        getHeaderBytes in interface JwtLocationOrBuilder
        Returns:
        The bytes for header.
      • hasQuery

        public boolean hasQuery()
         Specifies URL query parameter name to extract JWT token.
         
        string query = 2;
        Specified by:
        hasQuery in interface JwtLocationOrBuilder
        Returns:
        Whether the query field is set.
      • getQuery

        public java.lang.String getQuery()
         Specifies URL query parameter name to extract JWT token.
         
        string query = 2;
        Specified by:
        getQuery in interface JwtLocationOrBuilder
        Returns:
        The query.
      • getQueryBytes

        public com.google.protobuf.ByteString getQueryBytes()
         Specifies URL query parameter name to extract JWT token.
         
        string query = 2;
        Specified by:
        getQueryBytes in interface JwtLocationOrBuilder
        Returns:
        The bytes for query.
      • hasCookie

        public boolean hasCookie()
         Specifies cookie name to extract JWT token.
         
        string cookie = 4;
        Specified by:
        hasCookie in interface JwtLocationOrBuilder
        Returns:
        Whether the cookie field is set.
      • getCookie

        public java.lang.String getCookie()
         Specifies cookie name to extract JWT token.
         
        string cookie = 4;
        Specified by:
        getCookie in interface JwtLocationOrBuilder
        Returns:
        The cookie.
      • getCookieBytes

        public com.google.protobuf.ByteString getCookieBytes()
         Specifies cookie name to extract JWT token.
         
        string cookie = 4;
        Specified by:
        getCookieBytes in interface JwtLocationOrBuilder
        Returns:
        The bytes for cookie.
      • getValuePrefix

        public java.lang.String getValuePrefix()
         The value prefix. The value format is "value_prefix{token}"
         Only applies to "in" header type. Must be empty for "in" query type.
         If not empty, the header value has to match (case sensitive) this prefix.
         If not matched, JWT will not be extracted. If matched, JWT will be
         extracted after the prefix is removed.
        
         For example, for "Authorization: Bearer {JWT}",
         value_prefix="Bearer " with a space at the end.
         
        string value_prefix = 3;
        Specified by:
        getValuePrefix in interface JwtLocationOrBuilder
        Returns:
        The valuePrefix.
      • getValuePrefixBytes

        public com.google.protobuf.ByteString getValuePrefixBytes()
         The value prefix. The value format is "value_prefix{token}"
         Only applies to "in" header type. Must be empty for "in" query type.
         If not empty, the header value has to match (case sensitive) this prefix.
         If not matched, JWT will not be extracted. If matched, JWT will be
         extracted after the prefix is removed.
        
         For example, for "Authorization: Bearer {JWT}",
         value_prefix="Bearer " with a space at the end.
         
        string value_prefix = 3;
        Specified by:
        getValuePrefixBytes in interface JwtLocationOrBuilder
        Returns:
        The bytes for valuePrefix.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage.ExtendableMessage<com.google.protobuf.GeneratedMessageV3>
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.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​(java.lang.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 JwtLocation parseFrom​(java.nio.ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static JwtLocation parseFrom​(java.nio.ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static JwtLocation parseFrom​(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

        public static JwtLocation parseFrom​(java.io.InputStream input)
                                     throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static JwtLocation parseFrom​(java.io.InputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static JwtLocation parseDelimitedFrom​(java.io.InputStream input)
                                              throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static JwtLocation parseDelimitedFrom​(java.io.InputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static JwtLocation parseFrom​(com.google.protobuf.CodedInputStream input)
                                     throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static JwtLocation parseFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws java.io.IOException
        Throws:
        java.io.IOException
      • newBuilderForType

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

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

        protected JwtLocation.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static JwtLocation getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<JwtLocation> parser()
      • getParserForType

        public com.google.protobuf.Parser<JwtLocation> 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 JwtLocation getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder