com.ibm.commerce.collaboration.objects
Class CollabManagerBean

com.ibm.commerce.collaboration.objects.CollabManagerBean

public class CollabManagerBean


Field Summary
static java.lang.String COPYRIGHT
           
 
Constructor Summary
CollabManagerBean()
           
 
Method Summary
 boolean addAuthorGroupMember(CollabSpaceBean csbean)
          addAuthorGroupMember It adds members to the ACL Author group
 boolean addManagerGroupMember(CollabSpaceBean csbean)
          addManagerGroupMember It adds members to the ACL Manager group
 boolean addReaderGroupMember(CollabSpaceBean csbean)
          addReaderGroupMember It adds members to the ACL Reader group
 java.lang.String createCollabSpace(CollabSpaceBean cspaceBean, java.lang.String creatorDN)
          createCollabSpace This function creates a collaboration space.
 boolean deleteAuthorGroupMember(CollabSpaceBean csbean)
          deleteAuthorGroupMember It deletes members from the ACL Author group
 boolean deleteCollabSpace(java.lang.String collabSpaceID)
          deleteCollabSpace It deletes a given collab space from the collab application server and deletes its LDAP entries.
 boolean deleteManagerGroupMember(CollabSpaceBean csbean)
          deleteManagerGroupMember It deletes members from the ACL Manager group
 boolean deleteReaderGroupMember(CollabSpaceBean csbean)
          deleteReaderGroupMember It deletes members from the ACL Reader group
 void ejbActivate()
          ejbActivate Activate the EJB
 void ejbCreate()
          ejbCreate Create the EJB
 void ejbPassivate()
          ejbPassivate Passivate the EJB
 void ejbRemove()
          ejbRemove Remove the EJB
 java.lang.String getCollabAppServerIP()
          getCollabSpaceAppServerIP It gets the collab application server IP
 java.lang.String getCollabAppServerPort()
          getCollabAppServerPort It gets the collab application server port number in a string
 CollabSpaceBean getCollabSpaceDetailsByCollabSpaceID(java.lang.String collabSpaceID)
          getCollabSpaceDetailsByCollabSpaceID It gets the details of a collaborative workspace from the LDAP server
 javax.ejb.SessionContext getSessionContext()
          getSessionContext Returns the session context
 boolean isUserDNAuthorGroupMember(java.lang.String userDN, java.lang.String collabSpaceID)
          isUserDNAuthorGroupMember It checks if the user belongs to the author group of the given collaborative workspace
 boolean isUserDNManagerGroupMember(java.lang.String userDN, java.lang.String collabSpaceID)
          isUserDNManagerGroupMember It checks if the user belongs to the manager group of the given collaborative workspace
 boolean isUserDNReaderGroupMember(java.lang.String userDN, java.lang.String collabSpaceID)
          isUserDNReaderGroupMember It checks if the user belongs to the reader group of the given collaborative workspace
 java.util.Vector listAllCollabSpaces()
          listAllCollabSpaces It lists all the collaborative workspace that exist in the collaborative application server
 java.util.Vector listAuthorGroupMembers(java.lang.String collabSpaceID)
          listAuthorGroupMembers This lists the author group members DN for the given collab space
 java.util.Vector listCollabSpaceForUserDN(java.lang.String userDN)
          listCollabSpaceForUserDN This function returns a list of CollabSpaceBean objects for the given LDAP uid.
 java.util.Vector listCollabSpaceTemplates()
          listCollabSpaceTemplates It lists all available collaborative workspace templates
 java.util.Vector listManagerGroupMembers(java.lang.String collabSpaceID)
          listManagerGroupMembers This lists the manager group members DN for the given collab space
 java.util.Vector listReaderGroupMembers(java.lang.String collabSpaceID)
          listReaderGroupMembers This lists the reader group members DN for the given collab space
 boolean modifyAuthorGroupMembers(CollabSpaceBean csbean)
          modifyAuthorGroupMembers It modifies the author group members in LDAP
 boolean modifyCollabSpaceDescription(java.lang.String collabSpaceID, java.lang.String description)
          modifyCollabSpaceDescription It modifies the collaborative workspace description
 boolean modifyManagerGroupMembers(CollabSpaceBean csbean)
          modifyManagerGroupMembers It modifies the manager group members in LDAP
 boolean modifyReaderGroupMembers(CollabSpaceBean csbean)
          modifyReaderGroupMembers It modifies the reader group members in LDAP
 void setSessionContext(javax.ejb.SessionContext ctx)
          setSessionContext method comment
 boolean TESTaddAuthorGroupMembers(java.lang.String csID)
           
 boolean TESTaddAuthorGroupMembers(java.lang.String csID, java.lang.String userDN)
           
 boolean TESTaddManagerGroupMembers(java.lang.String csID)
           
 boolean TESTaddManagerGroupMembers(java.lang.String csID, java.lang.String userDN)
           
 boolean TESTaddReaderGroupMembers(java.lang.String csID)
           
 boolean TESTaddReaderGroupMembers(java.lang.String csID, java.lang.String userDN)
           
 java.lang.String TESTcreateCollabSpace(java.lang.String bProcType, java.lang.String bProcID)
           
 boolean TESTdeleteAuthorGroupMembers(java.lang.String csID)
           
 boolean TESTdeleteAuthorGroupMembers(java.lang.String csID, java.lang.String userDN)
           
 boolean TESTdeleteManagerGroupMembers(java.lang.String csID)
           
 boolean TESTdeleteManagerGroupMembers(java.lang.String csID, java.lang.String userDN)
           
 boolean TESTdeleteReaderGroupMembers(java.lang.String csID)
           
 boolean TESTdeleteReaderGroupMembers(java.lang.String csID, java.lang.String userDN)
           
 boolean TESTmodifyAuthorGroupMembers()
           
 boolean TESTmodifyManagerGroupMembers()
           
 boolean TESTmodifyReaderGroupMembers()
           
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Constructor Detail

