com.ibm.commerce.collaboration.collabapplication
Class QPAdaptor
java.lang.Object
com.ibm.commerce.collaboration.collabapplication.QPAdaptor
- All Implemented Interfaces:
- CollabAppAdapter, ECCollabCmdConstants
- public class QPAdaptor
- extends java.lang.Object
- implements CollabAppAdapter, ECCollabCmdConstants
This class is the adaptor used to communicate with QuickPlace 3.0 server
Field Summary |
static java.lang.String |
COPYRIGHT
Copyright statement |
Fields inherited from interface com.ibm.commerce.collaboration.workspaces.helper.ECCollabCmdConstants |
EC_ACCOUNT_ID, EC_CC_KEY_LOGONID, EC_CC_KEY_LOGONID_UID, EC_CC_KEY_NAME_FN, EC_CC_KEY_NAME_LN, EC_CC_KEY_NAME_MN, EC_CC_KEY_USERID, EC_CC_STRING_EMPTY_STRING, EC_COLLABSPACE_DESCRIPTION, EC_COLLABSPACE_ID, EC_COLLABSPACE_NAME, EC_ERROR_ACCOUNT_DOES_NOT_EXIST, EC_ERROR_ADD_MEMBERS, EC_ERROR_COLLAB_DOES_NOT_EXIST, EC_ERROR_COLLAB_NAME_EXISTS, EC_ERROR_COLLAB_NO_AUTHORIZATION, EC_ERROR_INVALID_MEMBER, EC_ERROR_INVALID_ROLE, EC_ERROR_LDAP_DOWN, EC_ERROR_MEMBER_HAS_ANOTHER_ROLE, EC_ERROR_MEMBER_HAS_NO_ROLE, EC_ERROR_MEMBER_HAS_ROLE, EC_ERROR_NO_AUTHORIZATION, EC_ERROR_QUICKPLACE_DOWN, EC_ERROR_REMOVE_MEMBERS, EC_ERROR_TEMPLATE_DOES_NOT_EXIST, EC_PROCESS_ID, EC_PROCESS_TYPE, EC_QP_URL, EC_QPADMIN_ID, EC_QPADMIN_PASSWORD, EC_ROLE, EC_SEND_EMAIL, EC_SUCCESS_ADD_MEMBERS, EC_SUCCESS_CREATE_SPACE, EC_TEMPLATE_NAME, EC_USER_ID |
Constructor Summary |
QPAdaptor()
Constructor for QPAdaptor |
Method Summary |
boolean |
addCollabWorkspace(CollabWorkspaceInfo csbean)
Creates a collaborative workspace |
int |
addMember(java.lang.String cwId, java.lang.String memberDN, java.lang.String role)
Adds Group members to the collaborative workspace documents according to their access level |
int |
addMembers(CollabWorkspaceInfo csbean)
Adds Group members to the collaborative workspace documents according to their access level |
int |
addMembers(java.lang.String cwId, java.util.Vector memberDNs, java.lang.String role)
Adds Group members to the collaborative workspace documents according to their access level |
java.io.InputStream |
callServlet(java.lang.String servletName, java.util.Vector parameters)
Calls a QuickPlace servlet |
java.lang.String |
getCollabWorkspaceURL(java.lang.String cwId)
Returns the URL for a collaborative workspace |
java.util.Vector |
listTemplates()
Lists all the templates that are available on the collaborative application server |
boolean |
removeCollabWorkspace(java.lang.String cwId)
Removes a specific collaborative workspace |
int |
removeMember(java.lang.String cwId, java.lang.String memberDN)
Deletes Group members from the collaborative workspace |
int |
removeMembers(java.lang.String cwId, java.util.Vector memberDNs)
Deletes Group members from the collaborative workspace |
int |
setMemberRole(java.lang.String cwId, java.lang.String memberDN, java.lang.String role)
Changes the role of a member |
int |
setMembersRole(java.lang.String cwId, java.util.Vector memberDNs, java.lang.String role)
Changes the role of members |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
COPYRIGHT
public static final java.lang.String COPYRIGHT
- Copyright statement
- See Also:
- Constant Field Values
QPAdaptor
public QPAdaptor()
- Constructor for QPAdaptor
addCollabWorkspace
public boolean addCollabWorkspace(CollabWorkspaceInfo csbean)
throws ECException
- Creates a collaborative workspace
-
- Specified by:
- addCollabWorkspace in interface CollabAppAdapter
-
- Parameters:
- csbean - Collaborative workspace information
- Returns:
- true if successful, false otherwise
- Throws:
- java.lang.Exception - thrown by WebSphereCommerce
- ECException
addMembers
public int addMembers(CollabWorkspaceInfo csbean)
throws ECException
- Adds Group members to the collaborative workspace documents according to their access level
-
- Specified by:
- addMembers in interface CollabAppAdapter
-
- Parameters:
- csbean - Collaborative workspace information
- Returns:
- Number of members added
- Throws:
- ECException - thrown by WebSphereCommerce Server
addMembers
public int addMembers(java.lang.String cwId,
java.util.Vector memberDNs,
java.lang.String role)
throws ECException
- Adds Group members to the collaborative workspace documents according to their access level
-
- Specified by:
- addMembers in interface CollabAppAdapter
-
- Parameters:
- cwId - The collaborative workspace ID
- role - Role of the members, can be CollabManager.ROLE_MANAGER, CollabManager.ROLE_AUTHOR or CollabManager.ROLE_READER
- Returns:
- Number of members added
- Throws:
- ECException - thrown by WebSphereCommerce Server
addMember
public int addMember(java.lang.String cwId,
java.lang.String memberDN,
java.lang.String role)
throws ECException
- Adds Group members to the collaborative workspace documents according to their access level
-
- Specified by:
- addMember in interface CollabAppAdapter
-
- Parameters:
- cwId - The collaborative workspace ID
- role - Role of the members, can be CollabManager.ROLE_MANAGER, CollabManager.ROLE_AUTHOR or CollabManager.ROLE_READER
- Returns:
- Number of members added
- Throws:
- ECException - thrown by WebSphereCommerce Server
removeMembers
public int removeMembers(java.lang.String cwId,
java.util.Vector memberDNs)
throws ECException
- Deletes Group members from the collaborative workspace
-
- Specified by:
- removeMembers in interface CollabAppAdapter
-
- Parameters:
- cwId - The collaborative workspace ID
- memberDNs - Vector of member distinguished name (DN)
- Returns:
- Number of members removed
- Throws:
- ECException - thrown by WebSphereCommerce Server
removeMember
public int removeMember(java.lang.String cwId,
java.lang.String memberDN)
throws ECException
- Deletes Group members from the collaborative workspace
-
- Specified by:
- removeMember in interface CollabAppAdapter
-
- Parameters:
- cwId - The collaborative workspace ID
- memberDN - distinguished name (DN) of the member
- Returns:
- Number of members removed
- Throws:
- ECException - thrown by WebSphereCommerce Server
setMembersRole
public int setMembersRole(java.lang.String cwId,
java.util.Vector memberDNs,
java.lang.String role)
throws ECException
- Changes the role of members
-
- Specified by:
- setMembersRole in interface CollabAppAdapter
-
- Parameters:
- cwId - The collaborative workspace ID
- memberDNs - Vector of the member distinguished name (DN)
- role - Role of the members, can be CollabManager.ROLE_MANAGER, CollabManager.ROLE_AUTHOR or CollabManager.ROLE_READER
- Returns:
- Number of users changed
- Throws:
- ECException - thrown by WebSphereCommerce Server
setMemberRole
public int setMemberRole(java.lang.String cwId,
java.lang.String memberDN,
java.lang.String role)
throws ECException
- Changes the role of a member
-
- Specified by:
- setMemberRole in interface CollabAppAdapter
-
- Parameters:
- cwId - The collaborative workspace ID
- memberDN - distinguished name (DN) of the member
- role - Role of the members, can be CollabManager.ROLE_MANAGER, CollabManager.ROLE_AUTHOR or CollabManager.ROLE_READER
- Returns:
- Number of users changed
- Throws:
- ECException - thrown by WebSphereCommerce Server
listTemplates
public java.util.Vector listTemplates()
- Lists all the templates that are available on the collaborative application server
-
- Specified by:
- listTemplates in interface CollabAppAdapter
-
- Returns:
- Vector of template names
- Throws:
- ECException - thrown by WebSphereCommerce Server
removeCollabWorkspace
public boolean removeCollabWorkspace(java.lang.String cwId)
throws ECException
- Removes a specific collaborative workspace
-
- Specified by:
- removeCollabWorkspace in interface CollabAppAdapter
-
- Parameters:
- cwId - The collaborative workspace ID
- Returns:
- true if successful, false otherwise
- Throws:
- java.lang.Exception - thrown by WebSphereCommerce
- ECException - thrown by WebSphereCommerce Server
getCollabWorkspaceURL
public java.lang.String getCollabWorkspaceURL(java.lang.String cwId)
- Returns the URL for a collaborative workspace
-
- Specified by:
- getCollabWorkspaceURL in interface CollabAppAdapter
-
- Parameters:
- cwId - The collaborative workspace ID
- Returns:
- URL of the workspace
callServlet
public java.io.InputStream callServlet(java.lang.String servletName,
java.util.Vector parameters)
throws ECException
- Calls a QuickPlace servlet
-
- Parameters:
- parameters - A Vector of Strings in form of "name=value"
- Returns:
- The output of the server
- Throws:
- Exceptions - thrown by WebSphereCommerce server
- ECException
Feedback
(C) Copyright IBM Corporation 1996, 2005. All Rights Reserved.