Atlassian Embedded Crowd - API
| com.atlassian.crowd.embedded.api.CrowdDirectoryService |
Provides the interface for performing Directory Operations in Crowd for applications embedding Crowd. Null parameters for methods may throw NullPointerException or IllegalArgumentException.
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Will add a new
Directory into the local database. | |||||||||||
Will return a
List<Directory> ordered by the order specified by the application. | |||||||||||
Will return a
Directory based on the given directoryId | |||||||||||
Returns the synchronisation information for the directory.
| |||||||||||
Retrieves the stored LDAP connection pool properties which will be applied when the system restarts.
| |||||||||||
Retrieves the system LDAP connection pool properties (i.e.
| |||||||||||
Returns true if the underlying directory implementation supports manual synchronisation of the directory's local cache.
| |||||||||||
Returns true if the given Directory is currently synchronising.
| |||||||||||
Will remove a directory from the Application, this will also remove all associated entities (users/groups/memberships).
| |||||||||||
Stores the provided LDAP connection pool properties so they can be applied when the system next restarts.
| |||||||||||
Will place the directory with the given
directoryId and the passed in position in the current list of directories configured for an application. | |||||||||||
Returns true if the underlying directory implementation supports nested groups.
| |||||||||||
Requests that this directory should update its cache by synchronising with the remote server.
| |||||||||||
Requests that this directory should update its cache by synchronising with the remote server.
| |||||||||||
Test if a connection to the directory server can be established.
| |||||||||||
Will update the
Directory. | |||||||||||
Will add a new Directory into the local database.
| directory | The directory to be saved |
|---|
Directory| OperationFailedException | if the operation failed for any reason |
|---|
Will return a List<Directory> ordered by the order specified by the application.
List<Directory> or if there are no directories, an empty list (this should never happen)
Will return a Directory based on the given directoryId
| directoryId | the id of the directory |
|---|
null if the directory is not found
Returns the synchronisation information for the directory. This includes the last sync start time and duration, and the current sync start time (if directory is currently synchronising).
| directoryId | ID of directory |
|---|
| OperationFailedException | if the operation failed for any reason |
|---|
Retrieves the stored LDAP connection pool properties which will be applied when the system restarts.
Retrieves the system LDAP connection pool properties (i.e. the currently active settings).
Returns true if the underlying directory implementation supports manual synchronisation of the directory's local cache.
| directoryId | ID of directory. |
|---|
| OperationFailedException | if the operation failed for any reason |
|---|
Returns true if the given Directory is currently synchronising.
| directoryId | ID of directory. |
|---|
| OperationFailedException | if the operation failed for any reason |
|---|
Will remove a directory from the Application, this will also remove all associated entities (users/groups/memberships). TODO: We should discuss this
| directoryId | the directory id of the Directory to remove. |
|---|
true if the directory and associated entities were removed, or false otherwise| DirectoryCurrentlySynchronisingException | if the Directory is currently synchronising. |
|---|---|
| OperationFailedException | if the directory does not exist or the operation failed for any other reason |
Stores the provided LDAP connection pool properties so they can be applied when the system next restarts.
| poolProperties | the LDAP connection pool properties to be stored and applied on the next restart |
|---|
Will place the directory with the given directoryId and the passed in position in the current list of directories configured for an application.
| directoryId | the id of the directory |
|---|---|
| position | the position in the list of directories where you would like this one to be |
| OperationFailedException | if the directory does not exist or the operation failed for any other reason |
|---|
Returns true if the underlying directory implementation supports nested groups.
| directoryId | ID of directory. |
|---|
| OperationFailedException | if the operation failed for any reason |
|---|
Requests that this directory should update its cache by synchronising with the remote server.
If a synchronisation is currently in progress when this method is called, then this method does nothing if runInBackGround is true, otherwise it will throw OperationFailedException.
| directoryId | ID of directory. |
|---|---|
| runInBackground | If True the synchronise will happen asynchronously. |
| OperationFailedException | if the operation failed for any reason |
|---|
Requests that this directory should update its cache by synchronising with the remote server. The synchronisation will occur asynchronously, i.e. this method returns immediately and the synchronization continues in the background.
If a synchronisation is currently in progress when this method is called, then this method does nothing.
| directoryId | ID of directory. |
|---|
| OperationFailedException | if the operation failed for any reason |
|---|
Test if a connection to the directory server can be established.
| directory | Directory to test |
|---|
| OperationFailedException | underlying directory implementation failed to execute the operation. |
|---|
Will update the Directory. The Directory must have at the bare minimum an getId(), getName(), getType() and getImplementationClass()}
| directory | the directory to update |
|---|
| OperationFailedException | if the directory does not exist or the operation failed for any other reason. |
|---|