CollabManagerBean

public CollabManagerBean()
Method Detail

addAuthorGroupMember

public boolean addAuthorGroupMember(CollabSpaceBean csbean)
                             throws java.io.IOException,
                                    java.rmi.RemoteException
addAuthorGroupMember It adds members to the ACL Author group
Parameters:
csbean - com.ibm.commerce.collaboration.beans.CollabSpaceBean Information about the collaborative workspace Information about the collaborative workspace
Returns:
boolean True if successful, false otherwise
Throws:
java.io.IOException - Failed or interrupted IO operations.
java.rmi.RemoteException - Communication-related exception during a remote method call

addManagerGroupMember

public boolean addManagerGroupMember(CollabSpaceBean csbean)
                              throws java.io.IOException,
                                     java.rmi.RemoteException
addManagerGroupMember It adds members to the ACL Manager group
Parameters:
csbean - com.ibm.commerce.collaboration.beans.CollabSpaceBean Information about the collaborative workspace
Returns:
boolean True if successful, false otherwise
Throws:
java.io.IOException - Failed or interrupted IO operations.
java.rmi.RemoteException - Communication-related exception during a remote method call

addReaderGroupMember

public boolean addReaderGroupMember(CollabSpaceBean csbean)
                             throws java.io.IOException,
                                    java.rmi.RemoteException
addReaderGroupMember It adds members to the ACL Reader group
Parameters:
csbean - com.ibm.commerce.collaboration.beans.CollabSpaceBean Information about the collaborative workspace
Returns:
boolean True if successful, false otherwise
Throws:
java.io.IOException - Failed or interrupted IO operations.
java.rmi.RemoteException - Communication-related exception during a remote method call

createCollabSpace

public java.lang.String createCollabSpace(CollabSpaceBean cspaceBean,
                                          java.lang.String creatorDN)
                                   throws java.rmi.RemoteException,
                                          java.io.IOException
