Package com.atlassian.confluence.license.rest.resource

Class LicenseResource

java.lang.Object

com.atlassian.confluence.license.rest.resource.LicenseResource

@Consumes("application/json")
@Produces("application/json")
@Path("/license")
public class LicenseResource
extends Object

A REST endpoint that exposes info about users of this instance. Note that this endpoint will only provide usable data in the case of a "Confluence-only instance". DO NOT USE THIS endpoint for OnDemand instances as license information is be overridden by HAUP (Hosted Application User Provisioning)

Constructor Summary

Constructors

Constructor	Description
LicenseResource(LicenseWebFacade licenseWebFacade, BootstrapManager bootstrapManager, ClusterManager clusterManager, com.atlassian.sal.api.message.I18nResolver i18nResolver, LicenseService licenseService, UserChecker userChecker, com.atlassian.upm.api.license.DataCenterCrossgradeablePlugins dataCenterCrossgradeablePlugins)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	getDetails()	Return some of the parameters of this license.
jakarta.ws.rs.core.Response	getMaxUsers()	Return the number of users that is allowed by the current license
jakarta.ws.rs.core.Response	getOrganisation()	Return the organisation name of this Confluence
jakarta.ws.rs.core.Response	getRemainingUserCount()	Return the number of free slots on this Confluence instance
jakarta.ws.rs.core.Response	getUserCount()	Return the number of users that have access to this Confluence
jakarta.ws.rs.core.Response	validate(String licenseKey)

Methods inherited from class java.lang.Object

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

Constructor Details

LicenseResource

@Inject
public LicenseResource(@Qualifier("licenseWebFacade")
 LicenseWebFacade licenseWebFacade,
 BootstrapManager bootstrapManager,
 ClusterManager clusterManager,
 com.atlassian.sal.api.message.I18nResolver i18nResolver,
 LicenseService licenseService,
 UserChecker userChecker,
 com.atlassian.upm.api.license.DataCenterCrossgradeablePlugins dataCenterCrossgradeablePlugins)

Method Details

getDetails

@GET
@Path("/details")
public jakarta.ws.rs.core.Response getDetails()

Return some of the parameters of this license.

getOrganisation

@GET
@Path("/organisation")
public jakarta.ws.rs.core.Response getOrganisation()

Return the organisation name of this Confluence

getUserCount

@GET
@Path("/userCount")
public jakarta.ws.rs.core.Response getUserCount()

Return the number of users that have access to this Confluence

getRemainingUserCount

@GET
@Path("/remainingSeats")
public jakarta.ws.rs.core.Response getRemainingUserCount()

Return the number of free slots on this Confluence instance

Returns:

getMaxUsers

@GET
@Path("/maxUsers")
public jakarta.ws.rs.core.Response getMaxUsers()

Return the number of users that is allowed by the current license

validate

@POST
@Path("/validate")
@Consumes("application/x-www-form-urlencoded")
public jakarta.ws.rs.core.Response validate(@FormParam("licenseKey")
 String licenseKey)