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

Class ApplicationAdminResource

java.lang.Object

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

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

Represents a service for managing applications

Constructor Summary

Constructors

Constructor and Description
ApplicationAdminResource(ApplicationAdminController appAdminController, EmailScanController emailScanController)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addApplicationDirectoryMapping(long applicationId, DirectoryMappingEntity directoryMappingEntity) Adds a directory mapping to the specified application.
javax.ws.rs.core.Response	deleteApplicationDirectoryMapping(long applicationId, long directoryId) Removes a directory mapping from an application.
ApplicationEntity	getApplication(long applicationId) Returns the application with the specified id
AccessBasedSynchronizationFilterTypeEntity	getApplicationAccessBasedSynchronizationFilter(long applicationId) Returns the Current Filter Type for Access Based Synchronization for the given Application
DirectoryMappingEntity	getApplicationDirectoryMapping(long applicationId, long directoryId) Returns the specified application's mapping to the specified directory
RestPage<DirectoryMappingEntity>	getApplicationDirectoryMappings(long applicationId, RestPageRequest pageRequest) The directory mappings of the specified application
RestPage<ApplicationEntity>	getApplications(RestPageRequest pageRequest, String name, Boolean isActive) Returns a paged list of all applications
javax.ws.rs.core.Response	getLatestScanResult(long applicationId)
javax.ws.rs.core.Response	reorderApplicationDirectoryMapping(long applicationId, long directoryId, ReorderEntity reorderEntity) Changes the position of the specified application-directory mapping
javax.ws.rs.core.Response	triggerEmailScan(long applicationId)
ApplicationEntity	updateApplication(long applicationId, ApplicationEntity applicationEntity) Updates the specified application
javax.ws.rs.core.Response	updateApplicationAccessBasedSynchronizationFilter(long applicationId, AccessBasedSynchronizationFilterTypeEntity filterEntity) Change the current Filter Type used for Access Based Synchronization for the given Application
DirectoryMappingEntity	updateApplicationDirectoryMapping(long applicationId, long directoryId, DirectoryMappingEntity directoryMappingEntity) Updates the specified directory mapping.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationAdminResource

public ApplicationAdminResource(ApplicationAdminController appAdminController,
                                EmailScanController emailScanController)

Method Detail

getApplications

@GET
 @ExperimentalApi
public RestPage<ApplicationEntity> getApplications(@Context
                                                                          RestPageRequest pageRequest,
                                                                          @QueryParam(value="name")
                                                                          String name,
                                                                          @QueryParam(value="active")
                                                                          Boolean isActive)

Returns a paged list of all applications

Parameters:

pageRequest - starting index and maximum number of results returned from the name

name - name criteria

isActive - criteria for status of an application

getApplication

@GET
 @Path(value="/{applicationId}")
 @ExperimentalApi
public ApplicationEntity getApplication(@PathParam(value="applicationId")
                                                                                                long applicationId)
                                                                                         throws ApplicationNotFoundException

Returns the application with the specified id

Parameters:

applicationId - The application's identifier

Throws:

ApplicationNotFoundException

updateApplication

@PUT
 @Path(value="/{applicationId}")
 @ExperimentalApi
public ApplicationEntity updateApplication(@PathParam(value="applicationId")
                                                                                                   long applicationId,
                                                                                                   ApplicationEntity applicationEntity)
                                                                                            throws ApplicationNotFoundException,
                                                                                                   ApplicationManagerException

Updates the specified application

Parameters:

applicationId - The application's identifier

applicationEntity - The application's configuration

Throws:

ApplicationNotFoundException

ApplicationManagerException

getApplicationDirectoryMappings

@GET
 @Path(value="/{applicationId}/directory-mapping")
 @ExperimentalApi
public RestPage<DirectoryMappingEntity> getApplicationDirectoryMappings(@PathParam(value="applicationId")
                                                                                                                                                  long applicationId,
                                                                                                                                                  @Context
                                                                                                                                                  RestPageRequest pageRequest)
                                                                                                                                           throws ApplicationNotFoundException

The directory mappings of the specified application

Parameters:

applicationId - The application's identifier

Throws:

ApplicationNotFoundException

getApplicationDirectoryMapping

@GET
 @Path(value="/{applicationId}/directory-mapping/{directoryId}")
 @ExperimentalApi
public DirectoryMappingEntity getApplicationDirectoryMapping(@PathParam(value="applicationId")
                                                                                                                                                     long applicationId,
                                                                                                                                                     @PathParam(value="directoryId")
                                                                                                                                                     long directoryId)
                                                                                                                                              throws DirectoryMappingNotFoundException,
                                                                                                                                                     ApplicationNotFoundException

Returns the specified application's mapping to the specified directory

Parameters:

applicationId - The application's identifier

directoryId - The directory's identifier

Throws:

DirectoryMappingNotFoundException

ApplicationNotFoundException

addApplicationDirectoryMapping

@POST
 @Path(value="/{applicationId}/directory-mapping")
 @ExperimentalApi
