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

Class OAuth2Credentials

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

  • Field Details

    • CLIENT_ID_FIELD_NUMBER

      public static final int CLIENT_ID_FIELD_NUMBER
      See Also:

    • TOKEN_SECRET_FIELD_NUMBER

      public static final int TOKEN_SECRET_FIELD_NUMBER
      See Also:

    • HMAC_SECRET_FIELD_NUMBER

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

    • getTokenFormationCase

      public OAuth2Credentials.TokenFormationCase getTokenFormationCase()
      Specified by:
      getTokenFormationCase in interface OAuth2CredentialsOrBuilder

    • getClientId

      public 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) = { ... }
      Specified by:
      getClientId in interface OAuth2CredentialsOrBuilder
      Returns:
      The clientId.

    • getClientIdBytes

      public 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) = { ... }
      Specified by:
      getClientIdBytes in interface OAuth2CredentialsOrBuilder
      Returns:
      The bytes for clientId.

    • hasTokenSecret

      public 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) = { ... }
      Specified by:
      hasTokenSecret in interface OAuth2CredentialsOrBuilder
      Returns:
      Whether the tokenSecret field is set.

    • getTokenSecret

      public 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) = { ... }
      Specified by:
      getTokenSecret in interface OAuth2CredentialsOrBuilder
      Returns:
      The tokenSecret.

    • getTokenSecretOrBuilder

      public 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) = { ... }
      Specified by:
      getTokenSecretOrBuilder in interface OAuth2CredentialsOrBuilder

    • hasHmacSecret

      public 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) = { ... }
      Specified by:
      hasHmacSecret in interface OAuth2CredentialsOrBuilder
      Returns:
      Whether the hmacSecret field is set.

    • getHmacSecret

      public 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) = { ... }
      Specified by:
      getHmacSecret in interface OAuth2CredentialsOrBuilder
      Returns:
      The hmacSecret.

    • getHmacSecretOrBuilder

      public 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) = { ... }
      Specified by:
      getHmacSecretOrBuilder in interface OAuth2CredentialsOrBuilder

    • hasCookieNames

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

    • getCookieNames

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

    • getCookieNamesOrBuilder

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

    • getCookieDomain

      public 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) = { ... }
      Specified by:
      getCookieDomain in interface OAuth2CredentialsOrBuilder
      Returns:
      The cookieDomain.

    • getCookieDomainBytes

      public 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) = { ... }
      Specified by:
      getCookieDomainBytes in interface OAuth2CredentialsOrBuilder
      Returns:
      The bytes for cookieDomain.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static OAuth2Credentials 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 parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static OAuth2Credentials.Builder newBuilder()

    • newBuilder

      public static OAuth2Credentials.Builder newBuilder(OAuth2Credentials prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static OAuth2Credentials getDefaultInstance()

    • parser

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

    • getParserForType

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