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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	UserPrincipalNameSearchMapper.UserPrincipalNameMappedValues

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

UsernameSearchMapper.MappedValues

Field Summary

Fields

Modifier and Type	Field	Description
protected static Oid	KRB5_NT_ENTERPRISE_PRINCIPAL
protected static Oid	KRB5_NT_PRINCIPAL
protected static Oid	MS_UPN

Constructor Summary

Constructors

Constructor	Description
UserPrincipalNameSearchMapper()

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.

Methods inherited from class java.lang.Object

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

Field Detail

KRB5_NT_PRINCIPAL

protected static final Oid KRB5_NT_PRINCIPAL

KRB5_NT_ENTERPRISE_PRINCIPAL

protected static final Oid KRB5_NT_ENTERPRISE_PRINCIPAL

MS_UPN

protected static final Oid MS_UPN

Constructor Detail

UserPrincipalNameSearchMapper

public UserPrincipalNameSearchMapper()

Method Detail

getSupportedStringNameTypes

public Oid[] getSupportedStringNameTypes()

Description copied from interface: UsernameSearchMapper

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

Specified by:

getSupportedStringNameTypes in interface UsernameSearchMapper

Returns:

supported string name type OIDs

supportsGssName

public boolean supportsGssName(GSSName gssName)

Description copied from interface: UsernameSearchMapper

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

Specified by:

supportsGssName in interface UsernameSearchMapper

Parameters:

gssName - the gssName to test

Returns:

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

map

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

Description copied from interface: UsernameSearchMapper

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.

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