Class MetricsUtils

java.lang.Object

com.google.auth.oauth2.MetricsUtils

class MetricsUtils
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MetricsUtils.RequestType

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final String	API_CLIENT_HEADER
(package private) static final String	AUTH_REQUEST_TYPE
private static final String	authLibraryVersion
(package private) static final String	CRED_TYPE
private static final String	javaLanguageVersion

Constructor Summary

Constructors

Constructor	Description
MetricsUtils()

Method Summary

Modifier and Type	Method	Description
private static String	getAuthLibraryVersion()
(package private) static String	getGoogleCredentialsMetricsHeader(MetricsUtils.RequestType requestType, CredentialTypeForMetrics credentialTypeForMetrics)	Formulates metrics header string.
(package private) static String	getLanguageAndAuthLibraryVersions()	Gets the x-goog-api-client header value for the current Java language version and the auth library version.
(package private) static void	setMetricsHeader(com.google.api.client.http.HttpRequest request, String metricsHeader)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

API_CLIENT_HEADER

static final String API_CLIENT_HEADER

See Also:

• Constant Field Values

CRED_TYPE

static final String CRED_TYPE

See Also:

• Constant Field Values

AUTH_REQUEST_TYPE

static final String AUTH_REQUEST_TYPE

See Also:

• Constant Field Values

authLibraryVersion

private static final String authLibraryVersion

javaLanguageVersion

private static final String javaLanguageVersion

Constructor Details

MetricsUtils

MetricsUtils()

Method Details

getLanguageAndAuthLibraryVersions

static String getLanguageAndAuthLibraryVersions()

Gets the x-goog-api-client header value for the current Java language version and the auth library version.

Returns:

the header value.

getAuthLibraryVersion

private static String getAuthLibraryVersion()

getGoogleCredentialsMetricsHeader

static String getGoogleCredentialsMetricsHeader(MetricsUtils.RequestType requestType,
 CredentialTypeForMetrics credentialTypeForMetrics)

Formulates metrics header string. Header string takes format: “gl-java/JAVA_VERSION auth/LIB_VERSION auth-request-type/REQUEST_TYPE cred-type/CREDENTIAL_TYPE”. "auth-request-type" and "cred-type" can be omitted.

Parameters:

requestType - Auth request type to be specified in metrics, omit when RequestType.UNTRACKED

credentialTypeForMetrics - Credential type to be included in metrics string, omit when CredentialTypeForMetrics.DO_NOT_SEND

Returns:

metrics header string to send

setMetricsHeader

static void setMetricsHeader(com.google.api.client.http.HttpRequest request,
 String metricsHeader)