Package io.envoyproxy.envoy.extensions.transport_sockets.tls.v3

Class SubjectAltNameMatcher.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SubjectAltNameMatcherOrBuilder, java.lang.Cloneable
    Enclosing class:
    SubjectAltNameMatcher
    public static final class SubjectAltNameMatcher.Builder
extends com.google.protobuf.GeneratedMessage.Builder<SubjectAltNameMatcher.Builder>
implements SubjectAltNameMatcherOrBuilder
     Matcher for subject alternative names, to match both type and value of the SAN.
    Protobuf type envoy.extensions.transport_sockets.tls.v3.SubjectAltNameMatcher

    • Constructor Detail

      • Builder

        private Builder()

      • Builder

        private Builder​(com.google.protobuf.AbstractMessage.BuilderParent parent)

    • Method Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<SubjectAltNameMatcher.Builder>

      • maybeForceBuilderInitialization

        private void maybeForceBuilderInitialization()

      • clear

        public SubjectAltNameMatcher.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessage.Builder<SubjectAltNameMatcher.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<SubjectAltNameMatcher.Builder>

      • getDefaultInstanceForType

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

      • build

        public SubjectAltNameMatcher build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public SubjectAltNameMatcher buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage.Builder<SubjectAltNameMatcher.Builder>

      • mergeFrom

        public SubjectAltNameMatcher.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SubjectAltNameMatcher.Builder>
        Throws:
        java.io.IOException

      • getSanTypeValue

        public int getSanTypeValue()
         Specification of type of SAN. Note that the default enum value is an invalid choice.
        .envoy.extensions.transport_sockets.tls.v3.SubjectAltNameMatcher.SanType san_type = 1 [(.validate.rules) = { ... }
        Specified by:
        getSanTypeValue in interface SubjectAltNameMatcherOrBuilder
        Returns:
        The enum numeric value on the wire for sanType.

      • setSanTypeValue

        public SubjectAltNameMatcher.Builder setSanTypeValue​(int value)
         Specification of type of SAN. Note that the default enum value is an invalid choice.
        .envoy.extensions.transport_sockets.tls.v3.SubjectAltNameMatcher.SanType san_type = 1 [(.validate.rules) = { ... }
        Parameters:
        value - The enum numeric value on the wire for sanType to set.
        Returns:
        This builder for chaining.

      • getSanType

        public SubjectAltNameMatcher.SanType getSanType()
         Specification of type of SAN. Note that the default enum value is an invalid choice.
        .envoy.extensions.transport_sockets.tls.v3.SubjectAltNameMatcher.SanType san_type = 1 [(.validate.rules) = { ... }
        Specified by:
        getSanType in interface SubjectAltNameMatcherOrBuilder
        Returns:
        The sanType.

      • setSanType

        public SubjectAltNameMatcher.Builder setSanType​(SubjectAltNameMatcher.SanType value)
         Specification of type of SAN. Note that the default enum value is an invalid choice.
        .envoy.extensions.transport_sockets.tls.v3.SubjectAltNameMatcher.SanType san_type = 1 [(.validate.rules) = { ... }
        Parameters:
        value - The sanType to set.
        Returns:
        This builder for chaining.

      • clearSanType

        public SubjectAltNameMatcher.Builder clearSanType()
         Specification of type of SAN. Note that the default enum value is an invalid choice.
        .envoy.extensions.transport_sockets.tls.v3.SubjectAltNameMatcher.SanType san_type = 1 [(.validate.rules) = { ... }
        Returns:
        This builder for chaining.

      • hasMatcher

        public boolean hasMatcher()
         Matcher for SAN value.

 The string matching for OTHER_NAME SAN values depends on their ASN.1 type:

 * OBJECT: Validated against its dotted numeric notation (e.g., "1.2.3.4")
 * BOOLEAN: Validated against strings "true" or "false"
 * INTEGER/ENUMERATED: Validated against a string containing the integer value
 * NULL: Validated against an empty string
 * Other types: Validated directly against the string value
        .envoy.type.matcher.v3.StringMatcher matcher = 2 [(.validate.rules) = { ... }
        Specified by:
        hasMatcher in interface SubjectAltNameMatcherOrBuilder
        Returns:
        Whether the matcher field is set.

      • getMatcher

        public StringMatcher getMatcher()
         Matcher for SAN value.

 The string matching for OTHER_NAME SAN values depends on their ASN.1 type:

 * OBJECT: Validated against its dotted numeric notation (e.g., "1.2.3.4")
 * BOOLEAN: Validated against strings "true" or "false"
 * INTEGER/ENUMERATED: Validated against a string containing the integer value
 * NULL: Validated against an empty string
 * Other types: Validated directly against the string value
        .envoy.type.matcher.v3.StringMatcher matcher = 2 [(.validate.rules) = { ... }
        Specified by:
        getMatcher in interface SubjectAltNameMatcherOrBuilder
        Returns:
        The matcher.

      • setMatcher

        public SubjectAltNameMatcher.Builder setMatcher​(StringMatcher value)
         Matcher for SAN value.

 The string matching for OTHER_NAME SAN values depends on their ASN.1 type:

 * OBJECT: Validated against its dotted numeric notation (e.g., "1.2.3.4")
 * BOOLEAN: Validated against strings "true" or "false"
 * INTEGER/ENUMERATED: Validated against a string containing the integer value
 * NULL: Validated against an empty string
 * Other types: Validated directly against the string value
        .envoy.type.matcher.v3.StringMatcher matcher = 2 [(.validate.rules) = { ... }

      • setMatcher

        public SubjectAltNameMatcher.Builder setMatcher​(StringMatcher.Builder builderForValue)
         Matcher for SAN value.

 The string matching for OTHER_NAME SAN values depends on their ASN.1 type:

 * OBJECT: Validated against its dotted numeric notation (e.g., "1.2.3.4")
 * BOOLEAN: Validated against strings "true" or "false"
 * INTEGER/ENUMERATED: Validated against a string containing the integer value
 * NULL: Validated against an empty string
 * Other types: Validated directly against the string value
        .envoy.type.matcher.v3.StringMatcher matcher = 2 [(.validate.rules) = { ... }

      • mergeMatcher

        public SubjectAltNameMatcher.Builder mergeMatcher​(StringMatcher value)
         Matcher for SAN value.

 The string matching for OTHER_NAME SAN values depends on their ASN.1 type:

 * OBJECT: Validated against its dotted numeric notation (e.g., "1.2.3.4")
 * BOOLEAN: Validated against strings "true" or "false"
 * INTEGER/ENUMERATED: Validated against a string containing the integer value
 * NULL: Validated against an empty string
 * Other types: Validated directly against the string value
        .envoy.type.matcher.v3.StringMatcher matcher = 2 [(.validate.rules) = { ... }

      • clearMatcher

        public SubjectAltNameMatcher.Builder clearMatcher()
         Matcher for SAN value.

 The string matching for OTHER_NAME SAN values depends on their ASN.1 type:

 * OBJECT: Validated against its dotted numeric notation (e.g., "1.2.3.4")
 * BOOLEAN: Validated against strings "true" or "false"
 * INTEGER/ENUMERATED: Validated against a string containing the integer value
 * NULL: Validated against an empty string
 * Other types: Validated directly against the string value
        .envoy.type.matcher.v3.StringMatcher matcher = 2 [(.validate.rules) = { ... }

      • getMatcherBuilder

        public StringMatcher.Builder getMatcherBuilder()
         Matcher for SAN value.

 The string matching for OTHER_NAME SAN values depends on their ASN.1 type:

 * OBJECT: Validated against its dotted numeric notation (e.g., "1.2.3.4")
 * BOOLEAN: Validated against strings "true" or "false"
 * INTEGER/ENUMERATED: Validated against a string containing the integer value
 * NULL: Validated against an empty string
 * Other types: Validated directly against the string value
        .envoy.type.matcher.v3.StringMatcher matcher = 2 [(.validate.rules) = { ... }

      • getMatcherOrBuilder

        public StringMatcherOrBuilder getMatcherOrBuilder()
         Matcher for SAN value.

 The string matching for OTHER_NAME SAN values depends on their ASN.1 type:

 * OBJECT: Validated against its dotted numeric notation (e.g., "1.2.3.4")
 * BOOLEAN: Validated against strings "true" or "false"
 * INTEGER/ENUMERATED: Validated against a string containing the integer value
 * NULL: Validated against an empty string
 * Other types: Validated directly against the string value
        .envoy.type.matcher.v3.StringMatcher matcher = 2 [(.validate.rules) = { ... }
        Specified by:
        getMatcherOrBuilder in interface SubjectAltNameMatcherOrBuilder

      • getMatcherFieldBuilder

        private com.google.protobuf.SingleFieldBuilder<StringMatcher,​StringMatcher.Builder,​StringMatcherOrBuilder> getMatcherFieldBuilder()
         Matcher for SAN value.

 The string matching for OTHER_NAME SAN values depends on their ASN.1 type:

 * OBJECT: Validated against its dotted numeric notation (e.g., "1.2.3.4")
 * BOOLEAN: Validated against strings "true" or "false"
 * INTEGER/ENUMERATED: Validated against a string containing the integer value
 * NULL: Validated against an empty string
 * Other types: Validated directly against the string value
        .envoy.type.matcher.v3.StringMatcher matcher = 2 [(.validate.rules) = { ... }

      • getOid

        public java.lang.String getOid()
         OID Value which is required if OTHER_NAME SAN type is used.
 For example, UPN OID is 1.3.6.1.4.1.311.20.2.3
 (Reference: http://oid-info.com/get/1.3.6.1.4.1.311.20.2.3).

 If set for SAN types other than OTHER_NAME, it will be ignored.
        string oid = 3;
        Specified by:
        getOid in interface SubjectAltNameMatcherOrBuilder
        Returns:
        The oid.

      • getOidBytes

        public com.google.protobuf.ByteString getOidBytes()
         OID Value which is required if OTHER_NAME SAN type is used.
 For example, UPN OID is 1.3.6.1.4.1.311.20.2.3
 (Reference: http://oid-info.com/get/1.3.6.1.4.1.311.20.2.3).

 If set for SAN types other than OTHER_NAME, it will be ignored.
        string oid = 3;
        Specified by:
        getOidBytes in interface SubjectAltNameMatcherOrBuilder
        Returns:
        The bytes for oid.

      • setOid

        public SubjectAltNameMatcher.Builder setOid​(java.lang.String value)
         OID Value which is required if OTHER_NAME SAN type is used.
 For example, UPN OID is 1.3.6.1.4.1.311.20.2.3
 (Reference: http://oid-info.com/get/1.3.6.1.4.1.311.20.2.3).

 If set for SAN types other than OTHER_NAME, it will be ignored.
        string oid = 3;
        Parameters:
        value - The oid to set.
        Returns:
        This builder for chaining.

      • clearOid

        public SubjectAltNameMatcher.Builder clearOid()
         OID Value which is required if OTHER_NAME SAN type is used.
 For example, UPN OID is 1.3.6.1.4.1.311.20.2.3
 (Reference: http://oid-info.com/get/1.3.6.1.4.1.311.20.2.3).

 If set for SAN types other than OTHER_NAME, it will be ignored.
        string oid = 3;
        Returns:
        This builder for chaining.

      • setOidBytes

        public SubjectAltNameMatcher.Builder setOidBytes​(com.google.protobuf.ByteString value)
         OID Value which is required if OTHER_NAME SAN type is used.
 For example, UPN OID is 1.3.6.1.4.1.311.20.2.3
 (Reference: http://oid-info.com/get/1.3.6.1.4.1.311.20.2.3).

 If set for SAN types other than OTHER_NAME, it will be ignored.
        string oid = 3;
        Parameters:
        value - The bytes for oid to set.
        Returns:
        This builder for chaining.