createCollabSpace This function creates a collaboration space. CollabManager needs to get information of which collaboration application we are using. All the required parameters for creating a collaboration space are passed through the cspaceBean. It returns the collabSpace URL if it succeeds, otherwise null.
Parameters:
cspaceBean - com.ibm.commerce.collaboration.beans.CollabSpaceBean Information about the collaborative workspace
creatorDN - java.lang.String The DN of the creator
Returns:
java.lang.String The URL of the collaborative workspace created.
Throws:
java.io.IOException - Failed or interrupted IO operations.
java.rmi.RemoteException - Communication-related exception during a remote method call

deleteAuthorGroupMember

public boolean deleteAuthorGroupMember(CollabSpaceBean csbean)
                                throws java.io.IOException,
                                       java.rmi.RemoteException
deleteAuthorGroupMember It deletes members from the ACL Author group
Parameters:
csbean - com.ibm.commerce.collaboration.beans.CollabSpaceBean Information about the collaborative workspace
requesterUid - java.lang.String
Returns:
boolean True if the operation is successful, otherwise, false
Throws:
java.io.IOException - Failed or interrupted IO operations.
java.rmi.RemoteException - Communication-related exception during a remote method call

deleteCollabSpace

public boolean deleteCollabSpace(java.lang.String collabSpaceID)
                          throws java.io.IOException,
                                 java.rmi.RemoteException
deleteCollabSpace It deletes a given collab space from the collab application server and deletes its LDAP entries.
Parameters:
collabSpaceID - java.lang.String The unique ID of the collaborative workspace
Returns:
boolean True if the operation is successful, otherwise, false
Throws:
java.io.IOException - Failed or interrupted IO operations.
java.rmi.RemoteException - Communication-related exception during a remote method call

deleteManagerGroupMember

public boolean deleteManagerGroupMember(CollabSpaceBean csbean)
                                 throws java.io.IOException,
                                        java.rmi.RemoteException
deleteManagerGroupMember It deletes members from the ACL Manager group
Parameters:
csbean - com.ibm.commerce.collaboration.beans.CollabSpaceBean Information about the collaborative workspace
Returns:
boolean True if the operation is successful, otherwise, false
Throws:
java.io.IOException - Failed or interrupted IO operations.
java.rmi.RemoteException - Communication-related exception during a remote method call

deleteReaderGroupMember

public boolean deleteReaderGroupMember(CollabSpaceBean csbean)
                                throws java.io.IOException,
                                       java.rmi.RemoteException
deleteReaderGroupMember It deletes members from the ACL Reader group
Parameters:
csbean - com.ibm.commerce.collaboration.beans.CollabSpaceBean Information about the collaborative workspace
Returns:
boolean True if the operation is successful, otherwise, false
Throws:
java.io.IOException - Failed or interrupted IO operations.
java.rmi.RemoteException - Communication-related exception during a remote method call

ejbActivate

public void ejbActivate()
                 throws java.rmi.RemoteException
ejbActivate Activate the EJB
Throws:
java.rmi.RemoteException - Communication-related exception during a remote method call

ejbCreate

public void ejbCreate()
               throws javax.ejb.CreateException,
                      java.rmi.RemoteException
ejbCreate Create the EJB
Throws:
javax.ejb.CreateException - Exception thrown when creating the EJB
java.rmi.RemoteException - Communication-related exception during a remote method call

ejbPassivate

public void ejbPassivate()
                  throws java.rmi.RemoteException
ejbPassivate Passivate the EJB
Throws:
java.rmi.RemoteException - Communication-related exception during a remote method call

ejbRemove

public void ejbRemove()
               throws java.rmi.RemoteException
ejbRemove Remove the EJB
Throws:
java.rmi.RemoteException - Communication-related exception during a remote method call

getCollabAppServerIP

public java.lang.String getCollabAppServerIP()
                                      throws java.io.IOException,
                                             java.rmi.RemoteException
getCollabSpaceAppServerIP It gets the collab application server IP
Returns:
java.lang.String The server IP of the collaboration server
Throws:
java.io.IOException - Failed or interrupted IO operations.
java.rmi.RemoteException - Communication-related exception during a remote method call

getCollabAppServerPort

