Class ApiKeyCredentials
- java.lang.Object
-
- com.google.auth.Credentials
-
- com.google.auth.ApiKeyCredentials
-
- All Implemented Interfaces:
java.io.Serializable
public class ApiKeyCredentials extends Credentials
Credentials class for calling Google APIs using an API key.Uses an API key directly in the request metadata to provide authorization.
Note: ApiKeyCredentials extends from base
Credentials
class rather than GoogleCredentials/OAuth2Credentials, as it does not provide an access token and is not considered an OAuth2 credential.Credentials credentials = ApiKeyCredentials.create("your api key");
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description (package private) static java.lang.String
API_KEY_HEADER_KEY
private java.lang.String
apiKey
-
Fields inherited from class com.google.auth.Credentials
GOOGLE_DEFAULT_UNIVERSE
-
-
Constructor Summary
Constructors Constructor Description ApiKeyCredentials(java.lang.String apiKey)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ApiKeyCredentials
create(java.lang.String apiKey)
java.lang.String
getAuthenticationType()
A constant string name describing the authentication technology.java.util.Map<java.lang.String,java.util.List<java.lang.String>>
getRequestMetadata(java.net.URI uri)
Get the current request metadata in a blocking manner, refreshing tokens if required.boolean
hasRequestMetadata()
Whether the credentials have metadata entries that should be added to each request.boolean
hasRequestMetadataOnly()
Indicates whether or not the Auth mechanism works purely by including request metadata.void
refresh()
There is no concept of refreshing an API tokens, this method is a no-op.-
Methods inherited from class com.google.auth.Credentials
blockingGetToCallback, getMetricsCredentialType, getRequestMetadata, getRequestMetadata, getUniverseDomain
-
-
-
-
Field Detail
-
API_KEY_HEADER_KEY
static final java.lang.String API_KEY_HEADER_KEY
- See Also:
- Constant Field Values
-
apiKey
private final java.lang.String apiKey
-
-
Method Detail
-
create
public static ApiKeyCredentials create(java.lang.String apiKey)
-
getAuthenticationType
public java.lang.String getAuthenticationType()
Description copied from class:Credentials
A constant string name describing the authentication technology.E.g. “OAuth2”, “SSL”. For use by the transport layer to determine whether it supports the type of authentication in the case where
Credentials.hasRequestMetadataOnly()
is false. Also serves as a debugging helper.- Specified by:
getAuthenticationType
in classCredentials
- Returns:
- The type of authentication used.
-
getRequestMetadata
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getRequestMetadata(java.net.URI uri) throws java.io.IOException
Description copied from class:Credentials
Get the current request metadata in a blocking manner, refreshing tokens if required.This should be called by the transport layer on each request, and the data should be populated in headers or other context. The operation can block and fail to complete and may do things such as refreshing access tokens.
The convention for handling binary data is for the key in the returned map to end with
"-bin"
and for the corresponding values to be base64 encoded.- Specified by:
getRequestMetadata
in classCredentials
- Parameters:
uri
- URI of the entry point for the request.- Returns:
- The request metadata used for populating headers or other context.
- Throws:
java.io.IOException
- if there was an error getting up-to-date access. The exception should implementRetryable
andisRetryable()
will return true if the operation may be retried.
-
hasRequestMetadata
public boolean hasRequestMetadata()
Description copied from class:Credentials
Whether the credentials have metadata entries that should be added to each request.This should be called by the transport layer to see if
Credentials.getRequestMetadata()
should be used for each request.- Specified by:
hasRequestMetadata
in classCredentials
- Returns:
- Whether or not the transport layer should call
Credentials.getRequestMetadata()
-
hasRequestMetadataOnly
public boolean hasRequestMetadataOnly()
Description copied from class:Credentials
Indicates whether or not the Auth mechanism works purely by including request metadata.This is meant for the transport layer. If this is true a transport does not need to take actions other than including the request metadata. If this is false, a transport must specifically know about the authentication technology to support it, and should fail to accept the credentials otherwise.
- Specified by:
hasRequestMetadataOnly
in classCredentials
- Returns:
- Whether or not the Auth mechanism works purely by including request metadata.
-
refresh
public void refresh() throws java.io.IOException
There is no concept of refreshing an API tokens, this method is a no-op.- Specified by:
refresh
in classCredentials
- Throws:
java.io.IOException
- if there was an error getting up-to-date access.
-
-