org.springframework.security.oauth2.core.authentication

Class OAuth2AuthenticationContext

java.lang.Object

org.springframework.security.oauth2.core.authentication.OAuth2AuthenticationContext

All Implemented Interfaces:

Context

Direct Known Subclasses:

OAuth2AuthorizationConsentAuthenticationContext, OidcUserInfoAuthenticationContext

public class OAuth2AuthenticationContext
extends java.lang.Object
implements Context

A context that holds an Authentication and (optionally) additional information.

Since:

0.2.0

See Also:

Context

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	OAuth2AuthenticationContext.AbstractBuilder<T extends OAuth2AuthenticationContext,B extends OAuth2AuthenticationContext.AbstractBuilder<T,B>> A builder for subclasses of OAuth2AuthenticationContext.

Constructor Summary

Constructors

Constructor and Description
OAuth2AuthenticationContext(org.springframework.security.core.Authentication authentication, java.util.Map<java.lang.Object,java.lang.Object> context) Constructs an OAuth2AuthenticationContext using the provided parameters.
OAuth2AuthenticationContext(java.util.Map<java.lang.Object,java.lang.Object> context) Constructs an OAuth2AuthenticationContext using the provided parameters.

Method Summary

Modifier and Type	Method and Description
<V> V	get(java.lang.Object key) Returns the value of the attribute associated to the key.
<T extends org.springframework.security.core.Authentication> T	getAuthentication() Returns the Authentication associated to the context.
boolean	hasKey(java.lang.Object key) Returns true if an attribute associated to the key exists, false otherwise.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.security.oauth2.core.context.Context

get

Constructor Detail

OAuth2AuthenticationContext

public OAuth2AuthenticationContext(org.springframework.security.core.Authentication authentication,
                                   @Nullable
                                   java.util.Map<java.lang.Object,java.lang.Object> context)

Constructs an OAuth2AuthenticationContext using the provided parameters.

Parameters:

authentication - the Authentication

context - a Map of additional context information

OAuth2AuthenticationContext

public OAuth2AuthenticationContext(java.util.Map<java.lang.Object,java.lang.Object> context)

Constructs an OAuth2AuthenticationContext using the provided parameters.

Parameters:

context - a Map of context information, must contain the Authentication

Since:

0.2.1

Method Detail

getAuthentication

public <T extends org.springframework.security.core.Authentication> T getAuthentication()

Returns the Authentication associated to the context.

Type Parameters:

T - the type of the Authentication

Returns:

the Authentication

get

@Nullable
public <V> V get(java.lang.Object key)

Description copied from interface: Context

Returns the value of the attribute associated to the key.

Specified by:

get in interface Context

Type Parameters:

V - the type of the value for the attribute

Parameters:

key - the key for the attribute

Returns:

the value of the attribute associated to the key, or null if not available

hasKey

public boolean hasKey(java.lang.Object key)

Description copied from interface: Context

Returns true if an attribute associated to the key exists, false otherwise.

Specified by:

hasKey in interface Context

Parameters:

key - the key for the attribute

Returns:

true if an attribute associated to the key exists, false otherwise