public java.lang.String getCollabAppServerPort()
                                        throws java.io.IOException,
                                               java.rmi.RemoteException
getCollabAppServerPort It gets the collab application server port number in a string
Returns:
java.lang.String Collaboration server port
Throws:
java.io.IOException - Failed or interrupted IO operations.
java.rmi.RemoteException - Communication-related exception during a remote method call

getCollabSpaceDetailsByCollabSpaceID

public CollabSpaceBean getCollabSpaceDetailsByCollabSpaceID(java.lang.String collabSpaceID)
                                                     throws java.io.IOException,
                                                            java.rmi.RemoteException
getCollabSpaceDetailsByCollabSpaceID It gets the details of a collaborative workspace from the LDAP server
Parameters:
collabSpaceID - java.lang.String The unique ID of the collaborative workspace
Returns:
com.ibm.commerce.collaboration.beans.CollabSpaceBean Information of the collaborative workspace
Throws:
java.io.IOException - Failed or interrupted IO operations.
java.rmi.RemoteException - Communication-related exception during a remote method call

getSessionContext

public javax.ejb.SessionContext getSessionContext()
getSessionContext Returns the session context
Returns:
javax.ejb.SessionContext

isUserDNAuthorGroupMember

public boolean isUserDNAuthorGroupMember(java.lang.String userDN,
                                         java.lang.String collabSpaceID)
                                  throws java.io.IOException,
                                         java.rmi.RemoteException
isUserDNAuthorGroupMember It checks if the user belongs to the author group of the given collaborative workspace
Parameters:
userDN - java.lang.String The DN of the user
collabSpaceID - java.lang.String The unique ID of the collaborative workspace
Returns:
boolean True if yes, otherwise, false
Throws:
java.io.IOException - Failed or interrupted IO operations.
java.rmi.RemoteException - Communication-related exception during a remote method call

isUserDNManagerGroupMember

public boolean isUserDNManagerGroupMember(java.lang.String userDN,
                                          java.lang.String collabSpaceID)
                                   throws java.io.IOException,
                                          java.rmi.RemoteException
isUserDNManagerGroupMember It checks if the user belongs to the manager group of the given collaborative workspace
Parameters:
userDN - java.lang.String The DN of the user
collabSpaceID - java.lang.String The unique ID of the collaborative workspace
Returns:
boolean True if yes, otherwise, false
Throws:
java.io.IOException - Failed or interrupted IO operations.
java.rmi.RemoteException - Communication-related exception during a remote method call

isUserDNReaderGroupMember

public boolean isUserDNReaderGroupMember(java.lang.String userDN,
                                         java.lang.String collabSpaceID)
                                  throws java.io.IOException,
                                         java.rmi.RemoteException
isUserDNReaderGroupMember It checks if the user belongs to the reader group of the given collaborative workspace
Parameters:
userDN - java.lang.String The DN of the user
collabSpaceID - java.lang.String The unique ID of the collaborative workspace
Returns:
boolean True if yes, otherwise, false
Throws:
java.io.IOException - Failed or interrupted IO operations.
java.rmi.RemoteException - Communication-related exception during a remote method call

listAllCollabSpaces

public java.util.Vector listAllCollabSpaces()
                                     throws java.io.IOException,
                                            java.rmi.RemoteException
listAllCollabSpaces It lists all the collaborative workspace that exist in the collaborative application server
Returns:
java.util.Vector A vector of com.ibm.commerce.collaboration.beans.CollabSpaceBean
Throws:
java.io.IOException - Failed or interrupted IO operations.
java.rmi.RemoteException - Communication-related exception during a remote method call

listAuthorGroupMembers

public java.util.Vector listAuthorGroupMembers(java.lang.String collabSpaceID)
                                        throws java.io.IOException,
                                               java.rmi.RemoteException
listAuthorGroupMembers This lists the author group members DN for the given collab space
Parameters:
collabSpaceID - java.lang.String The unique ID of the collaborative workspace
Returns:
java.util.Vector A vector of member in strings.
Throws:
java.io.IOException - Failed or interrupted IO operations.
java.rmi.RemoteException - Communication-related exception during a remote method call

