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

Class AliasResource

java.lang.Object

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

@Path(value="aliases")
public class AliasResource
extends Object

Resource for managing aliases.

Since:

2.5.2

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) Removes user's alias in a specified application.
javax.ws.rs.core.Response	deleteAllAliasesForUser(String username) Removes all aliases of the specified user from all applications, even from applications where aliasing is disabled.
String	getAlias(long applicationId, String username) Returns the user's alias in the specified application.
Map<Long,String>	getAllAliasesForUserAsJson(String username) Returns all aliases of the specified user from all alias-enabled applications.
String	getUsernameForAlias(long applicationId, String alias) Returns user's username in a specified application.
javax.ws.rs.core.Response	setAlias(long applicationId, String username, String alias) Sets the user's alias in the specified application.
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

@GET
 @Path(value="{applicationId}/alias")
 @Produces(value="text/plain; charset=utf-8")
public String getAlias(@PathParam(value="applicationId")
                                                                                                                long applicationId,
                                                                                                                @QueryParam(value="user")
                                                                                                                String username)
                                                                                                         throws ApplicationNotFoundException,
                                                                                                                com.sun.jersey.api.NotFoundException

Returns the user's alias in the specified application.

Parameters:

username - username in Crowd

Throws:

ApplicationNotFoundException

com.sun.jersey.api.NotFoundException

setAlias

@PUT
 @Path(value="{applicationId}/alias")
 @XsrfProtectionExcluded
 @Consumes(value="text/plain")
public javax.ws.rs.core.Response setAlias(@PathParam(value="applicationId")
                                                                                                                                             long applicationId,
                                                                                                                                             @QueryParam(value="user")
                                                                                                                                             String username,
                                                                                                                                             String alias)
                                                                                                                                      throws ApplicationNotFoundException,
                                                                                                                                             AliasAlreadyInUseException

Sets the user's alias in the specified application.

Parameters:

username - username in Crowd

Throws:

ApplicationNotFoundException

AliasAlreadyInUseException

deleteAlias

@DELETE
 @Path(value="{applicationId}/alias")
 @XsrfProtectionExcluded
public javax.ws.rs.core.Response deleteAlias(@PathParam(value="applicationId")
                                                                                                                    long applicationId,
                                                                                                                    @QueryParam(value="user")
                                                                                                                    String username)
                                                                                                             throws ApplicationNotFoundException,
                                                                                                                    AliasAlreadyInUseException

Removes user's alias in a specified application.

Parameters:

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

Throws:

ApplicationNotFoundException

AliasAlreadyInUseException

getUsernameForAlias

@GET
 @Path(value="{applicationId}/username")
 @Produces(value="text/plain; charset=utf-8")
public String getUsernameForAlias(@PathParam(value="applicationId")
                                                                                                                              long applicationId,
                                                                                                                              @QueryParam(value="alias")
                                                                                                                              String alias)
                                                                                                                       throws ApplicationNotFoundException

Returns user's username in a specified application.

Parameters:

alias - user's alias

Throws:

ApplicationNotFoundException

getAllAliasesForUserAsJson

@GET
 @Produces(value="application/json")
public Map<Long,String> getAllAliasesForUserAsJson(@QueryParam(value="user")
                                                                                             String username)

Returns all aliases of the specified user from all alias-enabled applications.

Parameters:

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

setAllAliasesForUser

@PUT
 @Consumes(value="application/json")
public javax.ws.rs.core.Response setAllAliasesForUser(@QueryParam(value="user")
                                                                                                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 - username in Crowd (does not need to exist)

aliasByApplication - map of aliases keyed by application ID

Throws:

AliasAlreadyInUseException

deleteAllAliasesForUser

@DELETE
public javax.ws.rs.core.Response deleteAllAliasesForUser(@QueryParam(value="user")
                                                                 String username)

Removes all aliases of the specified user from all applications, even from applications where aliasing is disabled.

Parameters:

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