public javax.ws.rs.core.Response addApplicationDirectoryMapping(@PathParam(value="applicationId")
                                                                                                                                           long applicationId,
                                                                                                                                           DirectoryMappingEntity directoryMappingEntity)
                                                                                                                                    throws DirectoryMappingNotFoundException,
                                                                                                                                           DirectoryNotFoundException,
                                                                                                                                           ApplicationNotFoundException,
                                                                                                                                           OperationFailedException

Adds a directory mapping to the specified application. It is added as the last mapping for the application.

Parameters:

applicationId - the id of the application

Throws:

DirectoryMappingNotFoundException

DirectoryNotFoundException

ApplicationNotFoundException

OperationFailedException

updateApplicationDirectoryMapping

@PUT
 @Path(value="/{applicationId}/directory-mapping/{directoryId}")
 @ExperimentalApi
public DirectoryMappingEntity updateApplicationDirectoryMapping(@PathParam(value="applicationId")
                                                                                                                                                        long applicationId,
                                                                                                                                                        @PathParam(value="directoryId")
                                                                                                                                                        long directoryId,
                                                                                                                                                        DirectoryMappingEntity directoryMappingEntity)
                                                                                                                                                 throws ApplicationNotFoundException,
                                                                                                                                                        DirectoryMappingNotFoundException,
                                                                                                                                                        DirectoryNotFoundException,
                                                                                                                                                        OperationFailedException,
                                                                                                                                                        DirectoryMappingConstraintException

Updates the specified directory mapping. The fields specified will overwrite the current values. The unspecified fields will not be changed.

Parameters:

applicationId - the id of the application

directoryId - the id of the directory

Throws:

ApplicationNotFoundException

DirectoryMappingNotFoundException

DirectoryNotFoundException

OperationFailedException

DirectoryMappingConstraintException

deleteApplicationDirectoryMapping

@DELETE
 @Path(value="/{applicationId}/directory-mapping/{directoryId}")
 @ExperimentalApi
public javax.ws.rs.core.Response deleteApplicationDirectoryMapping(@PathParam(value="applicationId")
                                                                                                                                                              long applicationId,
                                                                                                                                                              @PathParam(value="directoryId")
                                                                                                                                                              long directoryId)
                                                                                                                                                       throws ApplicationNotFoundException,
                                                                                                                                                              DirectoryMappingNotFoundException,
                                                                                                                                                              ApplicationManagerException,
                                                                                                                                                              DirectoryMappingConstraintException

Removes a directory mapping from an application.

Parameters:

applicationId - the id of the application to remove the mapping for

directoryId - the id of the directory to remove the mapping for

Throws:

ApplicationNotFoundException

DirectoryMappingNotFoundException

ApplicationManagerException

DirectoryMappingConstraintException

reorderApplicationDirectoryMapping

@POST
 @Path(value="/{applicationId}/directory-mapping/{directoryId}/move")
 @ExperimentalApi
public javax.ws.rs.core.Response reorderApplicationDirectoryMapping(@PathParam(value="applicationId")
                                                                                                                                                                  long applicationId,
                                                                                                                                                                  @PathParam(value="directoryId")
                                                                                                                                                                  long directoryId,
                                                                                                                                                                  ReorderEntity reorderEntity)
                                                                                                                                                           throws ApplicationNotFoundException,
                                                                                                                                                                  DirectoryMappingNotFoundException,
                                                                                                                                                                  DirectoryNotFoundException

Changes the position of the specified application-directory mapping

Parameters:

applicationId - The application's identifier

directoryId - The directory's identifier

Throws:

ApplicationNotFoundException

DirectoryMappingNotFoundException

DirectoryNotFoundException

getApplicationAccessBasedSynchronizationFilter

@GET
 @Path(value="/{applicationId}/access-based-synchronization")
 @ExperimentalApi
public AccessBasedSynchronizationFilterTypeEntity getApplicationAccessBasedSynchronizationFilter(@PathParam(value="applicationId")
                                                                                                                                                                                      long applicationId)
                                                                                                                                                                               throws ApplicationNotFoundException

Returns the Current Filter Type for Access Based Synchronization for the given Application

Parameters:

applicationId - The application's identifier

Throws:

ApplicationNotFoundException

updateApplicationAccessBasedSynchronizationFilter

@PUT
 @Path(value="/{applicationId}/access-based-synchronization")
 @ExperimentalApi
public javax.ws.rs.core.Response updateApplicationAccessBasedSynchronizationFilter(@PathParam(value="applicationId")
                                                                                                                                                                        long applicationId,
                                                                                                                                                                        AccessBasedSynchronizationFilterTypeEntity filterEntity)
                                                                                                                                                                 throws ApplicationNotFoundException,
                                                                                                                                                                        ApplicationManagerException

Change the current Filter Type used for Access Based Synchronization for the given Application

Parameters:

applicationId - The application's identifier

filterEntity - The Filter Entity containing the new filter value

Throws:

ApplicationNotFoundException

ApplicationManagerException

triggerEmailScan

@POST
 @Path(value="/{applicationId}/emailscan")
public javax.ws.rs.core.Response triggerEmailScan(@PathParam(value="applicationId")
                                                                                                   long applicationId)

getLatestScanResult

@GET
 @Path(value="/{applicationId}/emailscan")
public javax.ws.rs.core.Response getLatestScanResult(@PathParam(value="applicationId")
                                                                                                     long applicationId)