DirectoryService
.public interface LDAPService
LDAP resources must be created as a shared resource before they are available to DE, DE is unable to create LDAP resources.
All methods except listLDAPEntities
require a valid
LDAP alias, the listLDAPEntities will retrieve the LDAP data via a
pre-defefined LDAPContainer.
COPYRIGHT: (C) 2007-2012 TIBCO Software Inc. All Rights Reserved.
Modifier and Type | Method and Description |
---|---|
com.tibco.n2.de.api.XmlResourceDetail[] |
listContainerResources(long containerId)
Deprecated.
since AMX-BPM 2.0.0 use
DirectoryService.listCandidateResources(long, com.tibco.bpm.de.api.base.XmlCandidateChoice.Enum) . |
com.tibco.n2.de.api.ldapservice.ListLDAPAttributeNamesResponseDocument.ListLDAPAttributeNamesResponse |
listLDAPAttributeNames(java.lang.String alias,
java.lang.String filter,
int sampleDataNumber,
java.lang.String baseDn)
Deprecated.
since AMX-BPM 2.0.0 use
DirectoryService.listAttributeNames(String, String, String, int) . |
com.tibco.n2.de.api.XmlLdapAttribute[] |
listLDAPAttributes(java.lang.String alias,
java.lang.String dn,
com.tibco.n2.de.api.XmlLdapAttributeSimple[] reqAttributes)
|
com.tibco.n2.de.api.XmlResourceDetail[] |
listLDAPEntities(long containerId,
boolean existingOnly)
Deprecated.
since AMX-BPM 2.0.0 use
DirectoryService.listCandidateResources(long, com.tibco.bpm.de.api.base.XmlCandidateChoice.Enum) . |
com.tibco.n2.de.api.XmlResourceDetail[] |
listLDAPEntities(long containerId,
int modelVersion,
boolean existingOnly)
Deprecated.
since AMX-BPM 2.0.0 use
DirectoryService.listCandidateResources(long, com.tibco.bpm.de.api.base.XmlCandidateChoice.Enum) . |
com.tibco.n2.de.api.ldapservice.ListLDAPSourcesResponseDocument.ListLDAPSourcesResponse.LdapSource[] |
listLDAPSources(int empty)
Deprecated.
since AMX-BPM 2.0.0 use
DirectoryService.listLdapConnections() . |
com.tibco.n2.de.api.ldapservice.ListLDAPSourcesResponseDocument.ListLDAPSourcesResponse.LdapSource[] listLDAPSources(int empty) throws com.tibco.n2.de.services.InternalServiceFault
DirectoryService.listLdapConnections()
.empty
- not usedList
of LDAP Sources.com.tibco.n2.de.services.InternalServiceFault
com.tibco.n2.de.api.ldapservice.ListLDAPAttributeNamesResponseDocument.ListLDAPAttributeNamesResponse listLDAPAttributeNames(java.lang.String alias, java.lang.String filter, int sampleDataNumber, java.lang.String baseDn) throws com.tibco.n2.de.services.InternalServiceFault
DirectoryService.listAttributeNames(String, String, String, int)
.The methods main use is to provide a list of all LDAP attributes available for the specified alias, these attributes may be used to map to DE business attributes.
Additionally it can be used to view sample data which may assist the administrator to further refine the LDAP filter string to include or exclude LDAP entries that are/aren't required.
alias
- LDAP alias of the shared resource to connect to.filter
- LDAP filter (standard LDAP search string format) to restrict
the number of matches in the call (objectclass=*) will return
all entries.sampleDataNumber
- If sampleDataNumber is greater than 0, then data for each
attribute will also be retrieved for that number of LDAP
entries. Note requesting too much data greatly increase the
memory requirments and impact performance.baseDN
- If supplied then allow user to specify an extra baseDN for the filter,
this will be used in addition to the basDN provided on the LDAP alias.com.tibco.n2.de.services.InternalServiceFault
com.tibco.n2.de.api.XmlLdapAttribute[] listLDAPAttributes(java.lang.String alias, java.lang.String dn, com.tibco.n2.de.api.XmlLdapAttributeSimple[] reqAttributes) throws com.tibco.n2.de.services.InternalServiceFault, com.tibco.n2.de.services.InvalidLDAPSearchFault, com.tibco.n2.de.services.InvalidLDAPSourceFault
DirectoryService.getCandidateDetail(String, String, com.tibco.bpm.de.api.base.XmlLdapEntryId[], long)
or DirectoryService.getLdapEntry(String, String, com.tibco.bpm.de.api.directory.GetLdapEntryDocument.GetLdapEntry.Attribute[])
.If requested attributes are specified, just return those attributes. Otherwise this method will return all attributes set for the identified resource. If a requested attribute isn't set for the given DN then that attributes value will be blank.
The data required for this call will be the data returned from a call to
getBusinessParameters
.
alias
- LDAP alias of the shared resource to connect to.dn
- The LDAP DN of the requested resource in the specified alias.reqAttributes
- List
of LDAP Attribute names that are to be
returned.List
of LDAP Attribute values for each
LDAP attribute specified by the reqAttributes parameter.com.tibco.n2.de.services.InternalServiceFault
com.tibco.n2.de.services.InvalidLDAPSearchFault
com.tibco.n2.de.services.InvalidLDAPSourceFault
com.tibco.n2.de.api.XmlResourceDetail[] listLDAPEntities(long containerId, boolean existingOnly) throws com.tibco.n2.de.services.InternalServiceFault, com.tibco.n2.de.services.InvalidLDAPContainerFault, com.tibco.n2.de.services.InvalidLDAPSearchFault, com.tibco.n2.de.services.InvalidLDAPSourceFault, com.tibco.n2.de.services.InvalidOrgModelVersionFault
DirectoryService.listCandidateResources(long, com.tibco.bpm.de.api.base.XmlCandidateChoice.Enum)
.
For an entity to be included it must have an entry in all the LDAPs
contained within an LDAP Container, see the
ContainerService
for
details. If an entity already exists as an Org-Model Resource, the name
and GUID of that Resource will be returned.
containerId
- the LDAP Container identifier.existingOnly
- if true
, only those entries that already
exist as an org resources within DE are returned, otherwise all
LDAP entries within the container are returned.List
of LDAP entities.com.tibco.n2.de.services.InternalServiceFault
com.tibco.n2.de.services.InvalidLDAPContainerFault
com.tibco.n2.de.services.InvalidLDAPSearchFault
com.tibco.n2.de.services.InvalidLDAPSourceFault
com.tibco.n2.de.services.InvalidOrgModelVersionFault
com.tibco.n2.de.api.XmlResourceDetail[] listLDAPEntities(long containerId, int modelVersion, boolean existingOnly) throws com.tibco.n2.de.services.InternalServiceFault, com.tibco.n2.de.services.InvalidLDAPContainerFault, com.tibco.n2.de.services.InvalidLDAPSearchFault, com.tibco.n2.de.services.InvalidLDAPSourceFault, com.tibco.n2.de.services.InvalidOrgModelVersionFault
DirectoryService.listCandidateResources(long, com.tibco.bpm.de.api.base.XmlCandidateChoice.Enum)
.
For an entity to be included it must have an entry in all the LDAPs
contained within an LDAP Container, see the
ContainerService
for
details. If an entity already exists as an Org-Model Resource, the name
and GUID of that Resource will be returned.
containerId
- the LDAP Container identifier.modelVersion
- the org-model version from which any values are to be
retrieved.existingOnly
- if true
, only those entries that already
exist as an org resources within DE are returned, otherwise all
LDAP entries within the container are returned.List
of LDAP entities.com.tibco.n2.de.services.InternalServiceFault
com.tibco.n2.de.services.InvalidLDAPContainerFault
com.tibco.n2.de.services.InvalidLDAPSearchFault
com.tibco.n2.de.services.InvalidLDAPSourceFault
com.tibco.n2.de.services.InvalidOrgModelVersionFault
com.tibco.n2.de.api.XmlResourceDetail[] listContainerResources(long containerId) throws com.tibco.n2.de.services.InvalidOrgModelVersionFault, com.tibco.n2.de.services.InvalidServiceRequestFault, com.tibco.n2.de.services.InternalServiceFault
DirectoryService.listCandidateResources(long, com.tibco.bpm.de.api.base.XmlCandidateChoice.Enum)
.If the given LDAP Container ID is 0, the result will contain those Resources created via the bootstrapping import (the admin users).
If the given LDAP Container ID is not recognised, the result will be contain no Resources - rather than raise and exception.
aParameters
- the LDAP Container ID whose Resources are to be listed.com.tibco.n2.de.services.InvalidOrgModelVersionFault
com.tibco.n2.de.services.InvalidServiceRequestFault
com.tibco.n2.de.services.InternalServiceFault
Copyright © 2014 TIBCO Software Inc. All Rights Reserved.