com.ibm.cos.v2.core.internal.useragent

Class DefaultSystemUserAgent

java.lang.Object

com.ibm.cos.v2.core.internal.useragent.DefaultSystemUserAgent

All Implemented Interfaces:

SystemUserAgent

@ThreadSafe
public final class DefaultSystemUserAgent
extends Object
implements SystemUserAgent

Common system level user agent properties that can either be accessed as a string or as individual values. The former is useful when making generic calls, for instance to local endpoints when resolving identity, while the latter is when incorporating this information into a user agent header in an SDK request.

Method Summary

Modifier and Type	Method and Description
List<String>	additionalJvmLanguages()
String	envMetadata()
static DefaultSystemUserAgent	getOrCreate()
String	langMetadata()
Optional<String>	languageTagMetadata()
String	osMetadata()
String	sdkVersion()
String	userAgentString() A generic user agent string to be used when communicating with backend services.
String	vendorMetadata()
String	vmMetadata()

Methods inherited from class java.lang.Object

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

Method Detail

getOrCreate

public static DefaultSystemUserAgent getOrCreate()

Specified by:

getOrCreate in interface SystemUserAgent

userAgentString

public String userAgentString()

A generic user agent string to be used when communicating with backend services. This string contains Java, OS and region information but does not contain client and request specific values.

Specified by:

userAgentString in interface SystemUserAgent

sdkVersion

public String sdkVersion()

Specified by:

sdkVersion in interface SystemUserAgent

osMetadata

public String osMetadata()

Specified by:

osMetadata in interface SystemUserAgent

langMetadata

public String langMetadata()

Specified by:

langMetadata in interface SystemUserAgent

envMetadata

public String envMetadata()

Specified by:

envMetadata in interface SystemUserAgent

vmMetadata

public String vmMetadata()

Specified by:

vmMetadata in interface SystemUserAgent

vendorMetadata

public String vendorMetadata()

Specified by:

vendorMetadata in interface SystemUserAgent

languageTagMetadata

public Optional<String> languageTagMetadata()

Specified by:

languageTagMetadata in interface SystemUserAgent

additionalJvmLanguages

public List<String> additionalJvmLanguages()

Specified by:

additionalJvmLanguages in interface SystemUserAgent