com.raritantechnologies.federated.eRoom
Class ERoomUtils

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

public class ERoomUtils

extends java.lang.Object

Static method class that executes some common data extraction methods for EMC eRooms.

Field Summary

static java.lang.String	eRoomMembersReq
static java.lang.String	getCoordinatorsRequest
static java.lang.String	getERoomRequestHead
static java.lang.String	getERoomRequestHeadTemplate
static java.lang.String	getERoomRequestTail

Constructor Summary

ERoomUtils()

Method Summary

static java.lang.String	getBaseURL(java.lang.String eRoomURL) Given a full eRoomURL returns the base part (up to the eRoom Name): e.g.
static java.lang.String	getBaseURL(java.lang.String eRoomURL, boolean createXMLURL)
static java.util.HashMap	getDescendentList(org.w3c.dom.Element contextNode, java.lang.String parentXPath, java.lang.String parentNamePath, java.lang.String toMemberCoordinators) Creates a HashMap of ERoom data.
static java.lang.String	getDocumentPath(java.lang.String eRoomURL) Given a full eRoom URL, returns the document path /[eroom name]/[ document path ]/item_id
static ERoom	getERoom(java.lang.String eRoomFacilityURI, java.lang.String eRoomURLName, java.lang.String[] rmAttributes, java.lang.String adminUser, java.lang.String adminPw, boolean getMembers, java.lang.String memberTags) Returns a metadata object that represents an eRoom.
static java.lang.String[]	getERoomCoordinators(java.lang.String pERoomURL, int refreshIvl, java.lang.String adminUser, java.lang.String adminPw)
static java.lang.String[]	getERoomCoordinators(java.lang.String pERoomURL, int refreshIvl, java.lang.String adminUser, java.lang.String adminPw, java.lang.String nameFormat)
static java.lang.String[]	getERoomCoordinators(java.lang.String eRoomURL, java.lang.String adminUser, java.lang.String adminPw) Returns a list of ERoom Coordinators for the given eRoomURL: [eRoomServerURL]/Facilities/[eRoom name]
static java.util.Map	getERoomFacilityMap(java.lang.String eRoomServerURL, java.lang.String adminUser, java.lang.String adminPw) returns a map of Facility Name --> List of ERooms in the Facility.
static java.util.Map	getERoomFacilityMap(java.lang.String eRoomServerURL, java.lang.String adminUser, java.lang.String adminPw, java.lang.String eRoomField)
static java.util.List	getERoomFacilityNames(java.lang.String eRoomServerURL, java.lang.String adminUser, java.lang.String adminPw) Returns a list of the Facilities in an eRoom Server.
static java.util.List	getERoomFieldList(java.lang.String facility, java.lang.String eRoomServerURL, java.lang.String adminUser, java.lang.String adminPw, java.lang.String eRoomField) returns a list of eRooms given an eRoom field (e.g.
static java.lang.String	getERoomItemURL(java.lang.String facilitiesURL) translates facility XML: http://[eroom host]/eRoomXML/Facilites/[facility name]/[eRoom name] to eRoom url: http://[eroom host]/eRoom/[facility name]/[eroom name]
static java.util.List	getERoomNameList(java.lang.String facility, java.lang.String eRoomServerURL, java.lang.String adminUser, java.lang.String adminPw) Returns a list of eRooms names in an eRoom Facility.
static ERoom[]	getERooms(java.lang.String eRoomServerURL, int refreshIvl, java.lang.String adminUser, java.lang.String adminPw, java.lang.String roomAttributes, boolean getMembers, java.lang.String memberTags) Returns a list of ERooms in an eRoom server.
static java.util.HashMap	getERoomSourceData(java.lang.String DEFAULT_FACILITY, java.lang.String facilityURI, ILoginInfo userInfo)
static java.lang.String	getERoomXMLURL(java.lang.String eRoomURL) Translates a web URL to an eRoom SOAP (XML) URL.
static java.lang.String	getFacilityURL(java.lang.String eRoomURL)
static void	getFileContents(java.lang.String eRoomURL, java.lang.String eRoomUser, java.lang.String eRoomPassword, java.lang.String eRoomName, java.lang.String documentID, java.io.OutputStream os)
static java.util.List	getGroupMembers(java.lang.String eRoomURL, java.lang.String adminUser, java.lang.String adminPw, java.lang.String eRoomName, java.lang.String groupID) returns a list of ERoomMember objects for a eRoomServer, facility, eRoom name with a memberID of the Group.
static java.util.List	getGroupMembersAtPath(java.lang.String eRoomURL, java.lang.String adminUser, java.lang.String adminPw, java.lang.String eRoomName, java.lang.String membersSelectPath)
static java.lang.String	getItemType(java.lang.String eRoomURL, java.lang.String eRoomUser, java.lang.String eRoomPassword, java.lang.String eRoomName, java.lang.String documentID) Returns the itemType - if it is a erItemTypeFile - returns the extension as er:erItemTypeFile|extension
static java.util.HashMap	getMemberERoomSets(java.lang.String eRoomServerURL, java.lang.String adminUser, java.lang.String adminPw) Returns a map of Member names (eRoom login IDs) to a set of the eRooms (URL) that the user has access to.
static java.util.HashMap	getMemberERoomURLs(java.lang.String eRoomServerURL, java.lang.String adminUser, java.lang.String adminPw) returns a map of eRoom User to a comma separated list of eRoom names that the user has access to.
static java.util.HashMap	getMemberERoomURLs(java.lang.String eRoomServerURL, java.lang.String adminUser, java.lang.String adminPw, boolean useFullPath) returns a map of eRoom User to a comma separated list of eRoom names that the user has access to.
static void	main(java.lang.String[] args) Creates a list of eRoom members and the set of eRooms that they have access to.

Methods inherited from class java.lang.Object

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

Field Detail

getCoordinatorsRequest

public static java.lang.String getCoordinatorsRequest

getERoomRequestHead

public static java.lang.String getERoomRequestHead

getERoomRequestHeadTemplate

public static java.lang.String getERoomRequestHeadTemplate

eRoomMembersReq

public static java.lang.String eRoomMembersReq

getERoomRequestTail

public static java.lang.String getERoomRequestTail

Constructor Detail

ERoomUtils

public ERoomUtils()

Method Detail

getERoomFacilityNames

public static java.util.List getERoomFacilityNames(java.lang.String eRoomServerURL,
                                                   java.lang.String adminUser,
                                                   java.lang.String adminPw)

Returns a list of the Facilities in an eRoom Server.

Parameters:

eRoomServerURL - Full URL to the eRoom Server. format: http(s)://[ eRoom server Host ]/eRoomXML/Facilities

adminUser - user name of eRoom Administrator.

adminPw - administrator password.

Returns:

List of eRoom Facility names.

getERoomSourceData

public static java.util.HashMap getERoomSourceData(java.lang.String DEFAULT_FACILITY,
                                                   java.lang.String facilityURI,
                                                   ILoginInfo userInfo)

getDescendentList

public static java.util.HashMap getDescendentList(org.w3c.dom.Element contextNode,
                                                  java.lang.String parentXPath,
                                                  java.lang.String parentNamePath,
                                                  java.lang.String toMemberCoordinators)

Creates a HashMap of ERoom data. key is ERoom name, obj an ordered map of data extracted for the ERoom

getERoomNameList

public static java.util.List getERoomNameList(java.lang.String facility,
                                              java.lang.String eRoomServerURL,
                                              java.lang.String adminUser,
                                              java.lang.String adminPw)

Returns a list of eRooms names in an eRoom Facility.

getERoomFieldList

public static java.util.List getERoomFieldList(java.lang.String facility,
                                               java.lang.String eRoomServerURL,
                                               java.lang.String adminUser,
                                               java.lang.String adminPw,
                                               java.lang.String eRoomField)

returns a list of eRooms given an eRoom field (e.g. eRoomURL, eRoomName, Description )

getERoomFacilityMap

public static java.util.Map getERoomFacilityMap(java.lang.String eRoomServerURL,
                                                java.lang.String adminUser,
                                                java.lang.String adminPw)

returns a map of Facility Name --> List of ERooms in the Facility.

getERoomFacilityMap

public static java.util.Map getERoomFacilityMap(java.lang.String eRoomServerURL,
                                                java.lang.String adminUser,
                                                java.lang.String adminPw,
                                                java.lang.String eRoomField)

getMemberERoomURLs

public static java.util.HashMap getMemberERoomURLs(java.lang.String eRoomServerURL,
                                                   java.lang.String adminUser,
                                                   java.lang.String adminPw)

returns a map of eRoom User to a comma separated list of eRoom names that the user has access to.

getMemberERoomURLs

public static java.util.HashMap getMemberERoomURLs(java.lang.String eRoomServerURL,
                                                   java.lang.String adminUser,
                                                   java.lang.String adminPw,
                                                   boolean useFullPath)

returns a map of eRoom User to a comma separated list of eRoom names that the user has access to.

getMemberERoomSets

public static java.util.HashMap getMemberERoomSets(java.lang.String eRoomServerURL,
                                                   java.lang.String adminUser,
                                                   java.lang.String adminPw)

Returns a map of Member names (eRoom login IDs) to a set of the eRooms (URL) that the user has access to.

getGroupMembers

public static java.util.List getGroupMembers(java.lang.String eRoomURL,
                                             java.lang.String adminUser,
                                             java.lang.String adminPw,
                                             java.lang.String eRoomName,
                                             java.lang.String groupID)

returns a list of ERoomMember objects for a eRoomServer, facility, eRoom name with a memberID of the Group.

getGroupMembersAtPath

public static java.util.List getGroupMembersAtPath(java.lang.String eRoomURL,
                                                   java.lang.String adminUser,
                                                   java.lang.String adminPw,
                                                   java.lang.String eRoomName,
                                                   java.lang.String membersSelectPath)

getBaseURL

public static java.lang.String getBaseURL(java.lang.String eRoomURL)

Given a full eRoomURL returns the base part (up to the eRoom Name): e.g. http://[eRoomServer]/eroom(xml)/facilityname/eRoomName

getBaseURL

public static java.lang.String getBaseURL(java.lang.String eRoomURL,
                                          boolean createXMLURL)

getFacilityURL

public static java.lang.String getFacilityURL(java.lang.String eRoomURL)

getDocumentPath

public static java.lang.String getDocumentPath(java.lang.String eRoomURL)

Given a full eRoom URL, returns the document path /[eroom name]/[ document path ]/item_id

getERoomItemURL

public static java.lang.String getERoomItemURL(java.lang.String facilitiesURL)

translates facility XML: http://[eroom host]/eRoomXML/Facilites/[facility name]/[eRoom name] to eRoom url: http://[eroom host]/eRoom/[facility name]/[eroom name]

getERoomXMLURL

public static java.lang.String getERoomXMLURL(java.lang.String eRoomURL)

Translates a web URL to an eRoom SOAP (XML) URL.

getERoomCoordinators

public static java.lang.String[] getERoomCoordinators(java.lang.String eRoomURL,
                                                      java.lang.String adminUser,
                                                      java.lang.String adminPw)

Returns a list of ERoom Coordinators for the given eRoomURL: [eRoomServerURL]/Facilities/[eRoom name]

getERoomCoordinators

public static java.lang.String[] getERoomCoordinators(java.lang.String pERoomURL,
                                                      int refreshIvl,
                                                      java.lang.String adminUser,
                                                      java.lang.String adminPw)

getERoomCoordinators

public static java.lang.String[] getERoomCoordinators(java.lang.String pERoomURL,
                                                      int refreshIvl,
                                                      java.lang.String adminUser,
                                                      java.lang.String adminPw,
                                                      java.lang.String nameFormat)

getERooms

public static ERoom[] getERooms(java.lang.String eRoomServerURL,
                                int refreshIvl,
                                java.lang.String adminUser,
                                java.lang.String adminPw,
                                java.lang.String roomAttributes,
                                boolean getMembers,
                                java.lang.String memberTags)

Returns a list of ERooms in an eRoom server.

Parameters:

roomAttributes - comma separated list of ERoom attributes that should be added to the ERoom metadata objects.

memberTags - comma separated list of XML tag names of the eRoom member properties that should be added to the ERoom metadata object.

getERoom

public static ERoom getERoom(java.lang.String eRoomFacilityURI,
                             java.lang.String eRoomURLName,
                             java.lang.String[] rmAttributes,
                             java.lang.String adminUser,
                             java.lang.String adminPw,
                             boolean getMembers,
                             java.lang.String memberTags)

Returns a metadata object that represents an eRoom.

Parameters:

rmAttributes - List of eRoom attributes that should be added to the ERoom metadata object.

memberTags - Comma separated list of XML tag names of the eRoom member properties that should be added to the ERoom metadata object.

getFileContents

public static void getFileContents(java.lang.String eRoomURL,
                                   java.lang.String eRoomUser,
                                   java.lang.String eRoomPassword,
                                   java.lang.String eRoomName,
                                   java.lang.String documentID,
                                   java.io.OutputStream os)

getItemType

public static java.lang.String getItemType(java.lang.String eRoomURL,
                                           java.lang.String eRoomUser,
                                           java.lang.String eRoomPassword,
                                           java.lang.String eRoomName,
                                           java.lang.String documentID)

Returns the itemType - if it is a erItemTypeFile - returns the extension as er:erItemTypeFile|extension

main

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

Creates a list of eRoom members and the set of eRooms that they have access to.