Class DefaultOAuth2AuthorizationManagerFactory<T>

java.lang.Object

org.springframework.security.oauth2.core.authorization.DefaultOAuth2AuthorizationManagerFactory<T>

Type Parameters:

T - the type of object that the authorization check is being done on

All Implemented Interfaces:

OAuth2AuthorizationManagerFactory<T>

public final class DefaultOAuth2AuthorizationManagerFactory<T>
extends Object
implements OAuth2AuthorizationManagerFactory<T>

A factory for creating different kinds of AuthorizationManager instances.

Since:

7.1

Constructor Summary

Constructors

Constructor	Description
DefaultOAuth2AuthorizationManagerFactory()
DefaultOAuth2AuthorizationManagerFactory(AuthorizationManagerFactory<T> authorizationManagerFactory)

Method Summary

Modifier and Type	Method	Description
AuthorizationManager<T>	hasAllScopes(String... scopes)	Create an AuthorizationManager that requires an Authentication to have all authorities SCOPE_scope1, SCOPE_scope2, ...
AuthorizationManager<T>	hasAnyScope(String... scopes)	Create an AuthorizationManager that requires an Authentication to have at least one authority among SCOPE_scope1, SCOPE_scope2, ...
AuthorizationManager<T>	hasScope(String scope)	Create an AuthorizationManager that requires an Authentication to have a SCOPE_scope authority.
void	setScopePrefix(String scopePrefix)	Sets the prefix used to create an authority name from a scope name.

Methods inherited from class Object

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

Constructor Details

DefaultOAuth2AuthorizationManagerFactory

public DefaultOAuth2AuthorizationManagerFactory()

DefaultOAuth2AuthorizationManagerFactory

public DefaultOAuth2AuthorizationManagerFactory(AuthorizationManagerFactory<T> authorizationManagerFactory)

Method Details

setScopePrefix

public void setScopePrefix(String scopePrefix)

Sets the prefix used to create an authority name from a scope name. Can be an empty string.

Parameters:

scopePrefix - the scope prefix to use

hasScope

public AuthorizationManager<T> hasScope(String scope)

Description copied from interface: OAuth2AuthorizationManagerFactory

Create an AuthorizationManager that requires an Authentication to have a SCOPE_scope authority.

For example, if you call hasScope("read"), then this will require that each authentication have a GrantedAuthority whose value is SCOPE_read.

This would equivalent to calling AuthorityAuthorizationManager#hasAuthority("SCOPE_read").

Specified by:

hasScope in interface OAuth2AuthorizationManagerFactory<T>

Parameters:

scope - the scope value to require

Returns:

an AuthorizationManager that requires a "SCOPE_scope" authority

hasAnyScope

public AuthorizationManager<T> hasAnyScope(String... scopes)

Description copied from interface: OAuth2AuthorizationManagerFactory

Create an AuthorizationManager that requires an Authentication to have at least one authority among SCOPE_scope1, SCOPE_scope2, ... SCOPE_scopeN.

For example, if you call hasAnyScope("read", "write"), then this will require that each authentication have at least a GrantedAuthority whose value is either SCOPE_read or SCOPE_write.

This would equivalent to calling AuthorityAuthorizationManager#hasAnyAuthority("SCOPE_read", "SCOPE_write").

Specified by:

hasAnyScope in interface OAuth2AuthorizationManagerFactory<T>

Parameters:

scopes - the scope values to allow

Returns:

an AuthorizationManager that requires at least one authority among "SCOPE_scope1", SCOPE_scope2, ... SCOPE_scopeN.

hasAllScopes

public AuthorizationManager<T> hasAllScopes(String... scopes)

Description copied from interface: OAuth2AuthorizationManagerFactory

Create an AuthorizationManager that requires an Authentication to have all authorities SCOPE_scope1, SCOPE_scope2, ... SCOPE_scopeN.

For example, if you call hasAllScopes("read", "write"), then each Authentication must have all GrantedAuthority values of SCOPE_read and SCOPE_write.

This would be equivalent to calling AllAuthoritiesAuthorizationManager#hasAllAuthorities("SCOPE_read", "SCOPE_write").

Specified by:

hasAllScopes in interface OAuth2AuthorizationManagerFactory<T>

Parameters:

scopes - the scope values to require

Returns:

an AuthorizationManager that requires all authorities SCOPE_scope1, SCOPE_scope2, ... SCOPE_scopeN.