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

Class HttpService

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.extensions.filters.http.ext_authz.v3.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_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_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_api_field_extensions.filters.http.ext_authz.v3.AuthorizationResponse.allowed_upstream_headers>`
 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_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 and 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

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUTHORIZATION_REQUEST_FIELD_NUMBER
static int	AUTHORIZATION_RESPONSE_FIELD_NUMBER
static int	PATH_PREFIX_FIELD_NUMBER
static int	SERVER_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

Modifier and Type	Method and Description
boolean	equals(Object obj)
AuthorizationRequest	getAuthorizationRequest() Settings used for controlling authorization request metadata.
AuthorizationRequestOrBuilder	getAuthorizationRequestOrBuilder() Settings used for controlling authorization request metadata.
AuthorizationResponse	getAuthorizationResponse() Settings used for controlling authorization response metadata.
AuthorizationResponseOrBuilder	getAuthorizationResponseOrBuilder() Settings used for controlling authorization response metadata.
static HttpService	getDefaultInstance()
HttpService	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<HttpService>	getParserForType()
String	getPathPrefix() Sets a prefix to the value of authorization request header *Path*.
com.google.protobuf.ByteString	getPathPrefixBytes() Sets a prefix to the value of authorization request header *Path*.
int	getSerializedSize()
HttpUri	getServerUri() Sets the HTTP server URI which the authorization requests must be sent to.
HttpUriOrBuilder	getServerUriOrBuilder() Sets the HTTP server URI which the authorization requests must be sent to.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasAuthorizationRequest() Settings used for controlling authorization request metadata.
boolean	hasAuthorizationResponse() Settings used for controlling authorization response metadata.
int	hashCode()
boolean	hasServerUri() Sets the HTTP server URI which the authorization requests must be sent to.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static HttpService.Builder	newBuilder()
static HttpService.Builder	newBuilder(HttpService prototype)
HttpService.Builder	newBuilderForType()
protected HttpService.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static HttpService	parseDelimitedFrom(InputStream input)
static HttpService	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HttpService	parseFrom(byte[] data)
static HttpService	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HttpService	parseFrom(ByteBuffer data)
static HttpService	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HttpService	parseFrom(com.google.protobuf.ByteString data)
static HttpService	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HttpService	parseFrom(com.google.protobuf.CodedInputStream input)
static HttpService	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HttpService	parseFrom(InputStream input)
static HttpService	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<HttpService>	parser()
HttpService.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, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

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

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

getServerUriOrBuilder

public HttpUriOrBuilder getServerUriOrBuilder()

 Sets the HTTP server URI which the authorization requests must be sent to.
 

.envoy.config.core.v3.HttpUri server_uri = 1;

Specified by:

getServerUriOrBuilder in interface HttpServiceOrBuilder

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

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

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

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

getAuthorizationRequestOrBuilder

public AuthorizationRequestOrBuilder getAuthorizationRequestOrBuilder()

 Settings used for controlling authorization request metadata.
 

.envoy.extensions.filters.http.ext_authz.v3.AuthorizationRequest authorization_request = 7;

Specified by:

getAuthorizationRequestOrBuilder in interface HttpServiceOrBuilder

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

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

getAuthorizationResponseOrBuilder

public AuthorizationResponseOrBuilder getAuthorizationResponseOrBuilder()

 Settings used for controlling authorization response metadata.
 

.envoy.extensions.filters.http.ext_authz.v3.AuthorizationResponse authorization_response = 8;

Specified by:

getAuthorizationResponseOrBuilder in interface HttpServiceOrBuilder

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(InputStream input)
                             throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static HttpService parseDelimitedFrom(InputStream input)
                                      throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static HttpService parseFrom(com.google.protobuf.CodedInputStream input)
                             throws IOException

Throws:

IOException

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

newBuilder

public static HttpService.Builder newBuilder()

newBuilder

public static HttpService.Builder newBuilder(HttpService prototype)

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