org.apache.geronimo.security.jacc
Interface RoleMappingConfiguration

All Superinterfaces:

javax.security.jacc.PolicyConfiguration

All Known Subinterfaces:

GeronimoPolicyConfiguration

All Known Implementing Classes:

PolicyConfigurationEJB, PolicyConfigurationGeneric, PolicyConfigurationWeb

public interface RoleMappingConfiguration

extends javax.security.jacc.PolicyConfiguration

The methods of this interface are used by containers to create role mappings in a Policy provider. An object that implements the RoleMappingConfiguration interface provides the role mapping configuration interface for a corresponding policy context within the corresponding Policy provider.

Geronimo will obtain an instance of this class by calling PolicyConfigurationFactory.getPolicyConfiguration. If the object that is returned also implements RoleMappingConfiguration, Geronimo will call the methods of that interface to provide role mappings to the Policy provider

Version:

$Revision: 1.3 $ $Date: 2004/03/10 09:59:25 $

See Also:

PolicyConfiguration, PolicyConfigurationFactory.getPolicyConfiguration(java.lang.String, boolean)

Method Summary

void	addRoleMapping(String role, Collection principals) Add a mapping from a module's security roles to physical principals.

Methods inherited from interface javax.security.jacc.PolicyConfiguration

addToExcludedPolicy, addToExcludedPolicy, addToRole, addToRole, addToUncheckedPolicy, addToUncheckedPolicy, commit, delete, getContextID, inService, linkConfiguration, removeExcludedPolicy, removeRole, removeUncheckedPolicy

Method Detail

addRoleMapping

public void addRoleMapping(String role,
                           Collection principals)
                    throws javax.security.jacc.PolicyContextException

Add a mapping from a module's security roles to physical principals. Mapping principals to the same role twice will cause a PolicyContextException to be thrown.

Parameters:

role - The role that is to be mapped to a set of principals.

principals - The set of principals that are to be mapped to to role.

Throws:

javax.security.jacc.PolicyContextException - if the mapping principals to the same role twice occurs.