OAuthClientConfiguration (OpenAM Server Only 7.3.1 Documentation)

java.lang.Object
- org.forgerock.oauth.OAuthClientConfiguration

Direct Known Subclasses:

OAuth2ClientConfiguration
```
public abstract class OAuthClientConfiguration
extends Object
```
Base configuration of an OAuth client.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`OAuthClientConfiguration.Builder<T extends OAuthClientConfiguration.Builder<T,C>,C extends OAuthClientConfiguration>`	Base builder used to create OAuthClientConfiguration instances.

Field Summary

Fields
Modifier and Type Field Description

static String PROVIDER
Name of the provider.

Constructor Summary

Constructors
Constructor Description

OAuthClientConfiguration(OAuthClientConfiguration.Builder<?,?> builder)
Creates an OAuthClientConfiguration instance.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getAuthenticationIdKey()`	Gets the unique authentication id that an Idp uses to identify a user by.
`abstract Class<?>`	`getClientClass()`	Gets the class name of the client implementation consuming the `OAuthClientConfiguration`.
`String`	`getProvider()`	Gets the unique provider name.

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

- Field Detail
  - PROVIDER
```
public static final String PROVIDER
```
    Name of the provider.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OAuthClientConfiguration
```
public OAuthClientConfiguration(OAuthClientConfiguration.Builder<?,?> builder)
```
    Creates an OAuthClientConfiguration instance.
    
    Parameters:
    
    builder - OAuthClientConfiguration instance builder.
- Method Detail
  - getProvider
```
public String getProvider()
```
    Gets the unique provider name.
    
    Returns:
    
    Unique provider name.
  - getAuthenticationIdKey
```
public String getAuthenticationIdKey()
```
    Gets the unique authentication id that an Idp uses to identify a user by.
    
    Returns:
    
    authentication Id.
  - getClientClass
```
public abstract Class<?> getClientClass()
```
    Gets the class name of the client implementation consuming the OAuthClientConfiguration.
    
    Returns:
    
    the client implementation class name.