com.okta.spring.oauth.http

Class UserAgent

java.lang.Object

com.okta.spring.oauth.http.UserAgent

public class UserAgent
extends Object

This class is in charge of constructing the User-Agent http header string that will be sent to Okta in order to describe the current running environment of this Java SDK.

The form of this string is the concatenation of the following sub-items:

1. The okta integration and version separated by a '/'. If there is no integration being used, this can be omitted
2. The okta sdk and version separated by a '/'
3. The runtime information (runtime/version)
   1. Integration Runtime (if there is no integration being used, this can be omitted)
   2. SDK Runtime
4. The OS common name and version separated by a '/'.
5. All other system information included in parentheses

The User-Agent value is created when this class is loaded. The string can be obtained just by invoking UserAgent.getUserAgentString().

This is a sample User-Agent string: okta-spring-security/0.7.0 okta-sdk-java/0.5.0 spring/4.0.4.RELEASE java/1.7.0_45 Mac OS X/10.9.2 (spring-security/3.2.0.RELEASE jetty/8.1.5.v20120716)

Since:

0.4.0

Method Summary

Modifier and Type	Method and Description
static String	getUserAgentString()

Methods inherited from class java.lang.Object

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

Method Detail

getUserAgentString

public static String getUserAgentString()