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

Class FilterStateRule

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, FilterStateRuleOrBuilder, Serializable
    public final class FilterStateRule
extends com.google.protobuf.GeneratedMessageV3
implements FilterStateRuleOrBuilder
     This message specifies Jwt requirements based on stream_info.filterState.
 This FilterState should use ``Router::StringAccessor`` object to set a string value.
 Other HTTP filters can use it to specify Jwt requirements dynamically.
 Example:
 .. code-block:: yaml
    name: jwt_selector
    requires:
      issuer_1:
        provider_name: issuer1
      issuer_2:
        provider_name: issuer2
 If a filter set "jwt_selector" with "issuer_1" to FilterState for a request,
 jwt_authn filter will use JwtRequirement{"provider_name": "issuer1"} to verify.
    Protobuf type envoy.extensions.filters.http.jwt_authn.v3.FilterStateRule
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  FilterStateRule.Builder
      This message specifies Jwt requirements based on stream_info.filterState.

      • 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 NAME_FIELD_NUMBER  
      static int REQUIRES_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 Detail

      • newInstance

        protected 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()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

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

      • getName

        public String getName()
         The filter state name to retrieve the ``Router::StringAccessor`` object.
        string name = 1 [(.validate.rules) = { ... }
        Specified by:
        getName in interface FilterStateRuleOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The filter state name to retrieve the ``Router::StringAccessor`` object.
        string name = 1 [(.validate.rules) = { ... }
        Specified by:
        getNameBytes in interface FilterStateRuleOrBuilder
        Returns:
        The bytes for name.

      • getRequiresCount

        public int getRequiresCount()
        Description copied from interface: FilterStateRuleOrBuilder
         A map of string keys to requirements. The string key is the string value
 in the FilterState with the name specified in the ``name`` field above.
        map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtRequirement> requires = 3;
        Specified by:
        getRequiresCount in interface FilterStateRuleOrBuilder

      • containsRequires

        public boolean containsRequires​(String key)
         A map of string keys to requirements. The string key is the string value
 in the FilterState with the name specified in the ``name`` field above.
        map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtRequirement> requires = 3;
        Specified by:
        containsRequires in interface FilterStateRuleOrBuilder

      • getRequiresMap

        public Map<String,​JwtRequirement> getRequiresMap()
         A map of string keys to requirements. The string key is the string value
 in the FilterState with the name specified in the ``name`` field above.
        map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtRequirement> requires = 3;
        Specified by:
        getRequiresMap in interface FilterStateRuleOrBuilder

      • getRequiresOrDefault

        public JwtRequirement getRequiresOrDefault​(String key,
                                           JwtRequirement defaultValue)
         A map of string keys to requirements. The string key is the string value
 in the FilterState with the name specified in the ``name`` field above.
        map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtRequirement> requires = 3;
        Specified by:
        getRequiresOrDefault in interface FilterStateRuleOrBuilder

      • getRequiresOrThrow

        public JwtRequirement getRequiresOrThrow​(String key)
         A map of string keys to requirements. The string key is the string value
 in the FilterState with the name specified in the ``name`` field above.
        map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtRequirement> requires = 3;
        Specified by:
        getRequiresOrThrow in interface FilterStateRuleOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • parser

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

      • getParserForType

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