org.jboss.security.mapping

Interface MappingProvider<T>

Type Parameters:

T -

All Known Implementing Classes:

AbstractPrincipalMappingProvider, AbstractRolesMappingProvider, DatabaseRolesMappingProvider, DefaultAttributeMappingProvider, DeploymentRolesMappingProvider, DeploymentRoleToRolesMappingProvider, LdapAttributeMappingProvider, LdapRolesMappingProvider, OptionsRoleMappingProvider, PropertiesRolesMappingProvider, SimplePrincipalMappingProvider, SimpleRolesMappingProvider, STSGroupMappingProvider, STSPrincipalMappingProvider, SubjectCNMapper, SubjectDNMapper

public interface MappingProvider<T>

A provider with mapping functionality

Since:

Aug 24, 2006

Version:

$Revision$

Author:

Anil Saldhana

Method Summary

Methods

Modifier and Type	Method and Description
void	init(Map<String,Object> options) Initialize the provider with the configured module options
void	performMapping(Map<String,Object> map, T mappedObject) Map the passed object
void	setMappingResult(MappingResult<T> result) Injected by the MappingContext
boolean	supports(Class<?> p) Whether this mapping provider supports mapping T

Method Detail

init

void init(Map<String,Object> options)

Initialize the provider with the configured module options

Parameters:

options -

performMapping

void performMapping(Map<String,Object> map,
                  T mappedObject)

Map the passed object

Parameters:

map - A read-only contextual map that can provide information to the provider

mappedObject - an Object on which the mapping will be applied

Throws:

IllegalArgumentException - if the mappedObject is not understood by the provider.

setMappingResult

void setMappingResult(MappingResult<T> result)

Injected by the MappingContext

Parameters:

result -

supports

boolean supports(Class<?> p)

Whether this mapping provider supports mapping T

Parameters:

t -

Returns: