OAuth2Authorization.Builder (spring-security-oauth2-authorization-server 0.0.1 API)

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.springframework.security.oauth2.server.authorization.OAuth2Authorization.Builder

All Implemented Interfaces:
Serializable
Enclosing class:
OAuth2Authorization
```
public static class OAuth2Authorization.Builder
extends Object
implements Serializable
```
A builder for OAuth2Authorization.
See Also:
Serialized Form

Constructor Summary
Constructors
Modifier Constructor and Description
protected Builder(String registeredClientId)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OAuth2Authorization.Builder`	`accessToken(OAuth2AccessToken accessToken)` Sets the `access token` credential.
`OAuth2Authorization.Builder`	`attribute(String name, Object value)` Adds an attribute associated to the authorization.
`OAuth2Authorization.Builder`	`attributes(Consumer<Map<String,Object>> attributesConsumer)` A `Consumer` of the attributes `Map` allowing the ability to add, replace, or remove.
`OAuth2Authorization`	`build()` Builds a new `OAuth2Authorization`.
`OAuth2Authorization.Builder`	`principalName(String principalName)` Sets the resource owner's `Principal` name.

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

- Constructor Detail
  - Builder
```
protected Builder(String registeredClientId)
```
- Method Detail
  - principalName
```
public OAuth2Authorization.Builder principalName(String principalName)
```
    Sets the resource owner's Principal name.
    Parameters:
    principalName - the resource owner's Principal name
    Returns:
    the OAuth2Authorization.Builder
  - accessToken
```
public OAuth2Authorization.Builder accessToken(OAuth2AccessToken accessToken)
```
    Sets the access token credential.
    Parameters:
    accessToken - the OAuth2AccessToken
    Returns:
    the OAuth2Authorization.Builder
  - attribute
```
public OAuth2Authorization.Builder attribute(String name,
                                             Object value)
```
    Adds an attribute associated to the authorization.
    Parameters:
    name - the name of the attribute
    value - the value of the attribute
    Returns:
    the OAuth2Authorization.Builder
  - attributes
```
public OAuth2Authorization.Builder attributes(Consumer<Map<String,Object>> attributesConsumer)
```
    A Consumer of the attributes Map allowing the ability to add, replace, or remove.
    Parameters:
    attributesConsumer - a Consumer of the attributes Map
    Returns:
    the OAuth2Authorization.Builder
  - build
```
public OAuth2Authorization build()
```
    Builds a new OAuth2Authorization.
    Returns:
    the OAuth2Authorization

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method