com.raritantechnologies.federated.eRoom
Class ERoomUserMonitor

java.lang.Object
  com.raritantechnologies.federated.eRoom.ERoomUserMonitor

All Implemented Interfaces:

IConfigurable

Direct Known Subclasses:

CompositeERoomUserMonitor, FileERoomUserMonitor

public class ERoomUserMonitor

extends java.lang.Object

implements IConfigurable

Creates a list of users and the eRooms that they have access to.

XML Configuration Template:

   <ERoomUserMonitor class="com.raritantechnologies.federated.eRoom.ERoomUserMonitor"
                        eRoomServerURL="[ URL to the eRoom Server - http(s)://[host:port]/eRoomXML/Facilities ]"
                        adminUser="[ name of user with admin privileges ]"
                        adminPW="[ admin user password ]"
                        useFullPath="[ true(default)|false - use the full eRoom URL path for the eRoom name ]" />
 

Field Summary

protected boolean

useFullPath

Constructor Summary

ERoomUserMonitor()

ERoomUserMonitor(java.util.Properties initProperties)

ERoomUserMonitor(java.lang.String eRoomServerURL, java.lang.String adminUser, java.lang.String adminPW, long interval, java.lang.String useFullPath, java.lang.String filePath)

ERoomUserMonitor(java.lang.String eRoomServerURL, java.lang.String adminUser, java.lang.String adminPW, java.lang.String useFullPath)

ERoomUserMonitor(java.lang.String eRoomServerURL, java.lang.String adminUser, java.lang.String adminPW, java.lang.String useFullPath, java.lang.String filePath)

Method Summary

java.lang.String	getUserERooms(java.lang.String userLoginName) Returns a comma separated list of ERooms that a user can access.
java.util.Iterator	getUsers()
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
static void	main(java.lang.String[] args) main method: use to create a file output of user list for an eRoom Server.
void	stopUpdates()

Methods inherited from class java.lang.Object

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

Field Detail

useFullPath

protected boolean useFullPath

Constructor Detail

ERoomUserMonitor

public ERoomUserMonitor()

ERoomUserMonitor

public ERoomUserMonitor(java.util.Properties initProperties)

ERoomUserMonitor

public ERoomUserMonitor(java.lang.String eRoomServerURL,
                        java.lang.String adminUser,
                        java.lang.String adminPW,
                        java.lang.String useFullPath)

ERoomUserMonitor

public ERoomUserMonitor(java.lang.String eRoomServerURL,
                        java.lang.String adminUser,
                        java.lang.String adminPW,
                        java.lang.String useFullPath,
                        java.lang.String filePath)

ERoomUserMonitor

public ERoomUserMonitor(java.lang.String eRoomServerURL,
                        java.lang.String adminUser,
                        java.lang.String adminPW,
                        long interval,
                        java.lang.String useFullPath,
                        java.lang.String filePath)

Method Detail

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

getUserERooms

public java.lang.String getUserERooms(java.lang.String userLoginName)

Returns a comma separated list of ERooms that a user can access.

getUsers

public java.util.Iterator getUsers()

stopUpdates

public void stopUpdates()

main

public static void main(java.lang.String[] args)

main method: use to create a file output of user list for an eRoom Server.