Package com.atlassian.crowd.licensing

Interface ApplicationLicensingService

public interface ApplicationLicensingService

Component controlling the feature of application license usage monitoring, it is a god class for fetching usage data from the application as well as storing the data and serving the queries for it.

Method Summary

Modifier and Type	Method	Description
boolean	canShowLicenseUsageForApplication(Long applicationId)	Checks whether license usage data can be fetched/shown for the given application
void	clearAllJobs(Application application)	Clears all jobs scheduled for an application
Optional<ApplicationLicensingSummary>	getLicensingSummary(Long applicationId, String appSubType, Long version)	Return the licensing summary if available
boolean	isLicensingConfigured(Long applicationId)	Checks if licensing is configured for specific application
boolean	isVersionUptoDate(Long applicationId, String appSubType, Long version)	Checks whether requested version is up to date or not for the given ApplicationSubtype if supplied
List<ApplicationLicensedDirectory>	listDirectories(Long applicationId, String appSubType, Long version, int start, int limit)	Returns list of directories linked to the users who are consuming licenses in the given application
List<ApplicationSubtype>	listJiraTypes(Long applicationId, Long version)	Returns list of jira sub-types available for the given ApplicationType.JIRA application
void	scheduleRefreshApplicationDataJobImmediately(long applicationId)	Schedules updating application license usage data immediately
io.atlassian.fugue.Pair<List<ApplicationLicensedUser>,Long>	searchLicensedUsers(Long applicationId, String searchText, String directoryId, String appSubType, Long lastLoggedInDate, Long version, int start, int limit)	Returns list of license consuming users in the products along with the total count of users matching the supplied query
boolean	updateApplicationData(Application application)	Fetches the license usage data from the application and updates the local copy

Method Details

canShowLicenseUsageForApplication

boolean canShowLicenseUsageForApplication(Long applicationId)
                                   throws ApplicationNotFoundException

Checks whether license usage data can be fetched/shown for the given application

Throws:

ApplicationNotFoundException

isVersionUptoDate

boolean isVersionUptoDate(Long applicationId,
 String appSubType,
 Long version)
                   throws ApplicationNotFoundException

Checks whether requested version is up to date or not for the given ApplicationSubtype if supplied

Throws:

ApplicationNotFoundException

listJiraTypes

List<ApplicationSubtype> listJiraTypes(Long applicationId,
 Long version)
                                throws ApplicationNotFoundException

Returns list of jira sub-types available for the given ApplicationType.JIRA application

Throws:

IllegalArgumentException - if application is not Jira type

ApplicationNotFoundException

listDirectories

List<ApplicationLicensedDirectory> listDirectories(Long applicationId,
 String appSubType,
 Long version,
 int start,
 int limit)
                                            throws ApplicationNotFoundException

Returns list of directories linked to the users who are consuming licenses in the given application

Parameters:

applicationId - application id to search users for

appSubType - Jira subtype, only if the application type is Jira

version - version of data requested

start - start offset for the results

limit - maximum number of results

Throws:

ApplicationNotFoundException - if application id invalid

IllegalArgumentException - If version is not available

IllegalStateException - If supplied application sub type is invalid

searchLicensedUsers

io.atlassian.fugue.Pair<List<ApplicationLicensedUser>,Long> searchLicensedUsers(Long applicationId,
 String searchText,
 String directoryId,
 String appSubType,
 Long lastLoggedInDate,
 Long version,
 int start,
 int limit)
                                                                         throws ObjectNotFoundException

Returns list of license consuming users in the products along with the total count of users matching the supplied query

Parameters:

applicationId - application id

searchText - search text to be matched across username, email and full name

directoryId - directory id to which the user belong

appSubType - application subtype, only applicable for Jira application

lastLoggedInDate - last logged in date on or before

version - version

start - offset

limit - max number of results

Throws:

ObjectNotFoundException

getLicensingSummary

Optional<ApplicationLicensingSummary> getLicensingSummary(Long applicationId,
 String appSubType,
 Long version)
                                                   throws ApplicationNotFoundException

Return the licensing summary if available

Throws:

ApplicationNotFoundException

updateApplicationData

boolean updateApplicationData(Application application)

Fetches the license usage data from the application and updates the local copy

Returns:

true if application data was updated, or else false

scheduleRefreshApplicationDataJobImmediately

void scheduleRefreshApplicationDataJobImmediately(long applicationId)
                                           throws ApplicationNotFoundException

Schedules updating application license usage data immediately

Throws:

ApplicationNotFoundException

clearAllJobs

void clearAllJobs(Application application)

Clears all jobs scheduled for an application

isLicensingConfigured

boolean isLicensingConfigured(Long applicationId)
                       throws ApplicationNotFoundException

Checks if licensing is configured for specific application

Parameters:

applicationId - ID of application to check

Throws:

ApplicationNotFoundException