public class DirectoryService extends java.lang.Object implements DirectoryService
Modifier and Type | Method and Description |
---|---|
boolean |
deleteContainer(long containerId,
boolean deleteResources)
Deletes the configuration of the identified LDAP Container.
|
com.tibco.bpm.de.api.directory.ExecuteLdapQueryResponseDocument.ExecuteLdapQueryResponse |
executeLdapQuery(java.lang.String ldapAlias,
java.lang.String baseDn,
java.lang.String ldapQuery)
Executes a given LDAP Query against the LDAP Connection identified by its
alias, and restricted to a given Base DN (may be null).
|
com.tibco.bpm.de.api.directory.ExecuteLdapQueryResponseDocument.ExecuteLdapQueryResponse |
executeLdapQuery(java.lang.String ldapAlias,
java.lang.String baseDn,
java.lang.String ldapQuery,
com.tibco.bpm.de.api.base.XmlLdapSearchScope.Enum aScope)
Executes a given LDAP Query against the LDAP Connection identified by its
alias, and restricted to a given Base DN (may be null).
|
com.tibco.bpm.de.api.directory.ExecuteLdapQueryResponseDocument.ExecuteLdapQueryResponse |
executeLdapQuery(java.lang.String ldapAlias,
java.lang.String baseDn,
java.lang.String ldapQuery,
com.tibco.bpm.de.api.base.XmlLdapSearchScope.Enum aScope,
int pageSize,
java.lang.String bookmark)
Executes a given LDAP Query against the LDAP Connection identified by its
alias, and restricted to a given Base DN (may be null).
|
com.tibco.bpm.de.api.directory.GetCandidateDetailResponseDocument.GetCandidateDetailResponse |
getCandidateDetail(java.lang.String ldapAlias,
java.lang.String ldapDn,
com.tibco.bpm.de.api.base.XmlLdapEntryId[] secondaryRefArray,
long containerId)
Returns the detail (including LDAP attribute values) for the candidate
Resource identified by the request.
|
com.tibco.bpm.de.api.directory.GetLdapEntryResponseDocument.GetLdapEntryResponse |
getLdapEntry(java.lang.String ldapAlias,
java.lang.String ldapDn,
com.tibco.bpm.de.api.directory.GetLdapEntryDocument.GetLdapEntry.Attribute[] attributeArray)
Returns the named attributes from the LDAP entry identified by the given LDAP
alias and DN.
|
com.tibco.bpm.de.api.directory.ListAttributeNamesResponseDocument.ListAttributeNamesResponse |
listAttributeNames(java.lang.String ldapAlias,
java.lang.String baseDn,
java.lang.String ldapQuery,
int sampleSize)
Identifies the names of the LDAP attributes belonging the entries identified
by evaluating the given query against the LDAP Connection identified by its
alias.
|
com.tibco.bpm.de.api.directory.ListAttributeNamesResponseDocument.ListAttributeNamesResponse |
listAttributeNames(java.lang.String ldapAlias,
java.lang.String baseDn,
java.lang.String ldapQuery,
com.tibco.bpm.de.api.base.XmlLdapSearchScope.Enum searchScope,
int sampleSize)
Identifies the names of the LDAP attributes belonging the entries
identified by evaluating the given query against the LDAP Connection
identified by its alias.
|
com.tibco.bpm.de.api.directory.ListCandidateResourcesResponseDocument.ListCandidateResourcesResponse |
listCandidateResources(long containerId,
com.tibco.bpm.de.api.base.XmlCandidateChoice.Enum include)
Lists the LDAP Entries, from the identified LDAP Container, that are
candidates for Resources.
|
com.tibco.bpm.de.api.directory.ListCandidateResourcesResponseDocument.ListCandidateResourcesResponse |
listCandidateResources(long containerId,
com.tibco.bpm.de.api.base.XmlCandidateChoice.Enum include,
int pageSize,
java.lang.String bookmark)
Lists the LDAP Entries, from the identified LDAP Container, that are
candidates for Resources.
|
com.tibco.bpm.de.api.base.XmlContainer[] |
listContainers()
Lists the full details of all configured LDAP Containers - including those
that have been flagged as inactive.
|
com.tibco.bpm.de.api.directory.ListLdapConnectionsResponseDocument.ListLdapConnectionsResponse.LdapConnection[] |
listLdapConnections()
Lists the LDAP Connection Shared Resources that are available to AMX-BPM.
|
long |
saveContainer(long aId,
java.lang.String aName,
java.lang.String aDescription,
com.tibco.bpm.de.api.base.XmlLdapGroupSource aPrimaryGroupLdap,
com.tibco.bpm.de.api.base.XmlSecondaryLdapQuerySource[] aSecondaryQueryLdap,
com.tibco.bpm.de.api.base.XmlSecondaryLdapGroupSource[] aSecondaryGroupLdap,
com.tibco.bpm.de.api.base.XmlRestrictedOrg[] aRestrictedOrg)
Updates an existing LdapContainer (identified by the given id value).
|
long |
saveContainer(long aId,
java.lang.String aName,
java.lang.String aDescription,
com.tibco.bpm.de.api.base.XmlLdapQuerySource aPrimaryQueryLdap,
com.tibco.bpm.de.api.base.XmlSecondaryLdapQuerySource[] aSecondaryQueryLdap,
com.tibco.bpm.de.api.base.XmlSecondaryLdapGroupSource[] aSecondaryGroupLdap,
com.tibco.bpm.de.api.base.XmlRestrictedOrg[] aRestrictedOrg)
Updates an existing LdapContainer (identified by the given id value).
|
long |
saveContainer(long id,
java.lang.String name,
java.lang.String description,
com.tibco.bpm.de.api.base.XmlLdapSource primaryLdap,
com.tibco.bpm.de.api.base.XmlLdapSource[] secondaryLdap,
com.tibco.bpm.de.api.base.XmlRestrictedOrg[] restrictedOrg)
Updates an existing LdapContainer (identified by the given id value).
|
long |
saveContainer(java.lang.String aName,
java.lang.String aDescription,
com.tibco.bpm.de.api.base.XmlLdapGroupSource aPrimaryGroupLdap,
com.tibco.bpm.de.api.base.XmlSecondaryLdapQuerySource[] aSecondaryQueryLdap,
com.tibco.bpm.de.api.base.XmlSecondaryLdapGroupSource[] aSecondaryGroupLdap,
com.tibco.bpm.de.api.base.XmlRestrictedOrg[] aRestrictedOrg)
Save a new LdapContainer configuration; where the primary LDAP Source
is for an LDAP Group.
|
long |
saveContainer(java.lang.String aName,
java.lang.String aDescription,
com.tibco.bpm.de.api.base.XmlLdapQuerySource aPrimaryQueryLdap,
com.tibco.bpm.de.api.base.XmlSecondaryLdapQuerySource[] aSecondaryQueryLdap,
com.tibco.bpm.de.api.base.XmlSecondaryLdapGroupSource[] aSecondaryGroupLdap,
com.tibco.bpm.de.api.base.XmlRestrictedOrg[] aRestrictedOrg)
Save a new LdapContainer configuration; where the primary LDAP Source is
for an LDAP Query.
|
long |
saveContainer(java.lang.String name,
java.lang.String description,
com.tibco.bpm.de.api.base.XmlLdapSource primaryLdap,
com.tibco.bpm.de.api.base.XmlLdapSource[] secondaryLdap,
com.tibco.bpm.de.api.base.XmlRestrictedOrg[] restrictedOrg)
Save a new LdapContainer configuration.
|
public com.tibco.bpm.de.api.directory.ListLdapConnectionsResponseDocument.ListLdapConnectionsResponse.LdapConnection[] listLdapConnections() throws com.tibco.n2.de.services.DirectoryEngineFault, com.tibco.n2.de.services.SecurityFault
listLdapConnections
in interface DirectoryService
com.tibco.n2.de.services.DirectoryEngineFault
com.tibco.n2.de.services.SecurityFault
public com.tibco.bpm.de.api.directory.GetLdapEntryResponseDocument.GetLdapEntryResponse getLdapEntry(java.lang.String ldapAlias, java.lang.String ldapDn, com.tibco.bpm.de.api.directory.GetLdapEntryDocument.GetLdapEntry.Attribute[] attributeArray) throws com.tibco.n2.de.services.DirectoryEngineFault, com.tibco.n2.de.services.SecurityFault
null
, or empty, the
result will include all attributes.getLdapEntry
in interface DirectoryService
ldapAlias
- the alias of the LDAP Connection to be used.ldapDn
- the DN of the LDAP entry whose attributes are to be returned.attributeArray
- the names of the LDAP attributes to be returned.com.tibco.n2.de.services.DirectoryEngineFault
com.tibco.n2.de.services.SecurityFault
public com.tibco.bpm.de.api.directory.ExecuteLdapQueryResponseDocument.ExecuteLdapQueryResponse executeLdapQuery(java.lang.String ldapAlias, java.lang.String baseDn, java.lang.String ldapQuery) throws com.tibco.n2.de.services.DirectoryEngineFault, com.tibco.n2.de.services.SecurityFault
executeLdapQuery
in interface DirectoryService
ldapAlias
- the alias of the LDAP Connection to be used.baseDn
- the optional base-DN from which the query is to be performed.ldapQuery
- the LDAP query to be executed.com.tibco.n2.de.services.DirectoryEngineFault
com.tibco.n2.de.services.SecurityFault
public com.tibco.bpm.de.api.directory.ExecuteLdapQueryResponseDocument.ExecuteLdapQueryResponse executeLdapQuery(java.lang.String ldapAlias, java.lang.String baseDn, java.lang.String ldapQuery, com.tibco.bpm.de.api.base.XmlLdapSearchScope.Enum aScope) throws com.tibco.n2.de.services.DirectoryEngineFault, com.tibco.n2.de.services.SecurityFault
A search-scope must be specified to limit the depth to which the search is performed.
executeLdapQuery
in interface DirectoryService
ldapAlias
- the alias of the LDAP Connection to be used.baseDn
- the optional base-DN from which the query is to be performed.ldapQuery
- the LDAP query to be executed.aScope
- the depth to which the search should be performed.com.tibco.n2.de.services.DirectoryEngineFault
com.tibco.n2.de.services.SecurityFault
public com.tibco.bpm.de.api.directory.ExecuteLdapQueryResponseDocument.ExecuteLdapQueryResponse executeLdapQuery(java.lang.String ldapAlias, java.lang.String baseDn, java.lang.String ldapQuery, com.tibco.bpm.de.api.base.XmlLdapSearchScope.Enum aScope, int pageSize, java.lang.String bookmark) throws com.tibco.n2.de.services.DirectoryEngineFault, com.tibco.n2.de.services.SecurityFault
A search-scope must be specified to limit the depth to which the search is performed.
executeLdapQuery
in interface DirectoryService
ldapAlias
- the alias of the LDAP Connection to be used.baseDn
- the optional base-DN from which the query is to be performed.ldapQuery
- the LDAP query to be executed.aScope
- the depth to which the search should be performed.pageSize
- maximum number of results to be returned in result setbookmark
- marker indicating current page in the result setcom.tibco.n2.de.services.DirectoryEngineFault
com.tibco.n2.de.services.SecurityFault
public com.tibco.bpm.de.api.directory.ListAttributeNamesResponseDocument.ListAttributeNamesResponse listAttributeNames(java.lang.String ldapAlias, java.lang.String baseDn, java.lang.String ldapQuery, int sampleSize) throws com.tibco.n2.de.services.DirectoryEngineFault, com.tibco.n2.de.services.SecurityFault
listAttributeNames
in interface DirectoryService
ldapAlias
- the alias of the LDAP Connection to be used.baseDn
- the optional base-DN from which the query is to be performed.ldapQuery
- the LDAP query to identify the entries from which attributes
are to be collated.sampleSize
- the number of LDAP entries from which sample values are to be
retrieved.com.tibco.n2.de.services.DirectoryEngineFault
com.tibco.n2.de.services.SecurityFault
public com.tibco.bpm.de.api.directory.ListAttributeNamesResponseDocument.ListAttributeNamesResponse listAttributeNames(java.lang.String ldapAlias, java.lang.String baseDn, java.lang.String ldapQuery, com.tibco.bpm.de.api.base.XmlLdapSearchScope.Enum searchScope, int sampleSize) throws com.tibco.n2.de.services.DirectoryEngineFault, com.tibco.n2.de.services.SecurityFault
listAttributeNames
in interface DirectoryService
ldapAlias
- the alias of the LDAP Connection to be used.baseDn
- the optional base-DN from which the query is to be
performed.ldapQuery
- the LDAP query to identify the entries from which
attributes are to be collated.seachScope
- the depth to which the search will be performed. One of
ONELEVEL or SUBTREE values can be specified.sampleSize
- the number of LDAP entries from which sample values are
to be retrieved.com.tibco.n2.de.services.DirectoryEngineFault
com.tibco.n2.de.services.SecurityFault
public com.tibco.bpm.de.api.base.XmlContainer[] listContainers() throws com.tibco.n2.de.services.DirectoryEngineFault, com.tibco.n2.de.services.SecurityFault
listContainers
in interface DirectoryService
com.tibco.n2.de.services.DirectoryEngineFault
com.tibco.n2.de.services.SecurityFault
public long saveContainer(java.lang.String name, java.lang.String description, com.tibco.bpm.de.api.base.XmlLdapSource primaryLdap, com.tibco.bpm.de.api.base.XmlLdapSource[] secondaryLdap, com.tibco.bpm.de.api.base.XmlRestrictedOrg[] restrictedOrg) throws com.tibco.n2.de.services.DirectoryEngineFault, com.tibco.n2.de.services.SecurityFault
saveContainer
in interface DirectoryService
name
- the name to be assigned to the LdapContainer.description
- the optional description for the LdapContainer.primaryLdap
- the primary LdapSource configuration.secondaryLdap
- the optional array of secondary LdapSource
configurations. This should be an array of
XmlSecondaryGroupLdapSource or XmlSecondaryTreeLdapSource.restrictedOrg
- the optional collection of Organisation identifiers
to which the LdapContainer will be restricted.com.tibco.n2.de.services.DirectoryEngineFault
com.tibco.n2.de.services.SecurityFault
DirectoryService.saveContainer(String, String, XmlLdapGroupSource, XmlSecondaryLdapQuerySource[], XmlSecondaryLdapGroupSource[], XmlRestrictedOrg[])
,
DirectoryService.saveContainer(String, String, XmlLdapQuerySource, XmlSecondaryLdapQuerySource[], XmlSecondaryLdapGroupSource[], XmlRestrictedOrg[])
public long saveContainer(java.lang.String aName, java.lang.String aDescription, com.tibco.bpm.de.api.base.XmlLdapQuerySource aPrimaryQueryLdap, com.tibco.bpm.de.api.base.XmlSecondaryLdapQuerySource[] aSecondaryQueryLdap, com.tibco.bpm.de.api.base.XmlSecondaryLdapGroupSource[] aSecondaryGroupLdap, com.tibco.bpm.de.api.base.XmlRestrictedOrg[] aRestrictedOrg) throws com.tibco.n2.de.services.DirectoryEngineFault, com.tibco.n2.de.services.SecurityFault
saveContainer
in interface DirectoryService
name
- the name to be assigned to the LdapContainer.description
- the optional description for the LdapContainer.aPrimaryQueryLdap
- the primary LdapSource configuration.aSecondaryQueryLdap
- the optional array of secondary LdapSource
configurations. This should be an array of
XmlSecondaryLdapQuerySource.aSecondaryGroupLdap
- the optional array of secondary LdapSource
configurations. This should be an array of
XmlSecondaryLdapGroupSource.restrictedOrg
- the optional collection of Organisation identifiers
to which the LdapContainer will be restricted.com.tibco.n2.de.services.DirectoryEngineFault
com.tibco.n2.de.services.SecurityFault
public long saveContainer(java.lang.String aName, java.lang.String aDescription, com.tibco.bpm.de.api.base.XmlLdapGroupSource aPrimaryGroupLdap, com.tibco.bpm.de.api.base.XmlSecondaryLdapQuerySource[] aSecondaryQueryLdap, com.tibco.bpm.de.api.base.XmlSecondaryLdapGroupSource[] aSecondaryGroupLdap, com.tibco.bpm.de.api.base.XmlRestrictedOrg[] aRestrictedOrg) throws com.tibco.n2.de.services.DirectoryEngineFault, com.tibco.n2.de.services.SecurityFault
saveContainer
in interface DirectoryService
name
- the name to be assigned to the LdapContainer.description
- the optional description for the LdapContainer.aPrimaryGroupLdap
- the primary LdapSource configuration.aSecondaryQueryLdap
- the optional array of secondary LdapSource
configurations. This should be an array of
XmlSecondaryLdapQuerySource.aSecondaryGroupLdap
- the optional array of secondary LdapSource
configurations. This should be an array of
XmlSecondaryLdapGroupSource.restrictedOrg
- the optional collection of Organisation identifiers
to which the LdapContainer will be restricted.com.tibco.n2.de.services.DirectoryEngineFault
com.tibco.n2.de.services.SecurityFault
public long saveContainer(long id, java.lang.String name, java.lang.String description, com.tibco.bpm.de.api.base.XmlLdapSource primaryLdap, com.tibco.bpm.de.api.base.XmlLdapSource[] secondaryLdap, com.tibco.bpm.de.api.base.XmlRestrictedOrg[] restrictedOrg) throws com.tibco.n2.de.services.DirectoryEngineFault, com.tibco.n2.de.services.SecurityFault
saveContainer
in interface DirectoryService
id
- the primary key ID for the LdapContainer to be updated.name
- the name to be assigned to the LdapContainer.description
- the optional description for the LdapContainer.primaryLdap
- the primary LdapSource configuration.secondaryLdap
- the optional array of secondary LdapSource
configurations. This should be an array of
XmlSecondaryGroupLdapSource or XmlSecondaryTreeLdapSource.restrictedOrg
- the optional collection of Organisation identifiers
to which the LdapContainer will be restricted.com.tibco.n2.de.services.DirectoryEngineFault
com.tibco.n2.de.services.SecurityFault
public long saveContainer(long aId, java.lang.String aName, java.lang.String aDescription, com.tibco.bpm.de.api.base.XmlLdapQuerySource aPrimaryQueryLdap, com.tibco.bpm.de.api.base.XmlSecondaryLdapQuerySource[] aSecondaryQueryLdap, com.tibco.bpm.de.api.base.XmlSecondaryLdapGroupSource[] aSecondaryGroupLdap, com.tibco.bpm.de.api.base.XmlRestrictedOrg[] aRestrictedOrg) throws com.tibco.n2.de.services.DirectoryEngineFault, com.tibco.n2.de.services.SecurityFault
saveContainer
in interface DirectoryService
name
- the name to be assigned to the LdapContainer.description
- the optional description for the LdapContainer.aPrimaryQueryLdap
- the primary LdapSource configuration.aSecondaryQueryLdap
- the optional array of secondary LdapSource
configurations. This should be an array of
XmlSecondaryLdapQuerySource.aSecondaryGroupLdap
- the optional array of secondary LdapSource
configurations. This should be an array of
XmlSecondaryLdapGroupSource.restrictedOrg
- the optional collection of Organisation identifiers
to which the LdapContainer will be restricted.com.tibco.n2.de.services.DirectoryEngineFault
com.tibco.n2.de.services.SecurityFault
public long saveContainer(long aId, java.lang.String aName, java.lang.String aDescription, com.tibco.bpm.de.api.base.XmlLdapGroupSource aPrimaryGroupLdap, com.tibco.bpm.de.api.base.XmlSecondaryLdapQuerySource[] aSecondaryQueryLdap, com.tibco.bpm.de.api.base.XmlSecondaryLdapGroupSource[] aSecondaryGroupLdap, com.tibco.bpm.de.api.base.XmlRestrictedOrg[] aRestrictedOrg) throws com.tibco.n2.de.services.DirectoryEngineFault, com.tibco.n2.de.services.SecurityFault
saveContainer
in interface DirectoryService
name
- the name to be assigned to the LdapContainer.description
- the optional description for the LdapContainer.aPrimaryGroupLdap
- the primary LdapSource configuration.aSecondaryQueryLdap
- the optional array of secondary LdapSource
configurations. This should be an array of
XmlSecondaryLdapQuerySource.aSecondaryGroupLdap
- the optional array of secondary LdapSource
configurations. This should be an array of
XmlSecondaryLdapGroupSource.restrictedOrg
- the optional collection of Organisation identifiers
to which the LdapContainer will be restricted.com.tibco.n2.de.services.DirectoryEngineFault
com.tibco.n2.de.services.SecurityFault
public com.tibco.bpm.de.api.directory.ListCandidateResourcesResponseDocument.ListCandidateResourcesResponse listCandidateResources(long containerId, com.tibco.bpm.de.api.base.XmlCandidateChoice.Enum include) throws com.tibco.n2.de.services.DirectoryEngineFault, com.tibco.n2.de.services.SecurityFault
listCandidateResources
in interface DirectoryService
containerId
- the ID of the LDAP Container from which candidates are
to be evaluated.include
- true
if existing resources are to be included.com.tibco.n2.de.services.DirectoryEngineFault
com.tibco.n2.de.services.SecurityFault
public com.tibco.bpm.de.api.directory.ListCandidateResourcesResponseDocument.ListCandidateResourcesResponse listCandidateResources(long containerId, com.tibco.bpm.de.api.base.XmlCandidateChoice.Enum include, int pageSize, java.lang.String bookmark) throws com.tibco.n2.de.services.DirectoryEngineFault, com.tibco.n2.de.services.SecurityFault
listCandidateResources
in interface DirectoryService
containerId
- the ID of the LDAP Container from which candidates are
to be evaluated.include
- true
if existing resources are to be included.pageSize
- maximum number of results to be returned in result setbookmark
- marker indicating current page in the result setcom.tibco.n2.de.services.DirectoryEngineFault
com.tibco.n2.de.services.SecurityFault
public com.tibco.bpm.de.api.directory.GetCandidateDetailResponseDocument.GetCandidateDetailResponse getCandidateDetail(java.lang.String ldapAlias, java.lang.String ldapDn, com.tibco.bpm.de.api.base.XmlLdapEntryId[] secondaryRefArray, long containerId) throws com.tibco.n2.de.services.DirectoryEngineFault, com.tibco.n2.de.services.SecurityFault
getCandidateDetail
in interface DirectoryService
ldapAlias
- the LDAP alias from the primary LDAP source of the resource
candidate.ldapDn
- the DN of the primary LDAP source of the resource candidate.secondaryRefArray
- the secondary LDAP source references of the resource
candidate - may be null
.containerId
- the Ldap Container from which the candidate is taken.com.tibco.n2.de.services.DirectoryEngineFault
com.tibco.n2.de.services.SecurityFault
public boolean deleteContainer(long containerId, boolean deleteResources) throws com.tibco.n2.de.services.DirectoryEngineFault, com.tibco.n2.de.services.SecurityFault
The response will indicate the success (true or false). In reality, the response will always indicate success; any failure will be indicated by an fault being raised.
deleteContainer
in interface DirectoryService
containerId
- the ID of the Ldap Container to be deleted.deleteResources
- true
if associated resources should
also be deleted.true
if the Ldap Container was deleted.com.tibco.n2.de.services.DirectoryEngineFault
com.tibco.n2.de.services.SecurityFault
Copyright © 2018 Cloud Software Group, Inc. All Rights Reserved.