Package net.sf.michaelo.tomcat.realm.mapper

Interface UsernameSearchMapper

All Known Implementing Classes:

SamAccountNameMapper, SamAccountNameRfc2247Mapper, UserPrincipalNameSearchMapper

public interface UsernameSearchMapper

A mapper interface (strategy pattern) for translating GSS names to Active Directory search space parameters.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	UsernameSearchMapper.MappedValues	Mapped values holder.

Method Summary

Modifier and Type	Method	Description
Oid[]	getSupportedStringNameTypes()	Returns an array of name type OIDs which a mapper is able to map into AD search space.
UsernameSearchMapper.MappedValues	map(DirContext context, GSSName gssName)	Maps a GSS name to AD search space parameters.
boolean	supportsGssName(GSSName gssName)	Determines whether a mapper is able to map a given GSS name into AD search space.

Method Details

getSupportedStringNameTypes

Oid[] getSupportedStringNameTypes()

Returns an array of name type OIDs which a mapper is able to map into AD search space.

Returns:

supported string name type OIDs

supportsGssName

boolean supportsGssName(GSSName gssName)

Determines whether a mapper is able to map a given GSS name into AD search space.

Parameters:

gssName - the gssName to test

Returns:

if this mapper is able to map a name, false otherwise

map

UsernameSearchMapper.MappedValues map(DirContext context,
 GSSName gssName)
                               throws NamingException

Maps a GSS name to AD search space parameters. A mapper implementation must assure that the user can be found in the given context when an approriate GSS name is presented. The implementor must be aware that the returned search base might need to be relativized to the root DN of the context.

Parameters:

context - the search context

gssName - the GSS name to be mapped

Returns:

mapped values for user retrieval

Throws:

NamingException - if a context-related error has occured

IllegalArgumentException - if the GSS name is not supported