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

Interface OAuth2CredentialsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
OAuth2Credentials, OAuth2Credentials.Builder
public interface OAuth2CredentialsOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getClientId

      String getClientId()
       The client_id to be used in the authorize calls. This value will be URL encoded when sent to the OAuth server.
      string client_id = 1 [(.validate.rules) = { ... }
      Returns:
      The clientId.

    • getClientIdBytes

      com.google.protobuf.ByteString getClientIdBytes()
       The client_id to be used in the authorize calls. This value will be URL encoded when sent to the OAuth server.
      string client_id = 1 [(.validate.rules) = { ... }
      Returns:
      The bytes for clientId.

    • hasTokenSecret

      boolean hasTokenSecret()
       The secret used to retrieve the access token. This value will be URL encoded when sent to the OAuth server.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig token_secret = 2 [(.validate.rules) = { ... }
      Returns:
      Whether the tokenSecret field is set.

    • getTokenSecret

      SdsSecretConfig getTokenSecret()
       The secret used to retrieve the access token. This value will be URL encoded when sent to the OAuth server.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig token_secret = 2 [(.validate.rules) = { ... }
      Returns:
      The tokenSecret.

    • getTokenSecretOrBuilder

      SdsSecretConfigOrBuilder getTokenSecretOrBuilder()
       The secret used to retrieve the access token. This value will be URL encoded when sent to the OAuth server.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig token_secret = 2 [(.validate.rules) = { ... }

    • hasHmacSecret

      boolean hasHmacSecret()
       If present, the secret token will be a HMAC using the provided secret.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig hmac_secret = 3 [(.validate.rules) = { ... }
      Returns:
      Whether the hmacSecret field is set.

    • getHmacSecret

      SdsSecretConfig getHmacSecret()
       If present, the secret token will be a HMAC using the provided secret.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig hmac_secret = 3 [(.validate.rules) = { ... }
      Returns:
      The hmacSecret.

    • getHmacSecretOrBuilder

      SdsSecretConfigOrBuilder getHmacSecretOrBuilder()
       If present, the secret token will be a HMAC using the provided secret.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig hmac_secret = 3 [(.validate.rules) = { ... }

    • hasCookieNames

      boolean hasCookieNames()
       The cookie names used in OAuth filters flow.
      .envoy.extensions.filters.http.oauth2.v3.OAuth2Credentials.CookieNames cookie_names = 4;
      Returns:
      Whether the cookieNames field is set.

    • getCookieNames

      OAuth2Credentials.CookieNames getCookieNames()
       The cookie names used in OAuth filters flow.
      .envoy.extensions.filters.http.oauth2.v3.OAuth2Credentials.CookieNames cookie_names = 4;
      Returns:
      The cookieNames.

    • getCookieNamesOrBuilder

      OAuth2Credentials.CookieNamesOrBuilder getCookieNamesOrBuilder()
       The cookie names used in OAuth filters flow.
      .envoy.extensions.filters.http.oauth2.v3.OAuth2Credentials.CookieNames cookie_names = 4;

    • getCookieDomain

      String getCookieDomain()
       The domain to set the cookie on. If not set, the cookie will default to the host of the request, not including the subdomains.
 This is useful when token cookies need to be shared across multiple subdomains.
      string cookie_domain = 5 [(.validate.rules) = { ... }
      Returns:
      The cookieDomain.

    • getCookieDomainBytes

      com.google.protobuf.ByteString getCookieDomainBytes()
       The domain to set the cookie on. If not set, the cookie will default to the host of the request, not including the subdomains.
 This is useful when token cookies need to be shared across multiple subdomains.
      string cookie_domain = 5 [(.validate.rules) = { ... }
      Returns:
      The bytes for cookieDomain.

    • getTokenFormationCase

      OAuth2Credentials.TokenFormationCase getTokenFormationCase()