Package com.atlassian.crowd.licensing

Class ApplicationLicensingServiceImpl

java.lang.Object

com.atlassian.crowd.licensing.ApplicationLicensingServiceImpl

All Implemented Interfaces:

ApplicationLicensingService

@Transactional
public class ApplicationLicensingServiceImpl
extends Object
implements ApplicationLicensingService

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APPLICATION_ID_PARAM

Constructor Summary

Constructors

Constructor

Description

ApplicationLicensingServiceImpl(DirectoryManager directoryManager, LicensingSummaryDao licensingSummaryDao, LicensedUserDao licensedUserDao, DirectoryInfoDao directoryInfoDao, ApplicationDAO applicationDAO, com.atlassian.beehive.ClusterLockService lockService, Clock clock, ApplicationLinkServiceSupplier serviceSupplier, com.atlassian.scheduler.SchedulerService schedulerService, ApplicationLicensingEnabledChecker licensingEnabledChecker)

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 productType, 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

Methods inherited from class java.lang.Object

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

Field Details

APPLICATION_ID_PARAM

public static final String APPLICATION_ID_PARAM

See Also:

• Constant Field Values

Constructor Details

ApplicationLicensingServiceImpl

public ApplicationLicensingServiceImpl(DirectoryManager directoryManager,
 LicensingSummaryDao licensingSummaryDao,
 LicensedUserDao licensedUserDao,
 DirectoryInfoDao directoryInfoDao,
 ApplicationDAO applicationDAO,
 com.atlassian.beehive.ClusterLockService lockService,
 Clock clock,
 ApplicationLinkServiceSupplier serviceSupplier,
 com.atlassian.scheduler.SchedulerService schedulerService,
 ApplicationLicensingEnabledChecker licensingEnabledChecker)

Method Details

canShowLicenseUsageForApplication

public boolean canShowLicenseUsageForApplication(Long applicationId)
                                          throws ApplicationNotFoundException

Description copied from interface: ApplicationLicensingService

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

Specified by:

canShowLicenseUsageForApplication in interface ApplicationLicensingService

Throws:

ApplicationNotFoundException

isVersionUptoDate

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

Description copied from interface: ApplicationLicensingService

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

Specified by:

isVersionUptoDate in interface ApplicationLicensingService

Throws:

ApplicationNotFoundException

listJiraTypes

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

Description copied from interface: ApplicationLicensingService

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

Specified by:

listJiraTypes in interface ApplicationLicensingService

Throws:

ApplicationNotFoundException

listDirectories

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

Description copied from interface: ApplicationLicensingService

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

Specified by:

listDirectories in interface ApplicationLicensingService

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

searchLicensedUsers

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

Description copied from interface: ApplicationLicensingService

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

Specified by:

searchLicensedUsers in interface ApplicationLicensingService

Parameters:

applicationId - application id

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

directoryId - directory id to which the user belong

productType - 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

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

Description copied from interface: ApplicationLicensingService

Return the licensing summary if available

Specified by:

getLicensingSummary in interface ApplicationLicensingService

Throws:

ApplicationNotFoundException

updateApplicationData

public boolean updateApplicationData(Application application)

Description copied from interface: ApplicationLicensingService

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

Specified by:

updateApplicationData in interface ApplicationLicensingService

Returns:

true if application data was updated, or else false

scheduleRefreshApplicationDataJobImmediately

public void scheduleRefreshApplicationDataJobImmediately(long applicationId)
                                                  throws ApplicationNotFoundException

Description copied from interface: ApplicationLicensingService

Schedules updating application license usage data immediately

Specified by:

scheduleRefreshApplicationDataJobImmediately in interface ApplicationLicensingService

Throws:

ApplicationNotFoundException

clearAllJobs

public void clearAllJobs(Application application)

Description copied from interface: ApplicationLicensingService

Clears all jobs scheduled for an application

Specified by:

clearAllJobs in interface ApplicationLicensingService

isLicensingConfigured

public boolean isLicensingConfigured(Long applicationId)
                              throws ApplicationNotFoundException

Description copied from interface: ApplicationLicensingService

Checks if licensing is configured for specific application

Specified by:

isLicensingConfigured in interface ApplicationLicensingService

Parameters:

applicationId - ID of application to check

Throws:

ApplicationNotFoundException