org.springframework.cloud.common.security

Class ProviderRoleMapping

java.lang.Object

org.springframework.cloud.common.security.ProviderRoleMapping

public class ProviderRoleMapping
extends Object

Holds configuration for the authorization aspects of security.

Author:

Gunnar Hillert

Constructor Summary

Constructors

Constructor and Description
ProviderRoleMapping()
ProviderRoleMapping(boolean mapOauthScopes)
ProviderRoleMapping(boolean mapOauthScopes, Map<String,String> roleMappings)

Method Summary

Modifier and Type	Method and Description
ProviderRoleMapping	addRoleMapping(String oauthScope, String roleName)
Map<CoreSecurityRoles,String>	convertGroupMappingKeysToCoreSecurityRoles()
Map<CoreSecurityRoles,String>	convertRoleMappingKeysToCoreSecurityRoles()
String	getGroupClaim()
Map<String,String>	getGroupMappings()
String	getOauthScopePrefix()
String	getPrincipalClaimName()
Map<String,String>	getRoleMappings() When using OAuth2 with enabled setMapOauthScopes(boolean), you can optionally specify a custom mapping of OAuth scopes to role names as they exist in the Data Flow application.
String	getRolePrefix()
boolean	isMapGroupClaims()
boolean	isMapOauthScopes()
boolean	isParseOauthScopePathParts()
void	setGroupClaim(String groupClaim)
void	setGroupMappings(Map<String,String> groupMappings)
void	setMapGroupClaims(boolean mapGroupClaims)
void	setMapOauthScopes(boolean mapOauthScopes) If set to true, Oauth scopes will be mapped to corresponding Data Flow roles.
void	setOauthScopePrefix(String oauthScopePrefix)
void	setParseOauthScopePathParts(boolean parseOauthScopePathParts) Sets whether or not to treat OAuth scopes as URIs during the role mapping.
void	setPrincipalClaimName(String principalClaimName)
void	setRolePrefix(String rolePrefix) Sets the prefix which should be added to the authority name (if it doesn't already exist).

Methods inherited from class java.lang.Object

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

Constructor Detail

ProviderRoleMapping

public ProviderRoleMapping()

ProviderRoleMapping

public ProviderRoleMapping(boolean mapOauthScopes)

ProviderRoleMapping

public ProviderRoleMapping(boolean mapOauthScopes,
                           Map<String,String> roleMappings)

Method Detail

isParseOauthScopePathParts

public boolean isParseOauthScopePathParts()

setParseOauthScopePathParts

public void setParseOauthScopePathParts(boolean parseOauthScopePathParts)

Sets whether or not to treat OAuth scopes as URIs during the role mapping. When set to true the OAuth scope will be treated as a URI and the leading part will be ignored (eg. 'api://dataflow-server/dataflow.create' will result in 'dataflow.create'). When set to false the OAuth scope will be used as-is. This is useful in cases where the scope is not a URI and contains '/' leading characters.

Parameters:

parseOauthScopePathParts - whether or not to treat OAuth scopes as URIs during the role mapping

isMapOauthScopes

public boolean isMapOauthScopes()

setMapOauthScopes

public void setMapOauthScopes(boolean mapOauthScopes)

If set to true, Oauth scopes will be mapped to corresponding Data Flow roles. Otherwise, if set to false, or not set at all, all roles will be assigned to users.

Parameters:

mapOauthScopes - If not set defaults to false

isMapGroupClaims

public boolean isMapGroupClaims()

setMapGroupClaims

public void setMapGroupClaims(boolean mapGroupClaims)

getRoleMappings

public Map<String,String> getRoleMappings()

When using OAuth2 with enabled setMapOauthScopes(boolean), you can optionally specify a custom mapping of OAuth scopes to role names as they exist in the Data Flow application. If not set, then the OAuth scopes themselves must match the role names:

• MANAGE = dataflow.manage
• VIEW = dataflow.view
• CREATE = dataflow.create

Returns:

Optional (May be null). Returns a map of scope-to-role mappings.

addRoleMapping

public ProviderRoleMapping addRoleMapping(String oauthScope,
                                          String roleName)

getGroupMappings

public Map<String,String> getGroupMappings()

setGroupMappings

public void setGroupMappings(Map<String,String> groupMappings)

getGroupClaim

public String getGroupClaim()

setGroupClaim

public void setGroupClaim(String groupClaim)

getPrincipalClaimName

public String getPrincipalClaimName()

setPrincipalClaimName

public void setPrincipalClaimName(String principalClaimName)

convertGroupMappingKeysToCoreSecurityRoles

public Map<CoreSecurityRoles,String> convertGroupMappingKeysToCoreSecurityRoles()

convertRoleMappingKeysToCoreSecurityRoles

public Map<CoreSecurityRoles,String> convertRoleMappingKeysToCoreSecurityRoles()

Returns:

Map containing the CoreSecurityRoles as key and the associated role name (String) as value.

setRolePrefix

public void setRolePrefix(String rolePrefix)

Sets the prefix which should be added to the authority name (if it doesn't already exist).

Parameters:

rolePrefix - Must not be null

getOauthScopePrefix

public String getOauthScopePrefix()

setOauthScopePrefix

public void setOauthScopePrefix(String oauthScopePrefix)

Parameters:

oauthScopePrefix - Must not be null

getRolePrefix

public String getRolePrefix()