org.wso2.is.key.manager.core.tokenmgt.issuers

Class AbstractScopesIssuer

java.lang.Object

org.wso2.is.key.manager.core.tokenmgt.issuers.AbstractScopesIssuer

Direct Known Subclasses:

RoleBasedScopesIssuer

public abstract class AbstractScopesIssuer
extends Object

This abstract class represents the basic requirements of a scope issuer.

Constructor Summary

Constructors

Constructor and Description
AbstractScopesIssuer()

Method Summary

Modifier and Type	Method and Description
List<String>	getAllowedScopes(List<String> requestedScopes) Get the set of default scopes.
Map<String,String>	getAppScopes(String consumerKey, org.wso2.carbon.identity.application.authentication.framework.model.AuthenticatedUser authenticatedUser, List<String> requestedScopes) This method is used to get the application scopes including the scopes defined for the APIs subscribed to the application and the API-M REST API scopes set of the current tenant.
protected javax.cache.CacheManager	getCacheManager(String name) Get CacheManager instance
abstract String	getPrefix() This method is used to get the prefix of the scope issuer.
protected org.wso2.carbon.user.core.service.RealmService	getRealmService() Get RealmService
abstract List<String>	getScopes(org.wso2.carbon.identity.oauth.callback.OAuthCallback scopeValidationCallback) This method is used to retrieve authorized scopes with respect to an authorization callback.
abstract List<String>	getScopes(org.wso2.carbon.identity.oauth2.token.OAuthTokenReqMessageContext tokReqMsgCtx) This method is used to retrieve the authorized scopes with respect to a token.
protected int	getTenantIdOfUser(String username) Get tenant Id of the user
Boolean	isAppScopesEmpty(Map<String,String> appScopes, String clientId) This method is used to check if the application scope list empty.
boolean	isWhiteListedScope(List<String> scopeSkipList, String scope) Determines if the scope is specified in the whitelist.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractScopesIssuer

public AbstractScopesIssuer()

Method Detail

getScopes

public abstract List<String> getScopes(org.wso2.carbon.identity.oauth2.token.OAuthTokenReqMessageContext tokReqMsgCtx)

This method is used to retrieve the authorized scopes with respect to a token.

Parameters:

tokReqMsgCtx - token message context

Returns:

authorized scopes list

getScopes

public abstract List<String> getScopes(org.wso2.carbon.identity.oauth.callback.OAuthCallback scopeValidationCallback)

This method is used to retrieve authorized scopes with respect to an authorization callback.

Parameters:

scopeValidationCallback - Authorization callback to validate scopes

Returns:

authorized scopes list

getPrefix

public abstract String getPrefix()

This method is used to get the prefix of the scope issuer.

Returns:

returns the prefix with respect to an issuer.

getAllowedScopes

public List<String> getAllowedScopes(List<String> requestedScopes)

Get the set of default scopes. If a requested scope is matches with the patterns specified in the whitelist, then such scopes will be issued without further validation. If the scope list is empty, token will be issued for default scop1e.

Parameters:

requestedScopes - - The set of requested scopes

Returns:

- The subset of scopes that are allowed

isWhiteListedScope

public boolean isWhiteListedScope(List<String> scopeSkipList,
                                  String scope)

Determines if the scope is specified in the whitelist.

Parameters:

scope - - The scope key to check

Returns:

- 'true' if the scope is white listed. 'false' if not.

getAppScopes

public Map<String,String> getAppScopes(String consumerKey,
                                       org.wso2.carbon.identity.application.authentication.framework.model.AuthenticatedUser authenticatedUser,
                                       List<String> requestedScopes)

This method is used to get the application scopes including the scopes defined for the APIs subscribed to the application and the API-M REST API scopes set of the current tenant.

Parameters:

consumerKey - Consumer Key of the application

authenticatedUser - Authenticated User

Returns:

Application Scope List

isAppScopesEmpty

public Boolean isAppScopesEmpty(Map<String,String> appScopes,
                                String clientId)

This method is used to check if the application scope list empty.

Parameters:

appScopes - Application scopes list

clientId - Client ID of the application

Returns:

if the scopes list is empty

getCacheManager

protected javax.cache.CacheManager getCacheManager(String name)

Get CacheManager instance

Parameters:

name - The name of the Cache

Returns:

CacheManager

getRealmService

protected org.wso2.carbon.user.core.service.RealmService getRealmService()

Get RealmService

Returns:

RealmService

getTenantIdOfUser

protected int getTenantIdOfUser(String username)

Get tenant Id of the user

Parameters:

username - Username

Returns:

int