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

Class ApplicationLicensingResource

java.lang.Object

com.atlassian.crowd.plugin.rest.service.resource.licensing.ApplicationLicensingResource

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

Resource for application licensing

Since:

3.5.0

Constructor Summary

Constructors

Constructor and Description
ApplicationLicensingResource(ApplicationLicensingController controller, com.atlassian.event.api.EventPublisher eventPublisher)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	exportLicensedUsers(Long applicationId, String search, String directoryId, String jiraType, Long lastLoginBefore, Long searchVersion, javax.servlet.http.HttpServletResponse response) Returns license consuming users for given application, matching provided restrictions
javax.ws.rs.core.Response	getLicensingSummary(Long applicationId, Long version, String jiraType) Return the licensing summary if available
javax.ws.rs.core.Response	listDirectories(Long applicationId, Long version, String jiraType, RestPageRequest restPageRequest) Returns list of directories linked to the users who are consuming licenses in the given application, matching provided version of data and subtype of the application, if it's Jira
javax.ws.rs.core.Response	listJiraTypes(Long applicationId, Long version) Returns list of application sub-types available for the given Jira application.
javax.ws.rs.core.Response	searchLicensedUsers(Long applicationId, LicensedUserSearchParameters searchParameters, RestPageRequest restPageRequest) Searches license consuming users along with the total count of users for given application, matching provided restrictions

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationLicensingResource

public ApplicationLicensingResource(ApplicationLicensingController controller,
                                    com.atlassian.event.api.EventPublisher eventPublisher)

Method Detail

searchLicensedUsers

@POST
 @Path(value="{applicationId}/licensed-users/search")
 @ExperimentalApi
public javax.ws.rs.core.Response searchLicensedUsers(@PathParam(value="applicationId")
                                                                                                                                   Long applicationId,
                                                                                                                                   LicensedUserSearchParameters searchParameters,
                                                                                                                                   @Context
                                                                                                                                   RestPageRequest restPageRequest)
                                                                                                                            throws ObjectNotFoundException

Searches license consuming users along with the total count of users for given application, matching provided restrictions

Parameters:

applicationId - the application's identifier

searchParameters - search restriction

restPageRequest - paging details

Throws:

ObjectNotFoundException

exportLicensedUsers

@GET
 @Produces(value="text/csv")
 @Path(value="{applicationId}/licensed-users/download")
 @ExperimentalApi
public javax.ws.rs.core.Response exportLicensedUsers(@PathParam(value="applicationId")
                                                                                                                                                                 Long applicationId,
                                                                                                                                                                 @QueryParam(value="search")
                                                                                                                                                                 String search,
                                                                                                                                                                 @QueryParam(value="directoryId")
                                                                                                                                                                 String directoryId,
                                                                                                                                                                 @QueryParam(value="jiraType")
                                                                                                                                                                 String jiraType,
                                                                                                                                                                 @QueryParam(value="lastLoginBefore")
                                                                                                                                                                 Long lastLoginBefore,
                                                                                                                                                                 @QueryParam(value="searchVersion")
                                                                                                                                                                 Long searchVersion,
                                                                                                                                                                 @Context
                                                                                                                                                                 javax.servlet.http.HttpServletResponse response)
                                                                                                                                                          throws ObjectNotFoundException,
                                                                                                                                                                 IOException

Returns license consuming users for given application, matching provided restrictions

Parameters:

applicationId - the application's identifier

search - search text

directoryId - the directory's identifier

jiraType - subtype, required only for Jira application

lastLoginBefore - last logged in date on or before

searchVersion - licensing data version

Throws:

ObjectNotFoundException

IOException

listDirectories

@GET
 @Path(value="{applicationId}/directories")
 @ExperimentalApi
public javax.ws.rs.core.Response listDirectories(@PathParam(value="applicationId")
                                                                                                                    Long applicationId,
                                                                                                                    @QueryParam(value="version")
                                                                                                                    Long version,
                                                                                                                    @QueryParam(value="jiraType")
                                                                                                                    String jiraType,
                                                                                                                    @Context
                                                                                                                    RestPageRequest restPageRequest)
                                                                                                             throws ApplicationNotFoundException

Returns list of directories linked to the users who are consuming licenses in the given application, matching provided version of data and subtype of the application, if it's Jira

Parameters:

applicationId - the application's identifier

version - licensing data version

jiraType - subtype of Jira, only if the application type is Jira

restPageRequest - Paginated request parameters

Throws:

ApplicationNotFoundException

listJiraTypes

@GET
 @Path(value="{applicationId}/jira-types")
 @ExperimentalApi
public javax.ws.rs.core.Response listJiraTypes(@PathParam(value="applicationId")
                                                                                                                 Long applicationId,
                                                                                                                 @QueryParam(value="version")
                                                                                                                 Long version)
                                                                                                          throws ApplicationNotFoundException

Returns list of application sub-types available for the given Jira application.

Parameters:

applicationId - the application's identifier

version - licensing data version

Throws:

ApplicationNotFoundException

getLicensingSummary

@GET
 @Path(value="{applicationId}/summary")
 @ExperimentalApi
public javax.ws.rs.core.Response getLicensingSummary(@PathParam(value="applicationId")
                                                                                                                    Long applicationId,
                                                                                                                    @QueryParam(value="version")
                                                                                                                    Long version,
                                                                                                                    @QueryParam(value="jiraType")
                                                                                                                    String jiraType)
                                                                                                             throws ApplicationNotFoundException

Return the licensing summary if available

Parameters:

applicationId - the application's identifier

version - licensing data version

jiraType - subtype, required only for Jira application

Throws:

ApplicationNotFoundException