net.sf.michaelo.tomcat.realm.mapper

Class UserPrincipalNameSearchMapper

java.lang.Object

net.sf.michaelo.tomcat.realm.mapper.UserPrincipalNameSearchMapper

All Implemented Interfaces:

UsernameSearchMapper

public class UserPrincipalNameSearchMapper
extends Object
implements UsernameSearchMapper

A mapper for the AD attribute userPrincipalName. This mapper maps the GSS name to the AD attribute userPrincipalName which by default contains the implicit UPN unless it's overwritten by the explicit (enterprise) UPN. In this case, the result will be empty. No assumption is made about the root DN set in the given context, so you can narrow down your search base if you like.

Version:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	UserPrincipalNameSearchMapper.UserPrincipalNameMappedValues

Nested classes/interfaces inherited from interface net.sf.michaelo.tomcat.realm.mapper.UsernameSearchMapper

UsernameSearchMapper.MappedValues

Constructor Summary

Constructors

Constructor and Description
UserPrincipalNameSearchMapper()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

UserPrincipalNameSearchMapper

public UserPrincipalNameSearchMapper()

Method Detail

map

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

Description copied from interface: UsernameSearchMapper

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.

Specified by:

map in interface UsernameSearchMapper

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