public abstract class Credentials extends Object
Constructor and Description |
---|
Credentials() |
Modifier and Type | Method and Description |
---|---|
abstract String |
getAuthenticationType()
A constant string name describing the authentication technology.
|
Map<String,List<String>> |
getRequestMetadata()
Get the current request metadata, refreshing tokens if required.
|
abstract Map<String,List<String>> |
getRequestMetadata(URI uri)
Get the current request metadata, refreshing tokens if required.
|
abstract boolean |
hasRequestMetadata()
Whether the credentials have metadata entries that should be added to each request.
|
abstract boolean |
hasRequestMetadataOnly()
Indicates whether or not the Auth mechanism works purely by including request metadata.
|
abstract void |
refresh()
Refresh the authorization data, discarding any cached state.
|
public abstract String getAuthenticationType()
E.g. “OAuth2”, “SSL”. For use by the transport layer to determine whether it supports the
type of authentication in the case where hasRequestMetadataOnly()
is false.
Also serves as a debugging helper.
public Map<String,List<String>> getRequestMetadata() throws IOException
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.
IOException
- if there was an error getting up-to-date access.public abstract Map<String,List<String>> getRequestMetadata(URI uri) throws IOException
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.
uri
- URI of the entry point for the request.IOException
- if there was an error getting up-to-date access.public abstract boolean hasRequestMetadata()
This should be called by the transport layer to see if
getRequestMetadata()
should be used for each request.
public abstract boolean hasRequestMetadataOnly()
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.
public abstract void refresh() throws IOException
For use by the transport to allow retry after getting an error indicating there may be invalid tokens or other cached state.
IOException
- if there was an error getting up-to-date access.Copyright © 2015 Google. All rights reserved.