io.envoyproxy.envoy.extensions.filters.http.oauth2.v3alpha

Class OAuth2Config

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.extensions.filters.http.oauth2.v3alpha.OAuth2Config

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, OAuth2ConfigOrBuilder, Serializable

public final class OAuth2Config
extends com.google.protobuf.GeneratedMessageV3
implements OAuth2ConfigOrBuilder

 OAuth config
 [#next-free-field: 9]
 

Protobuf type envoy.extensions.filters.http.oauth2.v3alpha.OAuth2Config

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OAuth2Config.Builder OAuth config [#next-free-field: 9] Protobuf type envoy.extensions.filters.http.oauth2.v3alpha.OAuth2Config

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_ENDPOINT_FIELD_NUMBER
static int	CREDENTIALS_FIELD_NUMBER
static int	FORWARD_BEARER_TOKEN_FIELD_NUMBER
static int	PASS_THROUGH_MATCHER_FIELD_NUMBER
static int	REDIRECT_PATH_MATCHER_FIELD_NUMBER
static int	REDIRECT_URI_FIELD_NUMBER
static int	SIGNOUT_PATH_FIELD_NUMBER
static int	TOKEN_ENDPOINT_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)
String	getAuthorizationEndpoint() The endpoint redirect to for authorization in response to unauthorized requests.
com.google.protobuf.ByteString	getAuthorizationEndpointBytes() The endpoint redirect to for authorization in response to unauthorized requests.
OAuth2Credentials	getCredentials() Credentials used for OAuth.
OAuth2CredentialsOrBuilder	getCredentialsOrBuilder() Credentials used for OAuth.
static OAuth2Config	getDefaultInstance()
OAuth2Config	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getForwardBearerToken() Forward the OAuth token as a Bearer to upstream web service.
com.google.protobuf.Parser<OAuth2Config>	getParserForType()
HeaderMatcher	getPassThroughMatcher(int index) Any request that matches any of the provided matchers will be passed through without OAuth validation.
int	getPassThroughMatcherCount() Any request that matches any of the provided matchers will be passed through without OAuth validation.
List<HeaderMatcher>	getPassThroughMatcherList() Any request that matches any of the provided matchers will be passed through without OAuth validation.
HeaderMatcherOrBuilder	getPassThroughMatcherOrBuilder(int index) Any request that matches any of the provided matchers will be passed through without OAuth validation.
List<? extends HeaderMatcherOrBuilder>	getPassThroughMatcherOrBuilderList() Any request that matches any of the provided matchers will be passed through without OAuth validation.
PathMatcher	getRedirectPathMatcher() Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.
PathMatcherOrBuilder	getRedirectPathMatcherOrBuilder() Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.
String	getRedirectUri() The redirect URI passed to the authorization endpoint.
com.google.protobuf.ByteString	getRedirectUriBytes() The redirect URI passed to the authorization endpoint.
int	getSerializedSize()
PathMatcher	getSignoutPath() The path to sign a user out, clearing their credential cookies.
PathMatcherOrBuilder	getSignoutPathOrBuilder() The path to sign a user out, clearing their credential cookies.
HttpUri	getTokenEndpoint() Endpoint on the authorization server to retrieve the access token from.
HttpUriOrBuilder	getTokenEndpointOrBuilder() Endpoint on the authorization server to retrieve the access token from.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasCredentials() Credentials used for OAuth.
int	hashCode()
boolean	hasRedirectPathMatcher() Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.
boolean	hasSignoutPath() The path to sign a user out, clearing their credential cookies.
boolean	hasTokenEndpoint() Endpoint on the authorization server to retrieve the access token from.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static OAuth2Config.Builder	newBuilder()
static OAuth2Config.Builder	newBuilder(OAuth2Config prototype)
OAuth2Config.Builder	newBuilderForType()
protected OAuth2Config.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static OAuth2Config	parseDelimitedFrom(InputStream input)
static OAuth2Config	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OAuth2Config	parseFrom(byte[] data)
static OAuth2Config	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OAuth2Config	parseFrom(ByteBuffer data)
static OAuth2Config	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OAuth2Config	parseFrom(com.google.protobuf.ByteString data)
static OAuth2Config	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OAuth2Config	parseFrom(com.google.protobuf.CodedInputStream input)
static OAuth2Config	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OAuth2Config	parseFrom(InputStream input)
static OAuth2Config	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<OAuth2Config>	parser()
OAuth2Config.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

TOKEN_ENDPOINT_FIELD_NUMBER

public static final int TOKEN_ENDPOINT_FIELD_NUMBER

See Also:

Constant Field Values

AUTHORIZATION_ENDPOINT_FIELD_NUMBER

public static final int AUTHORIZATION_ENDPOINT_FIELD_NUMBER

See Also:

Constant Field Values

CREDENTIALS_FIELD_NUMBER

public static final int CREDENTIALS_FIELD_NUMBER

See Also:

Constant Field Values

REDIRECT_URI_FIELD_NUMBER

public static final int REDIRECT_URI_FIELD_NUMBER

See Also:

Constant Field Values

REDIRECT_PATH_MATCHER_FIELD_NUMBER

public static final int REDIRECT_PATH_MATCHER_FIELD_NUMBER

See Also:

Constant Field Values

SIGNOUT_PATH_FIELD_NUMBER

public static final int SIGNOUT_PATH_FIELD_NUMBER

See Also:

Constant Field Values

FORWARD_BEARER_TOKEN_FIELD_NUMBER

public static final int FORWARD_BEARER_TOKEN_FIELD_NUMBER

See Also:

Constant Field Values

PASS_THROUGH_MATCHER_FIELD_NUMBER

public static final int PASS_THROUGH_MATCHER_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

hasTokenEndpoint

public boolean hasTokenEndpoint()

 Endpoint on the authorization server to retrieve the access token from.
 

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

Specified by:

hasTokenEndpoint in interface OAuth2ConfigOrBuilder

getTokenEndpoint

public HttpUri getTokenEndpoint()

 Endpoint on the authorization server to retrieve the access token from.
 

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

Specified by:

getTokenEndpoint in interface OAuth2ConfigOrBuilder

getTokenEndpointOrBuilder

public HttpUriOrBuilder getTokenEndpointOrBuilder()

 Endpoint on the authorization server to retrieve the access token from.
 

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

Specified by:

getTokenEndpointOrBuilder in interface OAuth2ConfigOrBuilder

getAuthorizationEndpoint

public String getAuthorizationEndpoint()

 The endpoint redirect to for authorization in response to unauthorized requests.
 

string authorization_endpoint = 2 [(.validate.rules) = { ... }

Specified by:

getAuthorizationEndpoint in interface OAuth2ConfigOrBuilder

getAuthorizationEndpointBytes

public com.google.protobuf.ByteString getAuthorizationEndpointBytes()

 The endpoint redirect to for authorization in response to unauthorized requests.
 

string authorization_endpoint = 2 [(.validate.rules) = { ... }

Specified by:

getAuthorizationEndpointBytes in interface OAuth2ConfigOrBuilder

hasCredentials

public boolean hasCredentials()

 Credentials used for OAuth.
 

.envoy.extensions.filters.http.oauth2.v3alpha.OAuth2Credentials credentials = 3 [(.validate.rules) = { ... }

Specified by:

hasCredentials in interface OAuth2ConfigOrBuilder

getCredentials

public OAuth2Credentials getCredentials()

 Credentials used for OAuth.
 

.envoy.extensions.filters.http.oauth2.v3alpha.OAuth2Credentials credentials = 3 [(.validate.rules) = { ... }

Specified by:

getCredentials in interface OAuth2ConfigOrBuilder

getCredentialsOrBuilder

public OAuth2CredentialsOrBuilder getCredentialsOrBuilder()

 Credentials used for OAuth.
 

.envoy.extensions.filters.http.oauth2.v3alpha.OAuth2Credentials credentials = 3 [(.validate.rules) = { ... }

Specified by:

getCredentialsOrBuilder in interface OAuth2ConfigOrBuilder

getRedirectUri

public String getRedirectUri()

 The redirect URI passed to the authorization endpoint. Supports header formatting
 tokens. For more information, including details on header value syntax, see the
 documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
 This URI should not contain any query parameters.
 

string redirect_uri = 4 [(.validate.rules) = { ... }

Specified by:

getRedirectUri in interface OAuth2ConfigOrBuilder

getRedirectUriBytes

public com.google.protobuf.ByteString getRedirectUriBytes()

 The redirect URI passed to the authorization endpoint. Supports header formatting
 tokens. For more information, including details on header value syntax, see the
 documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
 This URI should not contain any query parameters.
 

string redirect_uri = 4 [(.validate.rules) = { ... }

Specified by:

getRedirectUriBytes in interface OAuth2ConfigOrBuilder

hasRedirectPathMatcher

public boolean hasRedirectPathMatcher()

 Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.
 

.envoy.type.matcher.v3.PathMatcher redirect_path_matcher = 5 [(.validate.rules) = { ... }

Specified by:

hasRedirectPathMatcher in interface OAuth2ConfigOrBuilder

getRedirectPathMatcher

public PathMatcher getRedirectPathMatcher()

 Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.
 

.envoy.type.matcher.v3.PathMatcher redirect_path_matcher = 5 [(.validate.rules) = { ... }

Specified by:

getRedirectPathMatcher in interface OAuth2ConfigOrBuilder

getRedirectPathMatcherOrBuilder

public PathMatcherOrBuilder getRedirectPathMatcherOrBuilder()

 Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.
 

.envoy.type.matcher.v3.PathMatcher redirect_path_matcher = 5 [(.validate.rules) = { ... }

Specified by:

getRedirectPathMatcherOrBuilder in interface OAuth2ConfigOrBuilder

hasSignoutPath

public boolean hasSignoutPath()

 The path to sign a user out, clearing their credential cookies.
 

.envoy.type.matcher.v3.PathMatcher signout_path = 6 [(.validate.rules) = { ... }

Specified by:

hasSignoutPath in interface OAuth2ConfigOrBuilder

getSignoutPath

public PathMatcher getSignoutPath()

 The path to sign a user out, clearing their credential cookies.
 

.envoy.type.matcher.v3.PathMatcher signout_path = 6 [(.validate.rules) = { ... }

Specified by:

getSignoutPath in interface OAuth2ConfigOrBuilder

getSignoutPathOrBuilder

public PathMatcherOrBuilder getSignoutPathOrBuilder()

 The path to sign a user out, clearing their credential cookies.
 

.envoy.type.matcher.v3.PathMatcher signout_path = 6 [(.validate.rules) = { ... }

Specified by:

getSignoutPathOrBuilder in interface OAuth2ConfigOrBuilder

getForwardBearerToken

public boolean getForwardBearerToken()

 Forward the OAuth token as a Bearer to upstream web service.
 

bool forward_bearer_token = 7;

Specified by:

getForwardBearerToken in interface OAuth2ConfigOrBuilder

getPassThroughMatcherList

public List<HeaderMatcher> getPassThroughMatcherList()

 Any request that matches any of the provided matchers will be passed through without OAuth validation.
 

repeated .envoy.config.route.v3.HeaderMatcher pass_through_matcher = 8;

Specified by:

getPassThroughMatcherList in interface OAuth2ConfigOrBuilder

getPassThroughMatcherOrBuilderList

public List<? extends HeaderMatcherOrBuilder> getPassThroughMatcherOrBuilderList()

 Any request that matches any of the provided matchers will be passed through without OAuth validation.
 

repeated .envoy.config.route.v3.HeaderMatcher pass_through_matcher = 8;

Specified by:

getPassThroughMatcherOrBuilderList in interface OAuth2ConfigOrBuilder

getPassThroughMatcherCount

public int getPassThroughMatcherCount()

 Any request that matches any of the provided matchers will be passed through without OAuth validation.
 

repeated .envoy.config.route.v3.HeaderMatcher pass_through_matcher = 8;

Specified by:

getPassThroughMatcherCount in interface OAuth2ConfigOrBuilder

getPassThroughMatcher

public HeaderMatcher getPassThroughMatcher(int index)

 Any request that matches any of the provided matchers will be passed through without OAuth validation.
 

repeated .envoy.config.route.v3.HeaderMatcher pass_through_matcher = 8;

Specified by:

getPassThroughMatcher in interface OAuth2ConfigOrBuilder

getPassThroughMatcherOrBuilder

public HeaderMatcherOrBuilder getPassThroughMatcherOrBuilder(int index)

 Any request that matches any of the provided matchers will be passed through without OAuth validation.
 

repeated .envoy.config.route.v3.HeaderMatcher pass_through_matcher = 8;

Specified by:

getPassThroughMatcherOrBuilder in interface OAuth2ConfigOrBuilder

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 OAuth2Config parseFrom(ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OAuth2Config parseFrom(com.google.protobuf.ByteString data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OAuth2Config parseFrom(byte[] data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OAuth2Config parseFrom(InputStream input)
                              throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static OAuth2Config parseDelimitedFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public OAuth2Config.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static OAuth2Config.Builder newBuilder()

newBuilder

public static OAuth2Config.Builder newBuilder(OAuth2Config prototype)

toBuilder

public OAuth2Config.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected OAuth2Config.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static OAuth2Config getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<OAuth2Config> 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 OAuth2Config getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder