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

Class RoleBasedScopesIssuer

java.lang.Object

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

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

All Implemented Interfaces:

org.wso2.carbon.identity.oauth2.validators.scope.ScopeValidator

public class RoleBasedScopesIssuer
extends AbstractScopesIssuer
implements org.wso2.carbon.identity.oauth2.validators.scope.ScopeValidator

This class implements Scope Validator which represents the functions related to an scope issuer which issues scopes based on user roles.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHECK_ROLES_FROM_SAML_ASSERTION
protected boolean	rejectUnregisteredScopes
static String	RETRIEVE_ROLES_FROM_USERSTORE_FOR_SCOPE_VALIDATION

Constructor Summary

Constructors

Constructor and Description
RoleBasedScopesIssuer()

Method Summary

Modifier and Type	Method and Description
protected String	addDomainToName(String username, String domainName) Add domain to name
protected void	configureForJWTGrant(org.wso2.carbon.identity.oauth2.token.OAuthTokenReqMessageContext tokReqMsgCtx)
String	getName()
String	getPrefix() This method is used to get the prefix of the scope issuer.
protected String[]	getRolesFromAssertion(org.opensaml.saml.saml2.core.Assertion assertion) Get roles from assertion
List<String>	getScopes(org.wso2.carbon.identity.oauth2.authz.OAuthAuthzReqMessageContext oAuthAuthzReqMessageContext)
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.
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 Set<org.wso2.carbon.identity.oauth2.bean.Scope>	retrieveScopes(int tenantId)
boolean	validateScope(org.wso2.carbon.identity.oauth2.validators.OAuth2TokenValidationMessageContext oAuth2TokenValidationMessageContext)
boolean	validateScope(org.wso2.carbon.identity.oauth2.authz.OAuthAuthzReqMessageContext oAuthAuthzReqMessageContext)
boolean	validateScope(org.wso2.carbon.identity.oauth2.token.OAuthTokenReqMessageContext oAuthTokenReqMessageContext)

Methods inherited from class org.wso2.is.key.manager.core.tokenmgt.issuers.AbstractScopesIssuer

getAllowedScopes, getAppScopes, getCacheManager, getRealmService, getTenantIdOfUser, isAppScopesEmpty, isWhiteListedScope

Methods inherited from class java.lang.Object

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

Field Detail

CHECK_ROLES_FROM_SAML_ASSERTION

public static final String CHECK_ROLES_FROM_SAML_ASSERTION

See Also:

Constant Field Values

RETRIEVE_ROLES_FROM_USERSTORE_FOR_SCOPE_VALIDATION

public static final String RETRIEVE_ROLES_FROM_USERSTORE_FOR_SCOPE_VALIDATION

See Also:

Constant Field Values

rejectUnregisteredScopes

protected boolean rejectUnregisteredScopes

Constructor Detail

RoleBasedScopesIssuer

public RoleBasedScopesIssuer()

Method Detail

validateScope

public boolean validateScope(org.wso2.carbon.identity.oauth2.authz.OAuthAuthzReqMessageContext oAuthAuthzReqMessageContext)
                      throws org.wso2.carbon.identity.oauth2.IdentityOAuth2Exception

Specified by:

validateScope in interface org.wso2.carbon.identity.oauth2.validators.scope.ScopeValidator

Throws:

org.wso2.carbon.identity.oauth2.IdentityOAuth2Exception

validateScope

public boolean validateScope(org.wso2.carbon.identity.oauth2.token.OAuthTokenReqMessageContext oAuthTokenReqMessageContext)
                      throws org.wso2.carbon.identity.oauth2.IdentityOAuth2Exception

Specified by:

validateScope in interface org.wso2.carbon.identity.oauth2.validators.scope.ScopeValidator

Throws:

org.wso2.carbon.identity.oauth2.IdentityOAuth2Exception

validateScope

public boolean validateScope(org.wso2.carbon.identity.oauth2.validators.OAuth2TokenValidationMessageContext oAuth2TokenValidationMessageContext)
                      throws org.wso2.carbon.identity.oauth2.IdentityOAuth2Exception

Specified by:

validateScope in interface org.wso2.carbon.identity.oauth2.validators.scope.ScopeValidator

Throws:

org.wso2.carbon.identity.oauth2.IdentityOAuth2Exception

retrieveScopes

protected Set<org.wso2.carbon.identity.oauth2.bean.Scope> retrieveScopes(int tenantId)
                                                                  throws org.wso2.carbon.identity.oauth2.IdentityOAuth2ScopeServerException

Throws:

org.wso2.carbon.identity.oauth2.IdentityOAuth2ScopeServerException

getName

public String getName()

Specified by:

getName in interface org.wso2.carbon.identity.oauth2.validators.scope.ScopeValidator

getPrefix

public String getPrefix()

Description copied from class: AbstractScopesIssuer

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

Specified by:

getPrefix in class AbstractScopesIssuer

Returns:

returns the prefix with respect to an issuer.

getScopes

public List<String> getScopes(org.wso2.carbon.identity.oauth2.authz.OAuthAuthzReqMessageContext oAuthAuthzReqMessageContext)

getScopes

public 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.

Specified by:

getScopes in class AbstractScopesIssuer

Parameters:

scopeValidationCallback - Authorization callback to validate scopes

Returns:

authorized scopes list

getScopes

public 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.

Specified by:

getScopes in class AbstractScopesIssuer

Parameters:

tokReqMsgCtx - token message context

Returns:

authorized scopes list

addDomainToName

protected String addDomainToName(String username,
                                 String domainName)

Add domain to name

Parameters:

username - Username

domainName - domain name

Returns:

String

getRolesFromAssertion

protected String[] getRolesFromAssertion(org.opensaml.saml.saml2.core.Assertion assertion)

Get roles from assertion

Parameters:

assertion - Assertion

Returns:

String[]

configureForJWTGrant

protected void configureForJWTGrant(org.wso2.carbon.identity.oauth2.token.OAuthTokenReqMessageContext tokReqMsgCtx)