org.apereo.services.persondir.support

Interface IUsernameAttributeProvider

All Known Implementing Classes:

SimpleUsernameAttributeProvider

public interface IUsernameAttributeProvider

Provider for the username attribute to use when one is not otherwise provided.

Author:

Eric Dalquist

Method Summary

Modifier and Type	Method and Description
java.lang.String	getUsernameAttribute()
java.lang.String	getUsernameFromQuery(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> query)

Method Detail

getUsernameAttribute

java.lang.String getUsernameAttribute()

Returns:

The username attribute to use when one is not otherwise provided, will never return null.

getUsernameFromQuery

java.lang.String getUsernameFromQuery(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> query)

Parameters:

query - The query map of attributes

Returns:

The username included in the query, determined using the username attribute. Returns null if no username attribute is included in the query.