listCollabSpaceForUserDN

public java.util.Vector listCollabSpaceForUserDN(java.lang.String userDN)
                                          throws java.io.IOException,
                                                 java.rmi.RemoteException
listCollabSpaceForUserDN This function returns a list of CollabSpaceBean objects for the given LDAP uid.
Parameters:
userDN - java.lang.String The DN of the user
Returns:
java.util.Vector A vector of csbean com.ibm.commerce.collaboration.beans.CollabSpaceBean
Throws:
java.io.IOException - Failed or interrupted IO operations.
java.rmi.RemoteException - Communication-related exception during a remote method call

listCollabSpaceTemplates

public java.util.Vector listCollabSpaceTemplates()
                                          throws java.io.IOException,
                                                 java.rmi.RemoteException
listCollabSpaceTemplates It lists all available collaborative workspace templates
Returns:
java.util.Vector A vector of template names
Throws:
java.io.IOException - Failed or interrupted IO operations.
java.rmi.RemoteException - Communication-related exception during a remote method call

listManagerGroupMembers

public java.util.Vector listManagerGroupMembers(java.lang.String collabSpaceID)
                                         throws java.io.IOException,
                                                java.rmi.RemoteException
listManagerGroupMembers This lists the manager group members DN for the given collab space
Parameters:
collabSpaceID - java.lang.String The unique ID of the collaborative workspace
Returns:
java.util.Vector A vector of member DN in strings.
Throws:
java.io.IOException - Failed or interrupted IO operations.
java.rmi.RemoteException - Communication-related exception during a remote method call

listReaderGroupMembers

public java.util.Vector listReaderGroupMembers(java.lang.String collabSpaceID)
                                        throws java.io.IOException,
                                               java.rmi.RemoteException
listReaderGroupMembers This lists the reader group members DN for the given collab space
Parameters:
collabSpaceID - java.lang.String The unique ID of the collaborative workspace
Returns:
java.util.Vector A vector of member DN in strings.
Throws:
java.io.IOException - Failed or interrupted IO operations.
java.rmi.RemoteException - Communication-related exception during a remote method call

modifyAuthorGroupMembers

public boolean modifyAuthorGroupMembers(CollabSpaceBean csbean)
                                 throws java.io.IOException,
                                        java.rmi.RemoteException
modifyAuthorGroupMembers It modifies the author group members in LDAP
Parameters:
csbean - com.ibm.commerce.collaboration.beans.CollabSpaceBean Information about the collaborative workspace
Returns:
boolean True if the operation succeeds, otherwise, false
Throws:
java.io.IOException - Failed or interrupted IO operations.
java.rmi.RemoteException - Communication-related exception during a remote method call

modifyCollabSpaceDescription

public boolean modifyCollabSpaceDescription(java.lang.String collabSpaceID,
                                            java.lang.String description)
                                     throws java.io.IOException,
                                            java.rmi.RemoteException
modifyCollabSpaceDescription It modifies the collaborative workspace description
Parameters:
collabSpaceID - java.lang.String The unique ID of the collaborative workspace
description - java.lang.String The description of the collaborative workspace
Returns:
boolean True if the operation is successful, otherwise, false
Throws:
java.io.IOException - Failed or interrupted IO operations.
java.rmi.RemoteException - Communication-related exception during a remote method call

modifyManagerGroupMembers

public boolean modifyManagerGroupMembers(CollabSpaceBean csbean)
                                  throws java.io.IOException,
                                         java.rmi.RemoteException
modifyManagerGroupMembers It modifies the manager group members in LDAP
Parameters:
csbean - com.ibm.commerce.collaboration.beans.CollabSpaceBean Information about the collaborative workspace
Returns:
boolean True if the operation succeeds, otherwise, false
Throws:
java.io.IOException - Failed or interrupted IO operations.
java.rmi.RemoteException - Communication-related exception during a remote method call

modifyReaderGroupMembers

