public class VMMProxy
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
The IBM Copyright notice field.
|
Modifier and Type | Method and Description |
---|---|
commonj.sdo.DataObject |
addMemberToGroups(java.util.ArrayList alstGroups,
java.lang.String astrDN)
Adds an entity (member) to one or more groups.
|
commonj.sdo.DataObject |
checkPassword(java.lang.String astrLogonID,
java.lang.String astrPassword)
Verifies the password of a user in VMM.
|
commonj.sdo.DataObject |
createMember(TypedProperty atpProperties,
short anMemberType,
java.lang.String astrParentDN)
Creates a member in VMM.
|
java.util.List |
deleteMember(java.lang.String astrDN)
Deletes a member in VMM.
|
commonj.sdo.DataObject |
findUserByLogonId(java.lang.String astrRDNName,
java.lang.String astrLogonId)
Searches for users in VMM based on the logon ID.
|
static VMMProxy |
getInstance()
Gets the singleton instance of this class.
|
commonj.sdo.DataObject |
getMemberByDN(java.lang.String astrDN)
Gets the member entity object within the Commerce Root Organization or its search bases.
|
commonj.sdo.DataObject |
getMemberByUniqueId(java.lang.String astrUniqueId)
Gets the entity object containing the member and all of its standard properties.
|
commonj.sdo.DataObject |
removeMemberFromGroups(java.util.ArrayList alstGroups,
java.lang.String astrDN)
Removes an entity (member) from one or more groups.
|
commonj.sdo.DataObject |
updateMember(TypedProperty atpProperties,
java.lang.String astrDN,
short anMemberType)
Updates an entity (member) with the specified properties.
|
public static final java.lang.String COPYRIGHT
public static VMMProxy getInstance() throws ECSystemException
ECSystemException
- if the VMM service is not available.public commonj.sdo.DataObject checkPassword(java.lang.String astrLogonID, java.lang.String astrPassword) throws com.ibm.websphere.wim.exception.WIMException, ECException, java.rmi.RemoteException
astrLogonID
- the logon ID of the user, for example, "wcsadmin" or "uid=wcsadmin,o=root organization".astrPassword
- the plain text password.com.ibm.websphere.wim.exception.WIMException
- if a VMM error occurs.ECException
- if VMM is not available.java.rmi.RemoteException
- if a remote exception occurs.public commonj.sdo.DataObject createMember(TypedProperty atpProperties, short anMemberType, java.lang.String astrParentDN) throws com.ibm.websphere.wim.exception.WIMException, ECException, java.rmi.RemoteException
atpProperties
- the properties of the member to be created.anMemberType
- The member type: astrParentDN
- the DN of the member's parent organization.com.ibm.websphere.wim.exception.WIMException
- if a VMM error occurs.ECException
- if the VMM service is not available.java.rmi.RemoteException
- if a remote exception occurs.public commonj.sdo.DataObject updateMember(TypedProperty atpProperties, java.lang.String astrDN, short anMemberType) throws com.ibm.websphere.wim.exception.WIMException, ECException, java.rmi.RemoteException
atpProperties
- the properties of the member to be updated in LDAP.astrDN
- the distinguished name of the entity to be updated.anMemberType
- The member type: com.ibm.websphere.wim.exception.WIMException
- if a VMM error occurs.ECException
- if the VMM service is not available.java.rmi.RemoteException
- if a remote exception occurs.public commonj.sdo.DataObject getMemberByDN(java.lang.String astrDN) throws com.ibm.websphere.wim.exception.WIMException, ECException, java.rmi.RemoteException
astrDN
- the distinguished name of the member to be retrieved.com.ibm.websphere.wim.exception.WIMException
- if a VMM error occurs.ECException
- if the VMM service is not available.java.rmi.RemoteException
- if a remote exception occurs.public commonj.sdo.DataObject getMemberByUniqueId(java.lang.String astrUniqueId) throws com.ibm.websphere.wim.exception.WIMException, ECException, java.rmi.RemoteException
astrUniqueId
- the unique identifier of the member to be retrieved.com.ibm.websphere.wim.exception.WIMException
- if a VMM error occurs.ECException
- if the VMM service is not available.java.rmi.RemoteException
- if a remote exception occurs.public commonj.sdo.DataObject findUserByLogonId(java.lang.String astrRDNName, java.lang.String astrLogonId) throws com.ibm.websphere.wim.exception.WIMException, ECException, java.rmi.RemoteException
astrRDNName
- the Relative DN used for users, for example "uid".astrLogonId
- the logon ID, for example, "wcsadmin".com.ibm.websphere.wim.exception.WIMException
- if a VMM error occurs.ECException
- if the VMM service is not available.java.rmi.RemoteException
- if a remote exception occurs.public commonj.sdo.DataObject addMemberToGroups(java.util.ArrayList alstGroups, java.lang.String astrDN) throws com.ibm.websphere.wim.exception.WIMException, ECException, java.rmi.RemoteException
alstGroups
- A list of groups, identified by distinguished name.astrDN
- The distinguished name of the entity to be added to the groups.com.ibm.websphere.wim.exception.WIMException
- if a VMM error occurs.ECException
- if the VMM service is not available.java.rmi.RemoteException
- if a remote exception occurs.public commonj.sdo.DataObject removeMemberFromGroups(java.util.ArrayList alstGroups, java.lang.String astrDN) throws com.ibm.websphere.wim.exception.WIMException, ECException, java.rmi.RemoteException
alstGroups
- A list of groups, identified by distinguished name.astrDN
- The distinguished name of the entity to be added to the groups.com.ibm.websphere.wim.exception.WIMException
- if a VMM error occurs.ECException
- if the VMM service is not available.java.rmi.RemoteException
- if a remote exception occurs.public java.util.List deleteMember(java.lang.String astrDN) throws com.ibm.websphere.wim.exception.WIMException, ECException, java.rmi.RemoteException
astrDN
- the DN of the entity to be deleted.com.ibm.websphere.wim.exception.WIMException
- if a VMM error occurs.ECException
- if the VMM service is not available.java.rmi.RemoteException
- if a remote exception occurs.