|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.services.PersonDirectory
public class PersonDirectory
PersonDirectory is a static lookup mechanism for a singleton instance of IPersonAttributeDao. It is configurable via a Spring beans.dtd compliant configuration file in the properties directory called personDirectory.xml (as referenced by applicationContext.xml - that is, you could choose to declare the underlying IPersonAttributesDao backing your PersonDirectory directly in applicationContext.xml, or elsewhere. PersonDirectory looks for an IPersonAttributeDao instance named 'personAttributeDao'. This class serves as the lookup mechanism for clients to obtain a reference to the singleton IPersonAttributeDao instance. Via legacy methods, PersonDirectory also serves as the interface by which client code accesses user attributes. These deprecated legacy methods are a facade to the PersonAttributeDao. The default configuration of that file implements the legacy behavior of using the PersonDirs.xml file for configuration. It is expected that PersonDirs.xml offers the flexibility necessary to support most uPortal installations.
Field Summary | |
---|---|
private IPersonAttributeDao |
impl
Wrapped class which provides the functionality |
private static PersonDirectory |
instance
Singleton reference to PersonDirectory |
private static org.apache.commons.logging.Log |
log
|
private static java.lang.String |
PADAO_BEAN_NAME
|
static java.util.HashSet |
propertynames
Deprecated. you cannot get the list of attributes in the abstract, only for a particular user. |
Constructor Summary | |
---|---|
private |
PersonDirectory(IPersonAttributeDao impl)
Private constructor to allow for singleton behavior. |
Method Summary | |
---|---|
static IPersonAttributeDao |
getPersonAttributeDao()
Static lookup for a the configured IPersonAttributeDao
implementation available from PortalApplicationContextFacade. |
static java.util.Iterator |
getPropertyNamesIterator()
Deprecated. Use IPersonAttributeDao.getPossibleUserAttributeNames() |
static RestrictedPerson |
getRestrictedPerson(java.lang.String uid)
Deprecated. Use PersonFactory.createRestrictedPerson() and
IPersonAttributeDao.getUserAttributes(String) and
RestrictedPerson.setAttributes(Map) |
java.util.Hashtable |
getUserDirectoryInformation(java.lang.String username)
Deprecated. Use IPersonAttributeDao.getUserAttributes(String) |
void |
getUserDirectoryInformation(java.lang.String uid,
IPerson person)
Deprecated. Use IPersonAttributeDao.getUserAttributes(String) and
IPerson.setAttributes(Map) |
static PersonDirectory |
instance()
Deprecated. Use getPersonAttributeDao() |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private static final java.lang.String PADAO_BEAN_NAME
private static final org.apache.commons.logging.Log log
public static java.util.HashSet propertynames
private static PersonDirectory instance
private IPersonAttributeDao impl
Constructor Detail |
---|
private PersonDirectory(IPersonAttributeDao impl)
impl
- The IPersonAttributeDao
instance to wrap.Method Detail |
---|
public static IPersonAttributeDao getPersonAttributeDao()
IPersonAttributeDao
implementation available from PortalApplicationContextFacade.
IPersonAttributeDao
implementation.
java.lang.IllegalStateException
- - if PortalApplicationContextFacade does not
supply the IPersonAttributeDao instance.public static PersonDirectory instance()
getPersonAttributeDao()
public static java.util.Iterator getPropertyNamesIterator()
IPersonAttributeDao.getPossibleUserAttributeNames()
public static RestrictedPerson getRestrictedPerson(java.lang.String uid)
PersonFactory.createRestrictedPerson()
and
IPersonAttributeDao.getUserAttributes(String)
and
RestrictedPerson.setAttributes(Map)
uid
- the user ID
public java.util.Hashtable getUserDirectoryInformation(java.lang.String username)
IPersonAttributeDao.getUserAttributes(String)
username
- the name of the user
public void getUserDirectoryInformation(java.lang.String uid, IPerson person)
IPersonAttributeDao.getUserAttributes(String)
and
IPerson.setAttributes(Map)
uid
- person for whom we are obtaining attributesperson
- person object into which to store the attributes
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |