RegisteredClient (spring-security-oauth2-authorization-server 0.3.1 API)

java.lang.Object
- org.springframework.security.oauth2.server.authorization.client.RegisteredClient

All Implemented Interfaces:

java.io.Serializable
```
public class RegisteredClient
extends java.lang.Object
implements java.io.Serializable
```
A representation of a client registration with an OAuth 2.0 Authorization Server.

Since:

0.0.1

See Also:

Section 2 Client Registration, Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RegisteredClient.Builder
A builder for RegisteredClient.

Nested Classes
Modifier and Type	Class and Description
`static class`	`RegisteredClient.Builder` A builder for `RegisteredClient`.

Constructor Summary

Constructors
Modifier Constructor and Description

protected RegisteredClient()

Constructors
Modifier	Constructor and Description
`protected`	`RegisteredClient()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`static RegisteredClient.Builder`	`from(RegisteredClient registeredClient)` Returns a new `RegisteredClient.Builder`, initialized with the values from the provided `RegisteredClient`.
`java.util.Set<org.springframework.security.oauth2.core.AuthorizationGrantType>`	`getAuthorizationGrantTypes()` Returns the `authorization grant type(s)` that the client may use.
`java.util.Set<org.springframework.security.oauth2.core.ClientAuthenticationMethod>`	`getClientAuthenticationMethods()` Returns the `authentication method(s)` that the client may use.
`java.lang.String`	`getClientId()` Returns the client identifier.
`java.time.Instant`	`getClientIdIssuedAt()` Returns the time at which the client identifier was issued.
`java.lang.String`	`getClientName()` Returns the client name.
`java.lang.String`	`getClientSecret()` Returns the client secret or `null` if not available.
`java.time.Instant`	`getClientSecretExpiresAt()` Returns the time at which the client secret expires or `null` if it does not expire.
`ClientSettings`	`getClientSettings()` Returns the `client configuration settings`.
`java.lang.String`	`getId()` Returns the identifier for the registration.
`java.util.Set<java.lang.String>`	`getRedirectUris()` Returns the redirect URI(s) that the client may use in redirect-based flows.
`java.util.Set<java.lang.String>`	`getScopes()` Returns the scope(s) that the client may use.
`TokenSettings`	`getTokenSettings()` Returns the `token configuration settings`.
`int`	`hashCode()`
`java.lang.String`	`toString()`
`static RegisteredClient.Builder`	`withId(java.lang.String id)` Returns a new `RegisteredClient.Builder`, initialized with the provided registration identifier.

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

- Constructor Detail
  - RegisteredClient
```
protected RegisteredClient()
```
- Method Detail
  - getId
```
public java.lang.String getId()
```
    Returns the identifier for the registration.
    
    Returns:
    
    the identifier for the registration
  - getClientId
```
public java.lang.String getClientId()
```
    Returns the client identifier.
    
    Returns:
    
    the client identifier
  - getClientIdIssuedAt
```
@Nullable
public java.time.Instant getClientIdIssuedAt()
```
    Returns the time at which the client identifier was issued.
    
    Returns:
    
    the time at which the client identifier was issued
  - getClientSecret
```
@Nullable
public java.lang.String getClientSecret()
```
    Returns the client secret or null if not available.
    
    Returns:
    
    the client secret or null if not available
  - getClientSecretExpiresAt
```
@Nullable
public java.time.Instant getClientSecretExpiresAt()
```
    Returns the time at which the client secret expires or null if it does not expire.
    
    Returns:
    
    the time at which the client secret expires or null if it does not expire
  - getClientName
```
public java.lang.String getClientName()
```
    Returns the client name.
    
    Returns:
    
    the client name
  - getClientAuthenticationMethods
```
public java.util.Set<org.springframework.security.oauth2.core.ClientAuthenticationMethod> getClientAuthenticationMethods()
```
    Returns the authentication method(s) that the client may use.
    
    Returns:
    
    the Set of authentication method(s)
  - getAuthorizationGrantTypes
```
public java.util.Set<org.springframework.security.oauth2.core.AuthorizationGrantType> getAuthorizationGrantTypes()
```
    Returns the authorization grant type(s) that the client may use.
    
    Returns:
    
    the Set of authorization grant type(s)
  - getRedirectUris
```
public java.util.Set<java.lang.String> getRedirectUris()
```
    Returns the redirect URI(s) that the client may use in redirect-based flows.
    
    Returns:
    
    the Set of redirect URI(s)
  - getScopes
```
public java.util.Set<java.lang.String> getScopes()
```
    Returns the scope(s) that the client may use.
    
    Returns:
    
    the Set of scope(s)
  - getClientSettings
```
public ClientSettings getClientSettings()
```
    Returns the client configuration settings.
    
    Returns:
    
    the ClientSettings
  - getTokenSettings
```
public TokenSettings getTokenSettings()
```
    Returns the token configuration settings.
    
    Returns:
    
    the TokenSettings
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - withId
```
public static RegisteredClient.Builder withId(java.lang.String id)
```
    Returns a new RegisteredClient.Builder, initialized with the provided registration identifier.
    
    Parameters:
    
    id - the identifier for the registration
    
    Returns:
    
    the RegisteredClient.Builder
  - from
```
public static RegisteredClient.Builder from(RegisteredClient registeredClient)
```
    Returns a new RegisteredClient.Builder, initialized with the values from the provided RegisteredClient.
    
    Parameters:
    
    registeredClient - the RegisteredClient used for initializing the RegisteredClient.Builder
    
    Returns:
    
    the RegisteredClient.Builder

Class RegisteredClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RegisteredClient

Method Detail

getId

getClientId

getClientIdIssuedAt

getClientSecret

getClientSecretExpiresAt

getClientName

getClientAuthenticationMethods

getAuthorizationGrantTypes

getRedirectUris

getScopes

getClientSettings

getTokenSettings

equals

hashCode

toString

withId

from