public boolean modifyReaderGroupMembers(CollabSpaceBean csbean)
                                 throws java.io.IOException,
                                        java.rmi.RemoteException
modifyReaderGroupMembers It modifies the reader group members in LDAP
Parameters:
csbean - com.ibm.commerce.collaboration.beans.CollabSpaceBean Information about the collaborative workspace
Returns:
boolean True if the operation succeeds, otherwise, false
Throws:
java.io.IOException - Failed or interrupted IO operations.
java.rmi.RemoteException - Communication-related exception during a remote method call

setSessionContext

public void setSessionContext(javax.ejb.SessionContext ctx)
                       throws java.rmi.RemoteException
setSessionContext method comment
Parameters:
ctx - javax.ejb.SessionContext
Throws:
java.rmi.RemoteException - Communication-related exception during a remote method call

TESTaddAuthorGroupMembers

public boolean TESTaddAuthorGroupMembers(java.lang.String csID)
                                  throws java.io.IOException,
                                         java.rmi.RemoteException

TESTaddAuthorGroupMembers

public boolean TESTaddAuthorGroupMembers(java.lang.String csID,
                                         java.lang.String userDN)
                                  throws java.io.IOException,
                                         java.rmi.RemoteException

TESTaddManagerGroupMembers

public boolean TESTaddManagerGroupMembers(java.lang.String csID)
                                   throws java.io.IOException,
                                          java.rmi.RemoteException

TESTaddManagerGroupMembers

public boolean TESTaddManagerGroupMembers(java.lang.String csID,
                                          java.lang.String userDN)
                                   throws java.io.IOException,
                                          java.rmi.RemoteException

TESTaddReaderGroupMembers

public boolean TESTaddReaderGroupMembers(java.lang.String csID)
                                  throws java.io.IOException,
                                         java.rmi.RemoteException

TESTaddReaderGroupMembers

public boolean TESTaddReaderGroupMembers(java.lang.String csID,
                                         java.lang.String userDN)
                                  throws java.io.IOException,
                                         java.rmi.RemoteException

TESTcreateCollabSpace

public java.lang.String TESTcreateCollabSpace(java.lang.String bProcType,
                                              java.lang.String bProcID)
                                       throws java.rmi.RemoteException,
                                              java.io.IOException

TESTdeleteAuthorGroupMembers

public boolean TESTdeleteAuthorGroupMembers(java.lang.String csID)
                                     throws java.io.IOException,
                                            java.rmi.RemoteException

TESTdeleteAuthorGroupMembers

public boolean TESTdeleteAuthorGroupMembers(java.lang.String csID,
                                            java.lang.String userDN)
                                     throws java.io.IOException,
                                            java.rmi.RemoteException

TESTdeleteManagerGroupMembers

public boolean TESTdeleteManagerGroupMembers(java.lang.String csID)
                                      throws java.io.IOException,
                                             java.rmi.RemoteException

TESTdeleteManagerGroupMembers

public boolean TESTdeleteManagerGroupMembers(java.lang.String csID,
                                             java.lang.String userDN)
                                      throws java.io.IOException,
                                             java.rmi.RemoteException

TESTdeleteReaderGroupMembers

public boolean TESTdeleteReaderGroupMembers(java.lang.String csID)
                                     throws java.io.IOException,
                                            java.rmi.RemoteException

TESTdeleteReaderGroupMembers

public boolean TESTdeleteReaderGroupMembers(java.lang.String csID,
                                            java.lang.String userDN)
                                     throws java.io.IOException,
                                            java.rmi.RemoteException

TESTmodifyAuthorGroupMembers

public boolean TESTmodifyAuthorGroupMembers()
                                     throws java.io.IOException,
                                            java.rmi.RemoteException

TESTmodifyManagerGroupMembers

public boolean TESTmodifyManagerGroupMembers()
                                      throws java.io.IOException,
                                             java.rmi.RemoteException

TESTmodifyReaderGroupMembers

public boolean TESTmodifyReaderGroupMembers()
                                     throws java.io.IOException,
                                            java.rmi.RemoteException