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

Interface OAuth2Credentials.CookieNamesOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
OAuth2Credentials.CookieNames, OAuth2Credentials.CookieNames.Builder
Enclosing class:
OAuth2Credentials
public static interface OAuth2Credentials.CookieNamesOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getBearerToken()
    Cookie name to hold OAuth bearer token value.
    com.google.protobuf.ByteString
    getBearerTokenBytes()
    Cookie name to hold OAuth bearer token value.
    String
    getCodeVerifier()
    Cookie name to hold the PKCE code verifier.
    com.google.protobuf.ByteString
    getCodeVerifierBytes()
    Cookie name to hold the PKCE code verifier.
    String
    getIdToken()
    Cookie name to hold the id token.
    com.google.protobuf.ByteString
    getIdTokenBytes()
    Cookie name to hold the id token.
    String
    getOauthExpires()
    Cookie name to hold OAuth expiry value.
    com.google.protobuf.ByteString
    getOauthExpiresBytes()
    Cookie name to hold OAuth expiry value.
    String
    getOauthHmac()
    Cookie name to hold OAuth HMAC value.
    com.google.protobuf.ByteString
    getOauthHmacBytes()
    Cookie name to hold OAuth HMAC value.
    String
    getOauthNonce()
    Cookie name to hold the nonce value.
    com.google.protobuf.ByteString
    getOauthNonceBytes()
    Cookie name to hold the nonce value.
    String
    getRefreshToken()
    Cookie name to hold the refresh token.
    com.google.protobuf.ByteString
    getRefreshTokenBytes()
    Cookie name to hold the refresh token.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getBearerToken

      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) = { ... }
      Returns:
      The bearerToken.

    • getBearerTokenBytes

      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) = { ... }
      Returns:
      The bytes for bearerToken.

    • getOauthHmac

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

    • getOauthHmacBytes

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

    • getOauthExpires

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

    • getOauthExpiresBytes

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

    • getIdToken

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

    • getIdTokenBytes

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

    • getRefreshToken

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

    • getRefreshTokenBytes

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

    • getOauthNonce

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

    • getOauthNonceBytes

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

    • getCodeVerifier

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

    • getCodeVerifierBytes

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