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 parameters.

Version:

$Id: UsernameSearchMapper.java 317 2019-03-09 21:26:28Z michael-o $

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
UsernameSearchMapper.MappedValues	map(DirContext context, GSSName gssName) Maps a GSS name to AD search parameters.

Method Detail

map

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

Maps a GSS name to AD search 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