DirectoryService
API.public interface ContainerService
An LDAP Container consists of one or more LDAP Resources. In the case of a simple Container a single, Primary LDAP Resource will exist, and no other LDAP Resources.
For a multiple LDAP Container one Primary LDAP Resource will exists, and one or more Secondary Ldap Resources. Each of these Secondary LDAP Resources must be keyed, or joined, to the Primary using one or more Container Mappings.
The Container Mappings will specify which LDAP attributes links the Secondary to the Primary. So, for example, two LDAP entries in two LDAP directories may be joined by the 'sn' LDAP attribute in the Secondary matching the 'surname' LDAP attribute in the Primary. A Container Mapping may consist of several such attribute pairings between the Primary and Secondary LDAP Resource.
The Container may also contain Attribute Mappings. These define how a DE Business Attribute is mapped to an LDAP attribute. So, for example, a Business Attribute named 'Employee No' could be retrieved from an LDAP attribute called 'EMPNUM'.
COPYRIGHT: (C) 2007-2012 TIBCO Software Inc. All Rights Reserved.
Modifier and Type | Method and Description |
---|---|
boolean |
deleteLDAPContainer(long containerId,
boolean deleteResources)
Deprecated.
since AMX-BPM use
DirectoryService.deleteContainer(long, boolean) . |
com.tibco.n2.de.api.ldap.XmlLdapContainer |
getLDAPContainerDetail(long containerId)
Deprecated.
since AMX-BPM use
DirectoryService.listContainers() . |
com.tibco.n2.de.api.ldap.XmlLdapContainer[] |
listLDAPContainers(int empty)
Deprecated.
since AMX-BPM use
DirectoryService.listContainers() . |
long |
saveLDAPContainerDetail(com.tibco.n2.de.api.ldap.XmlLdapContainer detail)
Deprecated.
since AMX-BPM use
DirectoryService#saveContainer(String, String, com.tibco.bpm.de.api.base.XmlLdapSource, com.tibco.bpm.de.api.base.XmlSecondaryLdapSource[], com.tibco.bpm.de.api.base.XmlRestrictedOrg[]) . |
long saveLDAPContainerDetail(com.tibco.n2.de.api.ldap.XmlLdapContainer detail) throws com.tibco.n2.de.services.InternalServiceFault, com.tibco.n2.de.services.InvalidLDAPContainerFault
DirectoryService#saveContainer(String, String, com.tibco.bpm.de.api.base.XmlLdapSource, com.tibco.bpm.de.api.base.XmlSecondaryLdapSource[], com.tibco.bpm.de.api.base.XmlRestrictedOrg[])
.
If an existing container is being updated then the details provided will
overwrite all existing details for the container. Thus, an update must
contain all the existing details (generally this will have been retrieved
using getLDAPContainerDetail(long)
).
detail
- the LDAP Container information to be saved/updated.long
ID of the new or updated container.java.lang.RuntimeException
com.tibco.n2.de.services.InternalServiceFault
com.tibco.n2.de.services.InvalidLDAPContainerFault
com.tibco.n2.de.api.ldap.XmlLdapContainer[] listLDAPContainers(int empty) throws com.tibco.n2.de.services.InternalServiceFault
DirectoryService.listContainers()
.
To get more detail (including its Container Resources) use getLDAPContainerDetail(long)
,
passing the ID value of one of the entries from the list returned by this method.
empty
- not usedList
of LDAP Containers details for all existing LDAP containers.java.lang.RuntimeException
com.tibco.n2.de.services.InternalServiceFault
com.tibco.n2.de.api.ldap.XmlLdapContainer getLDAPContainerDetail(long containerId) throws com.tibco.n2.de.services.InternalServiceFault, com.tibco.n2.de.services.InvalidLDAPContainerFault
DirectoryService.listContainers()
.containerId
- The ID of the containerjava.lang.RuntimeException
com.tibco.n2.de.services.InternalServiceFault
com.tibco.n2.de.services.InvalidLDAPContainerFault
listLDAPContainers(int)
boolean deleteLDAPContainer(long containerId, boolean deleteResources) throws com.tibco.n2.de.services.InternalServiceFault, com.tibco.n2.de.services.InvalidLDAPContainerFault, com.tibco.n2.de.services.InternalDAOErrorFault
DirectoryService.deleteContainer(long, boolean)
.containerId
- The unique ID of the container.deleteResources
- true
delete the Resources derived from the LDAP
Container.boolean
value indicating if the call to
delete the LDAP Container Id was successful.java.lang.RuntimeException
com.tibco.n2.de.services.InternalServiceFault
com.tibco.n2.de.services.InvalidLDAPContainerFault
com.tibco.n2.de.services.InternalDAOErrorFault
Copyright © 2014 TIBCO Software Inc. All Rights Reserved.