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

Class AliasResource

java.lang.Object

com.atlassian.crowd.plugin.rest.service.resource.application.AliasResource

public class AliasResource
extends Object

Constructor Summary

Constructors

Constructor and Description
AliasResource(ApplicationController applicationController)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	deleteAlias(long applicationId, String username)
javax.ws.rs.core.Response	deleteAllAliasesForUser(String username) Removes the alias for the given username in all the applications that are alias-enabled.
String	getAlias(long applicationId, String username)
Map<Long,String>	getAllAliasesForUserAsJson(String username)
String	getUsernameForAlias(long applicationId, String alias)
javax.ws.rs.core.Response	setAlias(long applicationId, String username, String alias)
javax.ws.rs.core.Response	setAllAliasesForUser(String username, Map<Long,String> aliasByApplication) Sets the alias for the given username in all the applications, replacing the previous alias set for the same username, if they exist.

Methods inherited from class java.lang.Object

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

Constructor Detail

AliasResource

public AliasResource(ApplicationController applicationController)

Method Detail

getAlias

public String getAlias(long applicationId,
                       String username)
                throws ApplicationNotFoundException

Throws:

ApplicationNotFoundException

setAlias

@XsrfProtectionExcluded
public javax.ws.rs.core.Response setAlias(long applicationId,
                                                                  String username,
                                                                  String alias)
                                                           throws ApplicationNotFoundException,
                                                                  AliasAlreadyInUseException

Throws:

ApplicationNotFoundException

AliasAlreadyInUseException

deleteAlias

@XsrfProtectionExcluded
public javax.ws.rs.core.Response deleteAlias(long applicationId,
                                                                     String username)
                                                              throws ApplicationNotFoundException,
                                                                     AliasAlreadyInUseException

Throws:

ApplicationNotFoundException

AliasAlreadyInUseException

getUsernameForAlias

public String getUsernameForAlias(long applicationId,
                                  String alias)
                           throws ApplicationNotFoundException

Throws:

ApplicationNotFoundException

getAllAliasesForUserAsJson

public Map<Long,String> getAllAliasesForUserAsJson(String username)

setAllAliasesForUser

public javax.ws.rs.core.Response setAllAliasesForUser(String username,
                                                      Map<Long,String> aliasByApplication)
                                               throws AliasAlreadyInUseException

Sets the alias for the given username in all the applications, replacing the previous alias set for the same username, if they exist. Applications that are not included in the map will have their aliases removed.

Parameters:

username - a Crowd username (does not need to exist)

aliasByApplication - a map keyed by application ID

Returns:

204 NO CONTENT if successful

Throws:

AliasAlreadyInUseException - if some of the aliases cannot be inserted (translates to 409 CONFLICT)

deleteAllAliasesForUser

public javax.ws.rs.core.Response deleteAllAliasesForUser(String username)

Removes the alias for the given username in all the applications that are alias-enabled.

Parameters:

username - a Crowd username (does not need to exist)

Returns:

204 NO CONTENT if successful