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

Class HttpService

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HttpServiceOrBuilder, Serializable
    public final class HttpService
extends com.google.protobuf.GeneratedMessageV3
implements HttpServiceOrBuilder
     HttpService is used for raw HTTP communication between the filter and the authorization service.
 When configured, the filter will parse the client request and use these attributes to call the
 authorization server. Depending on the response, the filter may reject or accept the client
 request. Note that in any of these events, metadata can be added, removed or overridden by the
 filter:
 *On authorization request*, a list of allowed request headers may be supplied. See
 :ref:`allowed_headers
 <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.AuthorizationRequest.allowed_headers>`
 for details. Additional headers metadata may be added to the authorization request. See
 :ref:`headers_to_add
 <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.AuthorizationRequest.headers_to_add>` for
 details.
 On authorization response status HTTP 200 OK, the filter will allow traffic to the upstream and
 additional headers metadata may be added to the original client request. See
 :ref:`allowed_upstream_headers
 <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.AuthorizationResponse.allowed_upstream_headers>`
 for details. Additionally, the filter may add additional headers to the client's response. See
 :ref:`allowed_client_headers_on_success
 <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.AuthorizationResponse.allowed_client_headers_on_success>`
 for details.
 On other authorization response statuses, the filter will not allow traffic. Additional headers
 metadata as well as body may be added to the client's response. See :ref:`allowed_client_headers
 <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.AuthorizationResponse.allowed_client_headers>`
 for details.
 [#next-free-field: 9]
    Protobuf type envoy.extensions.filters.http.ext_authz.v3.HttpService
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  HttpService.Builder
      HttpService is used for raw HTTP communication between the filter and the authorization service.

      • 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 Detail

      • SERVER_URI_FIELD_NUMBER

        public static final int SERVER_URI_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PATH_PREFIX_FIELD_NUMBER

        public static final int PATH_PREFIX_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AUTHORIZATION_REQUEST_FIELD_NUMBER

        public static final int AUTHORIZATION_REQUEST_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AUTHORIZATION_RESPONSE_FIELD_NUMBER

        public static final int AUTHORIZATION_RESPONSE_FIELD_NUMBER
        See Also:
        Constant Field Values

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

      • internalGetFieldAccessorTable

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

      • hasServerUri

        public boolean hasServerUri()
         Sets the HTTP server URI which the authorization requests must be sent to.
        .envoy.config.core.v3.HttpUri server_uri = 1;
        Specified by:
        hasServerUri in interface HttpServiceOrBuilder
        Returns:
        Whether the serverUri field is set.

      • getServerUri

        public HttpUri getServerUri()
         Sets the HTTP server URI which the authorization requests must be sent to.
        .envoy.config.core.v3.HttpUri server_uri = 1;
        Specified by:
        getServerUri in interface HttpServiceOrBuilder
        Returns:
        The serverUri.

      • getPathPrefix

        public String getPathPrefix()
         Sets a prefix to the value of authorization request header ``Path``.
        string path_prefix = 2;
        Specified by:
        getPathPrefix in interface HttpServiceOrBuilder
        Returns:
        The pathPrefix.

      • getPathPrefixBytes

        public com.google.protobuf.ByteString getPathPrefixBytes()
         Sets a prefix to the value of authorization request header ``Path``.
        string path_prefix = 2;
        Specified by:
        getPathPrefixBytes in interface HttpServiceOrBuilder
        Returns:
        The bytes for pathPrefix.

      • hasAuthorizationRequest

        public boolean hasAuthorizationRequest()
         Settings used for controlling authorization request metadata.
        .envoy.extensions.filters.http.ext_authz.v3.AuthorizationRequest authorization_request = 7;
        Specified by:
        hasAuthorizationRequest in interface HttpServiceOrBuilder
        Returns:
        Whether the authorizationRequest field is set.

      • getAuthorizationRequest

        public AuthorizationRequest getAuthorizationRequest()
         Settings used for controlling authorization request metadata.
        .envoy.extensions.filters.http.ext_authz.v3.AuthorizationRequest authorization_request = 7;
        Specified by:
        getAuthorizationRequest in interface HttpServiceOrBuilder
        Returns:
        The authorizationRequest.

      • hasAuthorizationResponse

        public boolean hasAuthorizationResponse()
         Settings used for controlling authorization response metadata.
        .envoy.extensions.filters.http.ext_authz.v3.AuthorizationResponse authorization_response = 8;
        Specified by:
        hasAuthorizationResponse in interface HttpServiceOrBuilder
        Returns:
        Whether the authorizationResponse field is set.

      • getAuthorizationResponse

        public AuthorizationResponse getAuthorizationResponse()
         Settings used for controlling authorization response metadata.
        .envoy.extensions.filters.http.ext_authz.v3.AuthorizationResponse authorization_response = 8;
        Specified by:
        getAuthorizationResponse in interface HttpServiceOrBuilder
        Returns:
        The authorizationResponse.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static HttpService getDefaultInstance()

      • parser

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

      • getParserForType

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