com.atlassian.crowd.plugin.rest.service.resource.admin

Class DirectoryAdminResource

java.lang.Object

com.atlassian.crowd.plugin.rest.service.resource.admin.DirectoryAdminResource

@Path(value="directory")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public class DirectoryAdminResource
extends Object

Represents a resource for directories, this resource is accessible by user-based authentication

Since:

3.3

Constructor Summary

Constructors

Constructor and Description
DirectoryAdminResource(DirectoryAdminController controller)

Method Summary

Modifier and Type	Method and Description
RestPage<DetailedDirectoryData>	getDetailedDirectories(RestPageRequest restPageRequest, String search, Boolean active) Lists detailed directory data for all directories which match the search and active criteria queried by the System Admin
DetailedDirectoryData	getDetailedDirectory(Long directoryId) Retrieves detailed directory data for directory specified by ID by system admin
RestPage<DirectoryData>	getManagedDirectories(RestPageRequest restPageRequest) Lists the directories managed by the logged in user
javax.ws.rs.core.Response	scheduleSynchronization(Long directoryId) Schedules a Synchronisation for the given directory specified

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DirectoryAdminResource

public DirectoryAdminResource(DirectoryAdminController controller)

Method Detail

getManagedDirectories

@GET
 @Path(value="managed")
 @ExperimentalApi
public RestPage<DirectoryData> getManagedDirectories(@Context
                                                                                                    RestPageRequest restPageRequest)
                                                                                             throws OperationFailedException,
                                                                                                    FeatureInaccessibleException

Lists the directories managed by the logged in user

Parameters:

restPageRequest - paginated request parameters

Returns:

a list of directories

Throws:

OperationFailedException

FeatureInaccessibleException

getDetailedDirectories

@GET
 @Path(value="detailed")
 @ExperimentalApi
public RestPage<DetailedDirectoryData> getDetailedDirectories(@Context
                                                                                                              RestPageRequest restPageRequest,
                                                                                                              @QueryParam(value="search")
                                                                                                              String search,
                                                                                                              @QueryParam(value="active")
                                                                                                              Boolean active)
                                                                                                       throws OperationFailedException,
                                                                                                              FeatureInaccessibleException

Lists detailed directory data for all directories which match the search and active criteria queried by the System Admin

Parameters:

restPageRequest - paginated request parameters

search - search request query

active - request query

Returns:

a list of detailed directories data matching system admins search criteria

Throws:

OperationFailedException

FeatureInaccessibleException

getDetailedDirectory

@GET
 @Path(value="detailed/{directoryId}")
 @ExperimentalApi
public DetailedDirectoryData getDetailedDirectory(@PathParam(value="directoryId")
                                                                                                                Long directoryId)
                                                                                                         throws DirectoryNotFoundException,
                                                                                                                FeatureInaccessibleException,
                                                                                                                OperationFailedException

Retrieves detailed directory data for directory specified by ID by system admin

Parameters:

directoryId - ID of Directory

Returns:

detailed directory data for specified directory

Throws:

DirectoryNotFoundException

FeatureInaccessibleException

OperationFailedException

scheduleSynchronization

@POST
 @Path(value="detailed/{directoryId}/synchronize")
 @ExperimentalApi
public javax.ws.rs.core.Response scheduleSynchronization(@PathParam(value="directoryId")
                                                                                                                                    Long directoryId)
                                                                                                                             throws DirectoryNotFoundException,
                                                                                                                                    FeatureInaccessibleException,
                                                                                                                                    OperationFailedException

Schedules a Synchronisation for the given directory specified

Parameters:

directoryId - ID of Directory

Returns:

empty response if successful

Throws:

DirectoryNotFoundException

FeatureInaccessibleException

OperationFailedException