BasicCredentials (IG Aggregated Javadoc 2023.11.1 Documentation)

java.lang.Object
- org.forgerock.http.header.authorization.BasicCredentials

public class BasicCredentials
extends Object

A rich representation of basic credentials.

Field Summary

Fields
Modifier and Type Field Description

static String NAME
The name of the Basic challenge scheme.

static CredentialsParser<BasicCredentials> PARSER
The parser for Basic credentials.

Constructor Summary

Constructors
Constructor Description

BasicCredentials(String username, String password)
Construct a new set of Basic authorization credentials.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getPassword()`	Get the password.
`String`	`getUsername()`	Get the username.
`String`	`toString()`
`String`	`toString(Charset charset)`	Get the string credentials in the specified charset.

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

- Field Detail
  - NAME
```
public static final String NAME
```
    The name of the Basic challenge scheme.
    
    See Also:
    
    Constant Field Values
  - PARSER
```
public static final CredentialsParser<BasicCredentials> PARSER
```
    The parser for Basic credentials.
- Constructor Detail
  - BasicCredentials
```
public BasicCredentials(String username,
                        String password)
```
    Construct a new set of Basic authorization credentials.
    
    Parameters:
    
    username - The username.
    
    password - The password.
- Method Detail
  - getUsername
```
public String getUsername()
```
    Get the username.
    
    Returns:
    
    The username.
  - getPassword
```
public String getPassword()
```
    Get the password.
    
    Returns:
    
    The password.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toString
```
public String toString(Charset charset)
```
    Get the string credentials in the specified charset.
    
    Parameters:
    
    charset - The charset to encode as.
    
    Returns:
    
    The credentials string.