|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
com.ibm.bct.rp.cms.UserXML
The class UserXML
contains methods for performing basic
operations on User objects in the WebSphere Member Subsystem.
Constructor Summary | |
UserXML()
Blank UserXML constructor. |
|
UserXML(java.lang.String theXML)
UserXML constructor from XML attribute definition. |
|
UserXML(java.lang.String theIiopNode,
java.lang.String userId)
UserXML constructor from existing User CMS record. |
|
UserXML(java.lang.String theIiopNode,
java.lang.String orgEntityId,
java.lang.String userId)
UserXML constructor from existing User CMS record. |
|
UserXML(com.ibm.bct.rp.cms.UserVO userVO)
UserXML constructor from UserVO object. |
Method Summary | |
java.lang.String |
createUser()
Create a User in WMS based on attributes in this User object. |
void |
deleteUser(boolean includeDescendants)
Delete a User from WMS represented by this User object. |
java.util.List |
findUserIDs(java.lang.String attrName,
java.lang.String attrValue)
Find all Users based on an attribute value returning User logon IDs. |
java.util.List |
findUsers(java.lang.String attrName,
java.lang.String attrValue)
Find all Users based on an attribute value returning unique User identifiers. |
boolean |
fromXML(java.lang.String xml)
Create a User object from XML. |
java.util.List |
getAncestorOrgEntityIdentifiers()
Get a List of ancestor OrgEntityies for this User object. |
java.util.List |
getMemberGroupsIdentifiers()
Get a List of Member Groups for this User object. |
java.lang.String |
getParentOrgEntityIdentifier()
Get the parent OrgEntity for this User object. |
com.ibm.bct.rp.cms.UserVO |
getUser()
Get the User Value Object for this UserXML object. |
com.ibm.bct.rp.cms.UserVO |
getUser(java.lang.String userId)
Retrieve from WMS the User for the specified User identifier. |
com.ibm.bct.rp.cms.UserVO |
getUser(java.lang.String orgEntityId,
java.lang.String userId)
Retrieve from WMS the User for the specified OrgEntity and User identifier. |
java.util.List |
searchUsers(java.lang.String attrName,
java.lang.String attrValue,
java.util.List getAttr)
Find all Users based on an attribute value and return a list of attribute Maps. |
java.lang.String |
toXML()
Convert User to XML. |
java.lang.String |
updateUser()
Create or update if it already exists a User in WMS based on attributes in this User object |
Constructor Detail |
public UserXML()
public UserXML(java.lang.String theXML)
java.lang.String
- theXML - The XML document with the User definition.public UserXML(com.ibm.bct.rp.cms.UserVO userVO)
com.ibm.websphere.memberservice.objects.UserVO
- orgVO - The User value object.public UserXML(java.lang.String theIiopNode, java.lang.String userId) throws com.ibm.bct.rp.cms.MemberServiceException, java.rmi.RemoteException, com.ibm.bct.rp.cms.CreateException, com.ibm.bct.rp.cms.NamingException
java.lang.String
- theIiopNode - The IIOP node of the CMS to access (null=use "localhost").java.lang.String
- UserId - The User Id for the CMS retrieve.public UserXML(java.lang.String theIiopNode, java.lang.String orgEntityId, java.lang.String userId) throws com.ibm.bct.rp.cms.MemberServiceException, java.rmi.RemoteException, com.ibm.bct.rp.cms.CreateException, com.ibm.bct.rp.cms.NamingException
java.lang.String
- theIiopNode - The IIOP node of the CMS to access (null=use "localhost").java.lang.String
- OrgEntityId - The Org Entity Id for the CMS retrieve.java.lang.String
- UserId - The User Id for the CMS retrieve.Method Detail |
public java.util.List getAncestorOrgEntityIdentifiers()
public java.util.List getMemberGroupsIdentifiers()
public java.lang.String getParentOrgEntityIdentifier()
public com.ibm.bct.rp.cms.UserVO getUser()
public com.ibm.bct.rp.cms.UserVO getUser(java.lang.String userId) throws com.ibm.bct.rp.cms.MemberServiceException, java.rmi.RemoteException, com.ibm.bct.rp.cms.CreateException, com.ibm.bct.rp.cms.NamingException
input
- java.lang.String userId - The User identifier.public com.ibm.bct.rp.cms.UserVO getUser(java.lang.String orgEntityId, java.lang.String userId) throws com.ibm.bct.rp.cms.MemberServiceException, java.rmi.RemoteException, com.ibm.bct.rp.cms.CreateException, com.ibm.bct.rp.cms.NamingException
input
- java.lang.String orgEntityId - The OrgEntity identifier.input
- java.lang.String userId - The User identifier.public java.lang.String createUser() throws com.ibm.bct.rp.cms.MemberServiceException, java.rmi.RemoteException, com.ibm.bct.rp.cms.CreateException, com.ibm.bct.rp.cms.NamingException
public java.lang.String updateUser() throws com.ibm.bct.rp.cms.MemberServiceException, java.rmi.RemoteException, com.ibm.bct.rp.cms.CreateException, com.ibm.bct.rp.cms.NamingException
public void deleteUser(boolean includeDescendants) throws com.ibm.bct.rp.cms.MemberServiceException, java.rmi.RemoteException, com.ibm.bct.rp.cms.CreateException, com.ibm.bct.rp.cms.NamingException
boolean
- includeDescendants - Also delete descendants (flag ignored in this version).public java.util.List findUsers(java.lang.String attrName, java.lang.String attrValue) throws com.ibm.bct.rp.cms.MemberServiceException, java.rmi.RemoteException, com.ibm.bct.rp.cms.CreateException, com.ibm.bct.rp.cms.NamingException
input
- java.lang.String attrName - The name of the attribute to search on.input
- java.lang.String attrValue - The value to search for.public java.util.List findUserIDs(java.lang.String attrName, java.lang.String attrValue) throws com.ibm.bct.rp.cms.MemberServiceException, java.rmi.RemoteException, com.ibm.bct.rp.cms.CreateException, com.ibm.bct.rp.cms.NamingException
input
- java.lang.String attrName - The name of the attribute to search on.input
- java.lang.String attrValue - The value to search for.public java.util.List searchUsers(java.lang.String attrName, java.lang.String attrValue, java.util.List getAttr) throws com.ibm.bct.rp.cms.MemberServiceException, java.rmi.RemoteException, com.ibm.bct.rp.cms.CreateException, com.ibm.bct.rp.cms.NamingException
input
- java.lang.String attrName - The name of the attribute to search on.input
- java.lang.String attrValue - The value to search for.input
- java.util.List getAttr - A list of attribute names of the values to return.public java.lang.String toXML()
public boolean fromXML(java.lang.String xml)
input
- java.lang.String xml - XML string representing the User object.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |