org.fcrepo.auth.common

Class ContainerRolesPrincipalProvider

java.lang.Object

org.fcrepo.auth.common.ContainerRolesPrincipalProvider

All Implemented Interfaces:

PrincipalProvider

public class ContainerRolesPrincipalProvider
extends Object
implements PrincipalProvider

Adds principals based on roles that are configured within the container and through a PrincipalProvider bean in the project.

Author:

Kevin S. Clarke

See Also:

PrincipalProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ContainerRolesPrincipalProvider.ContainerRolesPrincipal

Constructor Summary

Constructors

Constructor and Description
ContainerRolesPrincipalProvider()

Method Summary

Methods

Modifier and Type	Method and Description
Set<Principal>	getPrincipals(javax.jcr.Credentials credentials) Extract principals from the provided credentials.
void	setRoleNames(Set<String> roleNames) Sets the role names which have been configured in the repo.xml file.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContainerRolesPrincipalProvider

public ContainerRolesPrincipalProvider()

Method Detail

setRoleNames

public void setRoleNames(Set<String> roleNames)

Sets the role names which have been configured in the repo.xml file.

Parameters:

roleNames - The names of container roles that should be recognized as principals

getPrincipals

public Set<Principal> getPrincipals(javax.jcr.Credentials credentials)

Description copied from interface: PrincipalProvider

Extract principals from the provided credentials.

If no principals can be extracted, for example because the credentials are of a different type than expected, implementations of this method should return the empty set rather than null.

Specified by:

getPrincipals in interface PrincipalProvider

Parameters:

credentials - the credentials

Returns:

a set of security principals