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

Class DirectoryResource

java.lang.Object

com.atlassian.crowd.plugin.rest.service.resource.directory.DirectoryResource

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

Represents an Directory management resource.

Since:

2.10

Constructor Summary

Constructors

Constructor and Description
DirectoryResource(DirectoryController directoryController)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	testAzureAdConnection(AzureAdConnectionTestEntity connectionTestData) Tests connection to the specified Azure Active Directory.
javax.ws.rs.core.Response	testAzureAdConnection(Long id, AzureAdConnectionTestEntity connectionTestData) Tests connection to the specified Azure Active Directory.
javax.ws.rs.core.Response	testCrowdConnection(CrowdConnectionTestEntity connectionTestData) Tests connection to the specified Remote Crowd directory
javax.ws.rs.core.Response	testCrowdConnection(Long id, CrowdConnectionTestEntity connectionTestData) Tests connection to the specified Remote Crowd directory.
javax.ws.rs.core.Response	testLdapConnection(LdapConnectionTestEntity connectionTestData) Tests connection to the specified LDAP server.
javax.ws.rs.core.Response	testLdapConnection(Long id, LdapConnectionTestEntity connectionTestData) Tests connection to the specified LDAP server.
javax.ws.rs.core.Response	testSearch(LdapSearchTestEntity ldapConfiguration) Tests search with the provided LDAP directory configuration
javax.ws.rs.core.Response	testSearch(LdapSearchTestEntity ldapConfiguration, Long id) Tests search with the provided LDAP directory configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryResource

public DirectoryResource(DirectoryController directoryController)

Method Detail

testLdapConnection

@POST
 @Path(value="testldap")
public javax.ws.rs.core.Response testLdapConnection(LdapConnectionTestEntity connectionTestData)
                                                                            throws OperationFailedException,
                                                                                   DirectoryTestFailedException,
                                                                                   ValidationFailedException

Tests connection to the specified LDAP server.

Parameters:

connectionTestData - An entity with data required to connect to the server

Throws:

OperationFailedException

DirectoryTestFailedException

ValidationFailedException

testLdapConnection

@POST
 @Path(value="testldap/{id}")
public javax.ws.rs.core.Response testLdapConnection(@PathParam(value="id")
                                                                                        Long id,
                                                                                        LdapConnectionTestEntity connectionTestData)
                                                                                 throws DirectoryNotFoundException,
                                                                                        OperationFailedException,
                                                                                        DirectoryTestFailedException,
                                                                                        ValidationFailedException

Tests connection to the specified LDAP server. Should be used for existing directories.

Parameters:

id - the database id of the directory to test

connectionTestData - An entity with data required to connect to the server

Throws:

DirectoryNotFoundException

OperationFailedException

DirectoryTestFailedException

ValidationFailedException

testCrowdConnection

@POST
 @Path(value="testcrowd")
public javax.ws.rs.core.Response testCrowdConnection(CrowdConnectionTestEntity connectionTestData)
                                                                              throws OperationFailedException,
                                                                                     DirectoryTestFailedException,
                                                                                     ValidationFailedException

Tests connection to the specified Remote Crowd directory

Parameters:

connectionTestData - An entity with data required to connect to the Remote Crowd directory

Throws:

OperationFailedException

DirectoryTestFailedException

ValidationFailedException

testCrowdConnection

@POST
 @Path(value="testcrowd/{id}")
public javax.ws.rs.core.Response testCrowdConnection(@PathParam(value="id")
                                                                                          Long id,
                                                                                          CrowdConnectionTestEntity connectionTestData)
                                                                                   throws DirectoryNotFoundException,
                                                                                          OperationFailedException,
                                                                                          DirectoryTestFailedException,
                                                                                          ValidationFailedException

Tests connection to the specified Remote Crowd directory. Should be used for existing directories.

Parameters:

id - The ID of the Crowd server which will have its settings changed

connectionTestData - An entity with data required to connect to the Remote Crowd directory

Throws:

DirectoryNotFoundException

OperationFailedException

DirectoryTestFailedException

ValidationFailedException

testAzureAdConnection

@POST
 @Path(value="testazuread")
public javax.ws.rs.core.Response testAzureAdConnection(AzureAdConnectionTestEntity connectionTestData)
                                                                                  throws OperationFailedException,
                                                                                         DirectoryTestFailedException,
                                                                                         ValidationFailedException

Tests connection to the specified Azure Active Directory.

Parameters:

connectionTestData - An entity with data required to connect to the Azure Active Directory

Throws:

OperationFailedException

DirectoryTestFailedException

ValidationFailedException

testAzureAdConnection

@POST
 @Path(value="testazuread/{id}")
public javax.ws.rs.core.Response testAzureAdConnection(@PathParam(value="id")
                                                                                              Long id,
                                                                                              AzureAdConnectionTestEntity connectionTestData)
                                                                                       throws OperationFailedException,
                                                                                              DirectoryTestFailedException,
                                                                                              DirectoryNotFoundException,
                                                                                              ValidationFailedException

Tests connection to the specified Azure Active Directory. Should be used for existing directories.

Parameters:

id - The database ID of the directory to test

connectionTestData - An entity with data required to connect to the Azure Active Directory

Throws:

OperationFailedException

DirectoryTestFailedException

DirectoryNotFoundException

ValidationFailedException

testSearch

@POST
 @Path(value="testsearch")
public javax.ws.rs.core.Response testSearch(LdapSearchTestEntity ldapConfiguration)
                                                                      throws OperationFailedException,
                                                                             DirectoryTestFailedException,
                                                                             ValidationFailedException

Tests search with the provided LDAP directory configuration

Parameters:

ldapConfiguration - An entity containing directory parameters

Throws:

OperationFailedException

DirectoryTestFailedException

ValidationFailedException

testSearch

@POST
 @Path(value="testsearch/{id}")
public javax.ws.rs.core.Response testSearch(LdapSearchTestEntity ldapConfiguration,
                                                                                  @PathParam(value="id")
                                                                                  Long id)
                                                                           throws OperationFailedException,
                                                                                  DirectoryNotFoundException,
                                                                                  DirectoryTestFailedException,
                                                                                  ValidationFailedException

Tests search with the provided LDAP directory configuration. Should be used for existing directories.

Parameters:

ldapConfiguration - An entity containing directory parameters

id - ID of the directory for which the settings will be tested

Throws:

OperationFailedException

DirectoryNotFoundException

DirectoryTestFailedException

ValidationFailedException