Package io.envoyproxy.envoy.extensions.filters.http.jwt_authn.v3

Class JwksAsyncFetch

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.http.jwt_authn.v3.JwksAsyncFetch
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, JwksAsyncFetchOrBuilder, Serializable
public final class JwksAsyncFetch extends com.google.protobuf.GeneratedMessageV3 implements JwksAsyncFetchOrBuilder
 Fetch Jwks asynchronously in the main thread when the filter config is parsed.
 The listener is activated only after the Jwks is fetched.
 When the Jwks is expired in the cache, it is fetched again in the main thread.
 The fetched Jwks from the main thread can be used by all worker threads.
Protobuf type envoy.extensions.filters.http.jwt_authn.v3.JwksAsyncFetch
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    JwksAsyncFetch.Builder
    Fetch Jwks asynchronously in the main thread when the filter config is parsed.

    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.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    FAILED_REFETCH_DURATION_FIELD_NUMBER
     
    static final int
    FAST_LISTENER_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

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static JwksAsyncFetch
    getDefaultInstance()
     
    JwksAsyncFetch
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Duration
    getFailedRefetchDuration()
    The duration to refetch after a failed fetch.
    com.google.protobuf.DurationOrBuilder
    getFailedRefetchDurationOrBuilder()
    The duration to refetch after a failed fetch.
    boolean
    getFastListener()
    If false, the listener is activated after the initial fetch is completed.
    com.google.protobuf.Parser<JwksAsyncFetch>
    getParserForType()
     
    int
    getSerializedSize()
     
    boolean
    hasFailedRefetchDuration()
    The duration to refetch after a failed fetch.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static JwksAsyncFetch.Builder
    newBuilder()
     
    static JwksAsyncFetch.Builder
    newBuilder(JwksAsyncFetch prototype)
     
    JwksAsyncFetch.Builder
    newBuilderForType()
     
    protected JwksAsyncFetch.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static JwksAsyncFetch
    parseDelimitedFrom(InputStream input)
     
    static JwksAsyncFetch
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static JwksAsyncFetch
    parseFrom(byte[] data)
     
    static JwksAsyncFetch
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static JwksAsyncFetch
    parseFrom(com.google.protobuf.ByteString data)
     
    static JwksAsyncFetch
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static JwksAsyncFetch
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static JwksAsyncFetch
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static JwksAsyncFetch
    parseFrom(InputStream input)
     
    static JwksAsyncFetch
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static JwksAsyncFetch
    parseFrom(ByteBuffer data)
     
    static JwksAsyncFetch
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<JwksAsyncFetch>
    parser()
     
    JwksAsyncFetch.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class 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 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, getUnknownFields, hasField, hasOneof

  • Field Details

    • FAST_LISTENER_FIELD_NUMBER

      public static final int FAST_LISTENER_FIELD_NUMBER
      See Also:

    • FAILED_REFETCH_DURATION_FIELD_NUMBER

      public static final int FAILED_REFETCH_DURATION_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected 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()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getFastListener

      public boolean getFastListener()
       If false, the listener is activated after the initial fetch is completed.
 The initial fetch result can be either successful or failed.
 If true, it is activated without waiting for the initial fetch to complete.
 Default is false.
      bool fast_listener = 1;
      Specified by:
      getFastListener in interface JwksAsyncFetchOrBuilder
      Returns:
      The fastListener.

    • hasFailedRefetchDuration

      public boolean hasFailedRefetchDuration()
       The duration to refetch after a failed fetch. If not specified, default is 1 second.
      .google.protobuf.Duration failed_refetch_duration = 2;
      Specified by:
      hasFailedRefetchDuration in interface JwksAsyncFetchOrBuilder
      Returns:
      Whether the failedRefetchDuration field is set.

    • getFailedRefetchDuration

      public com.google.protobuf.Duration getFailedRefetchDuration()
       The duration to refetch after a failed fetch. If not specified, default is 1 second.
      .google.protobuf.Duration failed_refetch_duration = 2;
      Specified by:
      getFailedRefetchDuration in interface JwksAsyncFetchOrBuilder
      Returns:
      The failedRefetchDuration.

    • getFailedRefetchDurationOrBuilder

      public com.google.protobuf.DurationOrBuilder getFailedRefetchDurationOrBuilder()
       The duration to refetch after a failed fetch. If not specified, default is 1 second.
      .google.protobuf.Duration failed_refetch_duration = 2;
      Specified by:
      getFailedRefetchDurationOrBuilder in interface JwksAsyncFetchOrBuilder

    • 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      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(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 JwksAsyncFetch parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static JwksAsyncFetch.Builder newBuilder()

    • newBuilder

      public static JwksAsyncFetch.Builder newBuilder(JwksAsyncFetch prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static JwksAsyncFetch getDefaultInstance()

    • parser

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

    • getParserForType

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