org.pac4j.core.authorization.generator

Class FromAttributesAuthorizationGenerator<U extends CommonProfile>

java.lang.Object

org.pac4j.core.authorization.generator.FromAttributesAuthorizationGenerator<U>

All Implemented Interfaces:

AuthorizationGenerator<U>

public class FromAttributesAuthorizationGenerator<U extends CommonProfile>
extends java.lang.Object
implements AuthorizationGenerator<U>

Generate the authorization information by inspecting attributes.

The attributes containing the roles separated by the splitChar property (can be set through setSplitChar(String)) are defined in the constructor. It's the same for the attributes containing the permissions.

Since:

1.5.0

Author:

Jerome Leleu

Constructor Summary

Constructors

Constructor and Description
FromAttributesAuthorizationGenerator()
FromAttributesAuthorizationGenerator(java.util.Collection<java.lang.String> roleAttributes, java.util.Collection<java.lang.String> permissionAttributes)
FromAttributesAuthorizationGenerator(java.lang.String[] roleAttributes, java.lang.String[] permissionAttributes)

Method Summary

Modifier and Type	Method and Description
U	generate(WebContext context, U profile) Generate the authorization information from and for the user profile.
java.lang.String	getSplitChar()
void	setPermissionAttributes(java.lang.String permissionAttributesStr)
void	setRoleAttributes(java.lang.String roleAttributesStr)
void	setSplitChar(java.lang.String splitChar)

Methods inherited from class java.lang.Object

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

Constructor Detail

FromAttributesAuthorizationGenerator

public FromAttributesAuthorizationGenerator()

FromAttributesAuthorizationGenerator

public FromAttributesAuthorizationGenerator(java.util.Collection<java.lang.String> roleAttributes,
                                            java.util.Collection<java.lang.String> permissionAttributes)

FromAttributesAuthorizationGenerator

public FromAttributesAuthorizationGenerator(java.lang.String[] roleAttributes,
                                            java.lang.String[] permissionAttributes)

Method Detail

generate

public U generate(WebContext context,
                  U profile)

Description copied from interface: AuthorizationGenerator

Generate the authorization information from and for the user profile.

Specified by:

generate in interface AuthorizationGenerator<U extends CommonProfile>

Parameters:

context - the web context

profile - the user profile for which to generate the authorization information.

Returns:

the updated profile or a new one

getSplitChar

public java.lang.String getSplitChar()

setSplitChar

public void setSplitChar(java.lang.String splitChar)

setRoleAttributes

public void setRoleAttributes(java.lang.String roleAttributesStr)

setPermissionAttributes

public void setPermissionAttributes(java.lang.String permissionAttributesStr)