Package io.envoyproxy.envoy.config.filter.http.jwt_authn.v2alpha

Class RemoteJwks

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RemoteJwksOrBuilder, java.io.Serializable
    public final class RemoteJwks
extends com.google.protobuf.GeneratedMessageV3
implements RemoteJwksOrBuilder
     This message specifies how to fetch JWKS from remote and how to cache it.
    Protobuf type envoy.config.filter.http.jwt_authn.v2alpha.RemoteJwks
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  RemoteJwks.Builder
      This message specifies how to fetch JWKS from remote and how to cache it.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • 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 CACHE_DURATION_FIELD_NUMBER  
      static int HTTP_URI_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        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)  
      com.google.protobuf.Duration getCacheDuration()
      Duration after which the cached JWKS should be expired.
      com.google.protobuf.DurationOrBuilder getCacheDurationOrBuilder()
      Duration after which the cached JWKS should be expired.
      static RemoteJwks getDefaultInstance()  
      RemoteJwks getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      HttpUri getHttpUri()
      The HTTP URI to fetch the JWKS.
      HttpUriOrBuilder getHttpUriOrBuilder()
      The HTTP URI to fetch the JWKS.
      com.google.protobuf.Parser<RemoteJwks> getParserForType()  
      int getSerializedSize()  
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      boolean hasCacheDuration()
      Duration after which the cached JWKS should be expired.
      int hashCode()  
      boolean hasHttpUri()
      The HTTP URI to fetch the JWKS.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static RemoteJwks.Builder newBuilder()  
      static RemoteJwks.Builder newBuilder​(RemoteJwks prototype)  
      RemoteJwks.Builder newBuilderForType()  
      protected RemoteJwks.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static RemoteJwks parseDelimitedFrom​(java.io.InputStream input)  
      static RemoteJwks parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static RemoteJwks parseFrom​(byte[] data)  
      static RemoteJwks parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static RemoteJwks parseFrom​(com.google.protobuf.ByteString data)  
      static RemoteJwks parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static RemoteJwks parseFrom​(com.google.protobuf.CodedInputStream input)  
      static RemoteJwks parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static RemoteJwks parseFrom​(java.io.InputStream input)  
      static RemoteJwks parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static RemoteJwks parseFrom​(java.nio.ByteBuffer data)  
      static RemoteJwks parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<RemoteJwks> parser()  
      RemoteJwks.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, 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 com.google.protobuf.AbstractMessage

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

      • Methods inherited from class 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 com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Field Detail

      • CACHE_DURATION_FIELD_NUMBER

        public static final int CACHE_DURATION_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

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

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • hasHttpUri

        public boolean hasHttpUri()
         The HTTP URI to fetch the JWKS. For example:
 .. code-block:: yaml
    http_uri:
      uri: https://www.googleapis.com/oauth2/v1/certs
      cluster: jwt.www.googleapis.com|443
        .envoy.api.v2.core.HttpUri http_uri = 1;
        Specified by:
        hasHttpUri in interface RemoteJwksOrBuilder
        Returns:
        Whether the httpUri field is set.

      • getHttpUri

        public HttpUri getHttpUri()
         The HTTP URI to fetch the JWKS. For example:
 .. code-block:: yaml
    http_uri:
      uri: https://www.googleapis.com/oauth2/v1/certs
      cluster: jwt.www.googleapis.com|443
        .envoy.api.v2.core.HttpUri http_uri = 1;
        Specified by:
        getHttpUri in interface RemoteJwksOrBuilder
        Returns:
        The httpUri.

      • getHttpUriOrBuilder

        public HttpUriOrBuilder getHttpUriOrBuilder()
         The HTTP URI to fetch the JWKS. For example:
 .. code-block:: yaml
    http_uri:
      uri: https://www.googleapis.com/oauth2/v1/certs
      cluster: jwt.www.googleapis.com|443
        .envoy.api.v2.core.HttpUri http_uri = 1;
        Specified by:
        getHttpUriOrBuilder in interface RemoteJwksOrBuilder

      • hasCacheDuration

        public boolean hasCacheDuration()
         Duration after which the cached JWKS should be expired. If not specified, default cache
 duration is 5 minutes.
        .google.protobuf.Duration cache_duration = 2;
        Specified by:
        hasCacheDuration in interface RemoteJwksOrBuilder
        Returns:
        Whether the cacheDuration field is set.

      • getCacheDuration

        public com.google.protobuf.Duration getCacheDuration()
         Duration after which the cached JWKS should be expired. If not specified, default cache
 duration is 5 minutes.
        .google.protobuf.Duration cache_duration = 2;
        Specified by:
        getCacheDuration in interface RemoteJwksOrBuilder
        Returns:
        The cacheDuration.

      • getCacheDurationOrBuilder

        public com.google.protobuf.DurationOrBuilder getCacheDurationOrBuilder()
         Duration after which the cached JWKS should be expired. If not specified, default cache
 duration is 5 minutes.
        .google.protobuf.Duration cache_duration = 2;
        Specified by:
        getCacheDurationOrBuilder in interface RemoteJwksOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class 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.GeneratedMessageV3
        Throws:
        java.io.IOException

      • getSerializedSize

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

      • 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 RemoteJwks parseFrom​(java.nio.ByteBuffer data)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static RemoteJwks getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<RemoteJwks> 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.GeneratedMessageV3

      • getDefaultInstanceForType

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