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

Class ApplicationResource

java.lang.Object

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

@Path("application")
@Consumes({"application/xml","application/json"})
@Produces({"application/xml","application/json"})
public class ApplicationResource
extends Object

Represents an Application resource.

Since:

2.2

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APPLICATION_NAME_QUERY_PARAM
protected jakarta.servlet.http.HttpServletRequest	request
protected jakarta.ws.rs.core.UriInfo	uriInfo

Constructor Summary

Constructors

Constructor	Description
ApplicationResource(ApplicationController applicationController)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	addApplication(boolean includeRequestAddress, ApplicationEntity applicationEntity)
jakarta.ws.rs.core.Response	addRemoteAddress(long applicationId, RemoteAddressEntity remoteAddressEntity)
jakarta.ws.rs.core.Response	getApplicationById(long applicationId)
jakarta.ws.rs.core.Response	getApplications(String applicationName)
jakarta.ws.rs.core.Response	getRemoteAddresses(long applicationId)
jakarta.ws.rs.core.Response	removeApplication(long applicationId)
jakarta.ws.rs.core.Response	removeRemoteAddress(long applicationId, String remoteAddress)
jakarta.ws.rs.core.Response	updateApplication(long applicationId, ApplicationEntity applicationEntity)

Methods inherited from class java.lang.Object

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

Field Details

APPLICATION_NAME_QUERY_PARAM

public static final String APPLICATION_NAME_QUERY_PARAM

See Also:

• Constant Field Values

uriInfo

@Context
protected jakarta.ws.rs.core.UriInfo uriInfo

request

@Context
protected jakarta.servlet.http.HttpServletRequest request

Constructor Details

ApplicationResource

@Inject
public ApplicationResource(ApplicationController applicationController)

Method Details

getApplications

@GET
public jakarta.ws.rs.core.Response getApplications(@QueryParam("name")
 String applicationName)
                                            throws ApplicationNotFoundException

Throws:

ApplicationNotFoundException

getApplicationById

@GET
@Path("{applicationId}")
public jakarta.ws.rs.core.Response getApplicationById(@PathParam("applicationId")
 long applicationId)
                                               throws ApplicationNotFoundException

Throws:

ApplicationNotFoundException

addApplication

@POST
public jakarta.ws.rs.core.Response addApplication(@DefaultValue("false") @QueryParam("include-request-address")
 boolean includeRequestAddress,
 ApplicationEntity applicationEntity)
                                           throws DirectoryNotFoundException,
InvalidCredentialException,
ApplicationAlreadyExistsException

Throws:

DirectoryNotFoundException

InvalidCredentialException

ApplicationAlreadyExistsException

removeApplication

@DELETE
@Path("{applicationId}")
public jakarta.ws.rs.core.Response removeApplication(@PathParam("applicationId")
 long applicationId)
                                              throws ApplicationManagerException

Throws:

ApplicationManagerException

updateApplication

@PUT
@Path("{applicationId}")
public jakarta.ws.rs.core.Response updateApplication(@PathParam("applicationId")
 long applicationId,
 ApplicationEntity applicationEntity)
                                              throws ApplicationNotFoundException,
DirectoryNotFoundException,
ApplicationManagerException

Throws:

ApplicationNotFoundException

DirectoryNotFoundException

ApplicationManagerException

getRemoteAddresses

@GET
@Path("{applicationId}/remote_address")
public jakarta.ws.rs.core.Response getRemoteAddresses(@PathParam("applicationId")
 long applicationId)
                                               throws ApplicationNotFoundException

Throws:

ApplicationNotFoundException

addRemoteAddress

@POST
@Path("{applicationId}/remote_address")
public jakarta.ws.rs.core.Response addRemoteAddress(@PathParam("applicationId")
 long applicationId,
 RemoteAddressEntity remoteAddressEntity)
                                             throws ApplicationNotFoundException,
DirectoryNotFoundException,
ApplicationManagerException

Throws:

ApplicationNotFoundException

DirectoryNotFoundException

ApplicationManagerException

removeRemoteAddress

@DELETE
@Path("{applicationId}/remote_address")
public jakarta.ws.rs.core.Response removeRemoteAddress(@PathParam("applicationId")
 long applicationId,
 @QueryParam("address")
 String remoteAddress)
                                                throws ApplicationNotFoundException,
DirectoryNotFoundException,
ApplicationManagerException

Throws:

ApplicationNotFoundException

DirectoryNotFoundException

ApplicationManagerException