com.raritantechnologies.quickstart
Class SearchSourceUserInfoReader

java.lang.Object
  com.raritantechnologies.quickstart.SearchSourceUserInfoReader

All Implemented Interfaces:

IConfigurable, IUserInfoReader

public class SearchSourceUserInfoReader

extends java.lang.Object

implements IUserInfoReader

Reads User Information using an RTI SearchSource.

XML Configuration Template:

 <UserInfoReader class="com.raritantechnologies.quickstart.SearchSourceUserInfoReader" 
                    searchSource="[some search source]" 
                    userNameField="field for user name in source" 
                    userLoginField="[ (optional) alternate login name in user info ]"
                    userLevelField="where user level saved"
                    emailField="where the users email is saved"
                    defaultUserLevel="default if not set in config">

  <!-- Other query parameters (optional) -->
  <Query name="userGroup" value="superUsers" />

  <!-- Optional Map of user fields to session data cache -->
  <SessionDataMap>
    <Field ID="[ name of result field ]" sessionDataField="[ name of session data field ]" />

  </SessionDataMap>
 </UserInfoReader>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Constructor Summary

SearchSourceUserInfoReader()

Method Summary

ILoginInfo[]	getAllUserInfo()
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	readUserInfo(ILoginInfo userInfo) Reads user information from the SearchSource, adds attributes to the user info object.
void	setSessionCacheMap(java.util.Map sessionCacheMap)

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchSourceUserInfoReader

public SearchSourceUserInfoReader()

Method Detail

readUserInfo

public void readUserInfo(ILoginInfo userInfo)

Reads user information from the SearchSource, adds attributes to the user info object.

Specified by:

readUserInfo in interface IUserInfoReader

getAllUserInfo

public ILoginInfo[] getAllUserInfo()

Specified by:

getAllUserInfo in interface IUserInfoReader

setSessionCacheMap

public void setSessionCacheMap(java.util.Map sessionCacheMap)

Specified by:

setSessionCacheMap in interface IUserInfoReader

initialize

public void initialize(org.w3c.dom.Element elem)

Description copied from interface: IConfigurable

Initializes the object from an XML tag or element. This method is called by the Framework as part of the application initializtion. see ConfigurationManager, XMLConfigurationManager, XMLSearchFieldMapFactory, XMLSearchSourceFactory. Configurable objects that are owned or contained by other configurable objects will be initialized in by the parent object.

Specified by:

initialize in interface IConfigurable