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

Class OAuth2Credentials.CookieNames

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.http.oauth2.v3.OAuth2Credentials.CookieNames
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, OAuth2Credentials.CookieNamesOrBuilder, Serializable
Enclosing class:
OAuth2Credentials
public static final class OAuth2Credentials.CookieNames extends com.google.protobuf.GeneratedMessageV3 implements OAuth2Credentials.CookieNamesOrBuilder
 [#next-free-field: 8]
Protobuf type envoy.extensions.filters.http.oauth2.v3.OAuth2Credentials.CookieNames
See Also:

  • Field Details

    • BEARER_TOKEN_FIELD_NUMBER

      public static final int BEARER_TOKEN_FIELD_NUMBER
      See Also:

    • OAUTH_HMAC_FIELD_NUMBER

      public static final int OAUTH_HMAC_FIELD_NUMBER
      See Also:

    • OAUTH_EXPIRES_FIELD_NUMBER

      public static final int OAUTH_EXPIRES_FIELD_NUMBER
      See Also:

    • ID_TOKEN_FIELD_NUMBER

      public static final int ID_TOKEN_FIELD_NUMBER
      See Also:

    • REFRESH_TOKEN_FIELD_NUMBER

      public static final int REFRESH_TOKEN_FIELD_NUMBER
      See Also:

    • OAUTH_NONCE_FIELD_NUMBER

      public static final int OAUTH_NONCE_FIELD_NUMBER
      See Also:

    • CODE_VERIFIER_FIELD_NUMBER

      public static final int CODE_VERIFIER_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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

    • getBearerToken

      public String getBearerToken()
       Cookie name to hold OAuth bearer token value. When the authentication server validates the
 client and returns an authorization token back to the OAuth filter, no matter what format
 that token is, if :ref:`forward_bearer_token <envoy_v3_api_field_extensions.filters.http.oauth2.v3.OAuth2Config.forward_bearer_token>`
 is set to true the filter will send over the bearer token as a cookie with this name to the
 upstream. Defaults to ``BearerToken``.
      string bearer_token = 1 [(.validate.rules) = { ... }
      Specified by:
      getBearerToken in interface OAuth2Credentials.CookieNamesOrBuilder
      Returns:
      The bearerToken.

    • getBearerTokenBytes

      public com.google.protobuf.ByteString getBearerTokenBytes()
       Cookie name to hold OAuth bearer token value. When the authentication server validates the
 client and returns an authorization token back to the OAuth filter, no matter what format
 that token is, if :ref:`forward_bearer_token <envoy_v3_api_field_extensions.filters.http.oauth2.v3.OAuth2Config.forward_bearer_token>`
 is set to true the filter will send over the bearer token as a cookie with this name to the
 upstream. Defaults to ``BearerToken``.
      string bearer_token = 1 [(.validate.rules) = { ... }
      Specified by:
      getBearerTokenBytes in interface OAuth2Credentials.CookieNamesOrBuilder
      Returns:
      The bytes for bearerToken.

    • getOauthHmac

      public String getOauthHmac()
       Cookie name to hold OAuth HMAC value. Defaults to ``OauthHMAC``.
      string oauth_hmac = 2 [(.validate.rules) = { ... }
      Specified by:
      getOauthHmac in interface OAuth2Credentials.CookieNamesOrBuilder
      Returns:
      The oauthHmac.

    • getOauthHmacBytes

      public com.google.protobuf.ByteString getOauthHmacBytes()
       Cookie name to hold OAuth HMAC value. Defaults to ``OauthHMAC``.
      string oauth_hmac = 2 [(.validate.rules) = { ... }
      Specified by:
      getOauthHmacBytes in interface OAuth2Credentials.CookieNamesOrBuilder
      Returns:
      The bytes for oauthHmac.

    • getOauthExpires

      public String getOauthExpires()
       Cookie name to hold OAuth expiry value. Defaults to ``OauthExpires``.
      string oauth_expires = 3 [(.validate.rules) = { ... }
      Specified by:
      getOauthExpires in interface OAuth2Credentials.CookieNamesOrBuilder
      Returns:
      The oauthExpires.

    • getOauthExpiresBytes

      public com.google.protobuf.ByteString getOauthExpiresBytes()
       Cookie name to hold OAuth expiry value. Defaults to ``OauthExpires``.
      string oauth_expires = 3 [(.validate.rules) = { ... }
      Specified by:
      getOauthExpiresBytes in interface OAuth2Credentials.CookieNamesOrBuilder
      Returns:
      The bytes for oauthExpires.

    • getIdToken

      public String getIdToken()
       Cookie name to hold the id token. Defaults to ``IdToken``.
      string id_token = 4 [(.validate.rules) = { ... }
      Specified by:
      getIdToken in interface OAuth2Credentials.CookieNamesOrBuilder
      Returns:
      The idToken.

    • getIdTokenBytes

      public com.google.protobuf.ByteString getIdTokenBytes()
       Cookie name to hold the id token. Defaults to ``IdToken``.
      string id_token = 4 [(.validate.rules) = { ... }
      Specified by:
      getIdTokenBytes in interface OAuth2Credentials.CookieNamesOrBuilder
      Returns:
      The bytes for idToken.

    • getRefreshToken

      public String getRefreshToken()
       Cookie name to hold the refresh token. Defaults to ``RefreshToken``.
      string refresh_token = 5 [(.validate.rules) = { ... }
      Specified by:
      getRefreshToken in interface OAuth2Credentials.CookieNamesOrBuilder
      Returns:
      The refreshToken.

    • getRefreshTokenBytes

      public com.google.protobuf.ByteString getRefreshTokenBytes()
       Cookie name to hold the refresh token. Defaults to ``RefreshToken``.
      string refresh_token = 5 [(.validate.rules) = { ... }
      Specified by:
      getRefreshTokenBytes in interface OAuth2Credentials.CookieNamesOrBuilder
      Returns:
      The bytes for refreshToken.

    • getOauthNonce

      public String getOauthNonce()
       Cookie name to hold the nonce value. Defaults to ``OauthNonce``.
      string oauth_nonce = 6 [(.validate.rules) = { ... }
      Specified by:
      getOauthNonce in interface OAuth2Credentials.CookieNamesOrBuilder
      Returns:
      The oauthNonce.

    • getOauthNonceBytes

      public com.google.protobuf.ByteString getOauthNonceBytes()
       Cookie name to hold the nonce value. Defaults to ``OauthNonce``.
      string oauth_nonce = 6 [(.validate.rules) = { ... }
      Specified by:
      getOauthNonceBytes in interface OAuth2Credentials.CookieNamesOrBuilder
      Returns:
      The bytes for oauthNonce.

    • getCodeVerifier

      public String getCodeVerifier()
       Cookie name to hold the PKCE code verifier. Defaults to ``OauthCodeVerifier``.
      string code_verifier = 7 [(.validate.rules) = { ... }
      Specified by:
      getCodeVerifier in interface OAuth2Credentials.CookieNamesOrBuilder
      Returns:
      The codeVerifier.

    • getCodeVerifierBytes

      public com.google.protobuf.ByteString getCodeVerifierBytes()
       Cookie name to hold the PKCE code verifier. Defaults to ``OauthCodeVerifier``.
      string code_verifier = 7 [(.validate.rules) = { ... }
      Specified by:
      getCodeVerifierBytes in interface OAuth2Credentials.CookieNamesOrBuilder
      Returns:
      The bytes for codeVerifier.

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

    • parseFrom

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

    • parseFrom

      public static OAuth2Credentials.CookieNames parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static OAuth2Credentials.CookieNames parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static OAuth2Credentials.CookieNames parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static OAuth2Credentials.CookieNames parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static OAuth2Credentials.CookieNames parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static OAuth2Credentials.CookieNames parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static OAuth2Credentials.CookieNames.Builder newBuilder()

    • newBuilder

      public static OAuth2Credentials.CookieNames.Builder newBuilder(OAuth2Credentials.CookieNames prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static OAuth2Credentials.CookieNames getDefaultInstance()

    • parser

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

    • getParserForType

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