Package org.keycloak.services.util

Class AuthorizationContextUtil

java.lang.Object

org.keycloak.services.util.AuthorizationContextUtil

public class AuthorizationContextUtil
extends Object

Author:

Daniel Gozalo Util class to unify a way to obtain the AuthorizationRequestContext.

As it can be obtained statically from just the OAuth2 scopes parameter, it can be easily referenced from almost anywhere.

Constructor Summary

Constructors

Constructor	Description
AuthorizationContextUtil()

Method Summary

Modifier and Type	Method	Description
static AuthorizationRequestContext	getAuthorizationRequestContextFromScopes(KeycloakSession session, String scope)	Base function to obtain a bare AuthorizationRequestContext with just OAuth2 Scopes
static AuthorizationRequestContext	getAuthorizationRequestContextFromScopesWithClient(KeycloakSession session, String scope)	An extension of getAuthorizationRequestContextFromScopes(org.keycloak.models.KeycloakSession, java.lang.String) that appends the current context's client
static Stream<AuthorizationDetails>	getAuthorizationRequestsStreamFromScopesWithClient(KeycloakSession session, String scope)	An extension of {@link AuthorizationContextUtil#getAuthorizationRequestContextFromScopesWithClient)} that returns the list as a Stream
static Stream<ClientScopeModel>	getClientScopesStreamFromAuthorizationRequestContextWithClient(KeycloakSession session, String scope)	Helper method to return a Stream of all the ClientScopeModel in the current AuthorizationRequestContext

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthorizationContextUtil

public AuthorizationContextUtil()

Method Detail

getAuthorizationRequestContextFromScopes

public static AuthorizationRequestContext getAuthorizationRequestContextFromScopes(KeycloakSession session,
                                                                                   String scope)

Base function to obtain a bare AuthorizationRequestContext with just OAuth2 Scopes

Parameters:

session -

scope -

Returns:

an AuthorizationRequestContext with scope entries

getAuthorizationRequestContextFromScopesWithClient

public static AuthorizationRequestContext getAuthorizationRequestContextFromScopesWithClient(KeycloakSession session,
                                                                                             String scope)

An extension of getAuthorizationRequestContextFromScopes(org.keycloak.models.KeycloakSession, java.lang.String) that appends the current context's client

Parameters:

session -

scope -

Returns:

an AuthorizationRequestContext with scope entries and a ClientModel

getAuthorizationRequestsStreamFromScopesWithClient

public static Stream<AuthorizationDetails> getAuthorizationRequestsStreamFromScopesWithClient(KeycloakSession session,
                                                                                              String scope)

An extension of {@link AuthorizationContextUtil#getAuthorizationRequestContextFromScopesWithClient)} that returns the list as a Stream

Parameters:

session -

scope -

Returns:

a Stream of AuthorizationDetails containing a ClientModel

getClientScopesStreamFromAuthorizationRequestContextWithClient

public static Stream<ClientScopeModel> getClientScopesStreamFromAuthorizationRequestContextWithClient(KeycloakSession session,
                                                                                                      String scope)

Helper method to return a Stream of all the ClientScopeModel in the current AuthorizationRequestContext

Parameters:

session -

scope -

Returns:

see description