AuthToken (dxlib 3.346)

java.lang.Object
- com.devexperts.auth.AuthToken

All Implemented Interfaces:

Serializable
```
public class AuthToken
extends Object
implements Serializable
```
The AuthToken class represents an authorization token and encapsulates information about the authorization scheme and its associated value.
An AuthToken consists of the following components:
- Scheme - The authorization scheme (e.g., "Basic" or "Bearer").
- Value - The encoded value, which is scheme-dependent (e.g., an access token per RFC6750 or Base64-encoded "user:password" per RFC2617).
- String representation - A string that combines the scheme and value in the format: [scheme + " " + value].
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String BASIC_SCHEME

static String BEARER_SCHEME

Fields
Modifier and Type	Field and Description
`static String`	`BASIC_SCHEME`
`static String`	`BEARER_SCHEME`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AuthToken`	`createBasicToken(String userPassword)` Constructs an `AuthToken` with the specified username and password per RFC2617.
`static AuthToken`	`createBasicToken(String user, String password)` Constructs an `AuthToken` with the specified username and password per RFC2617.
`static AuthToken`	`createBasicTokenOrNull(String user, String password)` Constructs an `AuthToken` with the specified username and password per RFC2617.
`static AuthToken`	`createBearerToken(String token)` Constructs an `AuthToken` with the specified bearer token per RFC6750.
`static AuthToken`	`createBearerTokenOrNull(String token)` Constructs an `AuthToken` with the specified bearer token per RFC6750.
`static AuthToken`	`createCustomToken(String scheme, String value)` Constructs an `AuthToken` with a custom scheme and value.
`boolean`	`equals(Object o)`
`String`	`getHttpAuthorization()` Returns the HTTP authorization header value.
`String`	`getPassword()` Returns the password or `null` if it is not known or applicable.
`String`	`getScheme()` Returns the authentication scheme.
`String`	`getUser()` Returns the username or `null` if it is not known or applicable.
`String`	`getValue()` Returns the access token for RFC6750 or the Base64-encoded "username:password" for RFC2617.
`int`	`hashCode()`
`String`	`toString()`
`static AuthToken`	`valueOf(String string)` Constructs an `AuthToken` from the specified string.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - BASIC_SCHEME
```
public static final String BASIC_SCHEME
```
    See Also:
    
    Constant Field Values
  - BEARER_SCHEME
```
public static final String BEARER_SCHEME
```
    See Also:
    
    Constant Field Values
- Method Detail
  - valueOf
```
public static AuthToken valueOf(String string)
```
    Constructs an AuthToken from the specified string.
    
    Parameters:
    
    string - the string with space-separated scheme and value
    
    Returns:
    
    the constructed AuthToken
    
    Throws:
    
    NullPointerException - if the specified string is null
    
    InvalidFormatException - if the string is malformed, or if the scheme is "Basic" but the format does not comply with RFC2617
    
    See Also:
    
    toString()
  - createBasicToken
```
public static AuthToken createBasicToken(String userPassword)
```
    Constructs an AuthToken with the specified username and password per RFC2617. Username and password can be empty.
    
    Parameters:
    
    userPassword - the string containing the username and password in the format "username:password"
    
    Returns:
    
    the constructed AuthToken
    
    Throws:
    
    NullPointerException - if the userPassword is null
    
    InvalidFormatException - if the userPassword is malformed
  - createBasicToken
```
public static AuthToken createBasicToken(String user,
                                         String password)
```
    Constructs an AuthToken with the specified username and password per RFC2617. Username and password can be empty.
    
    Parameters:
    
    user - the username
    
    password - the password
    
    Returns:
    
    the constructed AuthToken
    
    Throws:
    
    NullPointerException - if either the username or password is null
  - createBasicTokenOrNull
```
public static AuthToken createBasicTokenOrNull(String user,
                                               String password)
```
    Constructs an AuthToken with the specified username and password per RFC2617. If both the username and password are empty or null, returns null.
    
    Parameters:
    
    user - the username
    
    password - the password
    
    Returns:
    
    the constructed AuthToken or null
  - createBearerToken
```
public static AuthToken createBearerToken(String token)
```
    Constructs an AuthToken with the specified bearer token per RFC6750.
    
    Parameters:
    
    token - the access token
    
    Returns:
    
    the constructed AuthToken
    
    Throws:
    
    NullPointerException - if the token is null
    
    InvalidFormatException - if the token is empty
  - createBearerTokenOrNull
```
public static AuthToken createBearerTokenOrNull(String token)
```
    Constructs an AuthToken with the specified bearer token per RFC6750.
    
    Parameters:
    
    token - the access token
    
    Returns:
    
    the constructed AuthToken or null
  - createCustomToken
```
public static AuthToken createCustomToken(String scheme,
                                          String value)
```
    Constructs an AuthToken with a custom scheme and value.
    
    Parameters:
    
    scheme - the custom scheme
    
    value - the custom value
    
    Returns:
    
    the constructed AuthToken
    
    Throws:
    
    NullPointerException - if either the scheme or value is null
    
    InvalidFormatException - if the scheme or value is empty
  - getHttpAuthorization
```
public String getHttpAuthorization()
```
    Returns the HTTP authorization header value.
    
    Returns:
    
    the HTTP authorization header value
  - getUser
```
public String getUser()
```
    Returns the username or null if it is not known or applicable.
    
    Returns:
    
    the username, or null if not known or applicable
  - getPassword
```
public String getPassword()
```
    Returns the password or null if it is not known or applicable.
    
    Returns:
    
    the password, or null if not known or applicable
  - getScheme
```
public String getScheme()
```
    Returns the authentication scheme.
    
    Returns:
    
    the authentication scheme
  - getValue
```
public String getValue()
```
    Returns the access token for RFC6750 or the Base64-encoded "username:password" for RFC2617.
    
    Returns:
    
    the access token or Base64-encoded "username:password"
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AuthToken

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BASIC_SCHEME

BEARER_SCHEME

Method Detail

valueOf

createBasicToken

createBasicToken

createBasicTokenOrNull

createBearerToken

createBearerTokenOrNull

createCustomToken

getHttpAuthorization

getUser

getPassword

getScheme

getValue

equals

hashCode

toString