org.jasig.services.persondir.support
Class StubPersonAttributeDao

java.lang.Object
  org.jasig.services.persondir.support.StubPersonAttributeDao

All Implemented Interfaces:

IPersonAttributeDao

public class StubPersonAttributeDao
extends Object
implements IPersonAttributeDao

A stub IPersonAttributeDao to be used for testing. Backed by a single Map which this implementation will always return.

Configuration:

Property	Description	Required	Default
backingMap	This Map will always be returned for any query.	No	null

Since:

uPortal 2.5

Version:

$Revision: 2892 $ $Date: 2006-12-19 13:25:03 -0600 (Tue, 19 Dec 2006) $

Author:

andrew.petro@yale.edu

Constructor Summary

StubPersonAttributeDao()

StubPersonAttributeDao(Map backingMap)

Method Summary

Map	getBackingMap() Get the Map which this stub object will return for all legal invocations of attributesForUser()
Set	getPossibleUserAttributeNames() Gets a Set of attribute names that may be returned by the IPersonAttributeDao.getUserAttributes(Map).
Map	getUserAttributes(Map seed) Obtains a mutable Map from attribute names to values for the given query seed which is an immutable Map.
Map	getUserAttributes(String uid) This method uses a single attribute to get a Map of user attributes.
void	setBackingMap(Map backingMap) Set the Map which this stub object will return for all legal invocations of attributesForUser().

Methods inherited from class java.lang.Object

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

Constructor Detail

StubPersonAttributeDao

public StubPersonAttributeDao()

StubPersonAttributeDao

public StubPersonAttributeDao(Map backingMap)

Method Detail

getPossibleUserAttributeNames

public Set getPossibleUserAttributeNames()

Description copied from interface: IPersonAttributeDao

Gets a Set of attribute names that may be returned by the IPersonAttributeDao.getUserAttributes(Map). The names returned represent all possible names IPersonAttributeDao.getUserAttributes(Map) could return. If the dao doesn't have a way to know all possible attribute names this method should return null.
Returns an immutable Set.

Specified by:

getPossibleUserAttributeNames in interface IPersonAttributeDao

Returns:

A {link Set} of possible attribute names for user queries.

getUserAttributes

public Map getUserAttributes(Map seed)

Description copied from interface: IPersonAttributeDao

Obtains a mutable Map from attribute names to values for the given query seed which is an immutable Map. The values may be mutable objects but it is recommended that they be immutable.
For the returned Map; Keys must be String, Values can be any Object, they are typically Strings.
Values may also be multi-valued, in this case they are of type List and the list contents are the values of the attribute.
This method returns according to the following rules:

• If the user exists and has attributes a populated Map is returned.
• If the user exists and has no attributes an empty Map is returned.
• If the user doesn't exist null is returned.
• If an error occurs while getting the attributes the appropriate exception will be propagated.

Unless otherwise specified by an implementation the returned Map will not be a union of the seed and query results. If your are given a Map that includes the attribute "phone" and value "555-1212" and the returned Map contains the attribute "phone" with the value "555-1212", this means that your implementation also believes that the "phone" attribute should have this value.

Specified by:

getUserAttributes in interface IPersonAttributeDao

Parameters:

seed - immutable Map of attributes to values to seed the query

Returns:

Map from attribute names to values

getUserAttributes

public Map getUserAttributes(String uid)

Description copied from interface: IPersonAttributeDao

This method uses a single attribute to get a Map of user attributes.
This methods follows the same return rules as IPersonAttributeDao.getUserAttributes(Map)

Specified by:

getUserAttributes in interface IPersonAttributeDao

Parameters:

uid - The string to use as the value in the seed

Returns:

Map from attribute names to values

See Also:

IPersonAttributeDao.getUserAttributes(Map)

getBackingMap

public Map getBackingMap()

Get the Map which this stub object will return for all legal invocations of attributesForUser()

Returns:

Returns the backingMap.

setBackingMap

public void setBackingMap(Map backingMap)

Set the Map which this stub object will return for all legal invocations of attributesForUser().

Parameters:

backingMap - The backingMap to set, may not be null.