com.atlassian.crowd.manager.license

Class CrowdLicenseManagerImpl

java.lang.Object

com.atlassian.crowd.manager.license.CrowdLicenseManagerImpl

All Implemented Interfaces:

CrowdLicenseManager

@Transactional
public class CrowdLicenseManagerImpl
extends Object
implements CrowdLicenseManager

Field Summary

Fields

Modifier and Type	Field and Description
static EntityQuery<Application>	ACTIVE_APPS_QUERY
static EntityQuery<String>	ACTIVE_USERS_QUERY
static EntityQuery<String>	ALL_USERS_QUERY

Constructor Summary

Constructors

Constructor and Description
CrowdLicenseManagerImpl(PropertyManager propertyManager, ApplicationManager applicationManager, DirectoryManager directoryManager, CrowdLicenseStore licenseStore, ClusterService clusterService, com.atlassian.event.api.EventPublisher eventPublisher)

Method Summary

Modifier and Type	Method and Description
int	getCurrentResourceUsageTotal() This will calculate the number of unique Principals currently being used by Crowd.
com.atlassian.extras.api.crowd.CrowdLicense	getLicense() This will retrieve the license for the currently running Crowd instance.
com.atlassian.extras.api.crowd.CrowdLicense	getLicense(String licenseKey) This will parse a license key into a license.
String	getRawLicense() This will retrieve the license key for the currently running Crowd instance.
boolean	isBuildWithinMaintenancePeriod(com.atlassian.extras.api.crowd.CrowdLicense license) Return's true if the current Build is within the maintenance period for the Crowd license
boolean	isBuildWithinMaintenancePeriod(String licenseKey)
boolean	isLicenseKeyValid(String licenseKey) Will validate that a given License key is valid
boolean	isLicenseValid() This will evaluate against the current license stored in Crowd LicenseStore.
boolean	isLicenseValid(com.atlassian.extras.api.crowd.CrowdLicense license) Same logic as CrowdLicenseManager.isLicenseValid()
boolean	isResourceTotalOverLimit(float limit, int currentResourceCount) Calculates the percentage of currentResourceCount over the user limit on a license and returns true or false if the percentage is above the passed in limit.
boolean	isResourceTotalUnderLimitInLicenseKey(String licenseKey) Validate if a given license key has a higher resource limit than current total resource count
boolean	isSetupLicenseKeyValid(String licenseKey) Checks if a license key valid for set up.
com.atlassian.extras.api.crowd.CrowdLicense	storeLicense(String licenseKey) This will store the license in the LicenseStore for the currently running Crowd instance.

Methods inherited from class java.lang.Object

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

Field Detail

ACTIVE_USERS_QUERY

public static final EntityQuery<String> ACTIVE_USERS_QUERY

ALL_USERS_QUERY

public static final EntityQuery<String> ALL_USERS_QUERY

ACTIVE_APPS_QUERY

public static final EntityQuery<Application> ACTIVE_APPS_QUERY

Constructor Detail

CrowdLicenseManagerImpl

public CrowdLicenseManagerImpl(PropertyManager propertyManager,
                               ApplicationManager applicationManager,
                               DirectoryManager directoryManager,
                               CrowdLicenseStore licenseStore,
                               ClusterService clusterService,
                               com.atlassian.event.api.EventPublisher eventPublisher)

Method Detail

getLicense

public com.atlassian.extras.api.crowd.CrowdLicense getLicense()

Description copied from interface: CrowdLicenseManager

This will retrieve the license for the currently running Crowd instance.

Specified by:

getLicense in interface CrowdLicenseManager

Returns:

com.atlassian.license.License or null if not set.

See Also:

CrowdLicenseManager.getLicense()

getLicense

public com.atlassian.extras.api.crowd.CrowdLicense getLicense(String licenseKey)

Description copied from interface: CrowdLicenseManager

This will parse a license key into a license.

Specified by:

getLicense in interface CrowdLicenseManager

Parameters:

licenseKey - license string

Returns:

license

getRawLicense

public String getRawLicense()

Description copied from interface: CrowdLicenseManager

This will retrieve the license key for the currently running Crowd instance.

Specified by:

getRawLicense in interface CrowdLicenseManager

Returns:

raw license key.

storeLicense

public com.atlassian.extras.api.crowd.CrowdLicense storeLicense(String licenseKey)
                                                         throws CrowdLicenseManagerException

Description copied from interface: CrowdLicenseManager

This will store the license in the LicenseStore for the currently running Crowd instance.

Specified by:

storeLicense in interface CrowdLicenseManager

Throws:

CrowdLicenseManagerException

isLicenseValid

public boolean isLicenseValid()

Description copied from interface: CrowdLicenseManager

This will evaluate against the current license stored in Crowd LicenseStore.

Will return true if the License has not gone beyond its resource total and if the user is not running an evaluation version and it has not expired. This is an overriding method to @see isLicenseValid(License license), so will call getLicense() internally.

Specified by:

isLicenseValid in interface CrowdLicenseManager

Returns:

true if License has not gone beyond resource limit or is not an evalution and is expired.

See Also:

CrowdLicenseManager.isLicenseValid()

isSetupLicenseKeyValid

public boolean isSetupLicenseKeyValid(String licenseKey)

Description copied from interface: CrowdLicenseManager

Checks if a license key valid for set up. In particular, it does not check the current user count as there are no users configured when initially entering a license in the setup process.

Specified by:

isSetupLicenseKeyValid in interface CrowdLicenseManager

Parameters:

licenseKey - the String to validate.

Returns:

true if an only if the license is valid, otherwise false.

isLicenseValid

public boolean isLicenseValid(com.atlassian.extras.api.crowd.CrowdLicense license)

Description copied from interface: CrowdLicenseManager

Same logic as CrowdLicenseManager.isLicenseValid()

Specified by:

isLicenseValid in interface CrowdLicenseManager

isLicenseKeyValid

public boolean isLicenseKeyValid(String licenseKey)

Description copied from interface: CrowdLicenseManager

Will validate that a given License key is valid

Specified by:

isLicenseKeyValid in interface CrowdLicenseManager

Parameters:

licenseKey - the String to validate

Returns:

true if an only if the license is valid, otherwise false

getCurrentResourceUsageTotal

public int getCurrentResourceUsageTotal()
                                 throws CrowdLicenseManagerException

Description copied from interface: CrowdLicenseManager

This will calculate the number of unique Principals currently being used by Crowd. Please note: this is an expensive call and is actually stored in the database by a Quartz process LicenseResourceJob. Please use consider using PropertyManager.getCurrentLicenseResourceTotal() Note: Do not call this method from the web layer, as this is wrapped in a Spring managed transaction

Specified by:

getCurrentResourceUsageTotal in interface CrowdLicenseManager

Returns:

the number of users/principals.

Throws:

CrowdLicenseManagerException

See Also:

CrowdLicenseManager.getCurrentResourceUsageTotal()

isResourceTotalOverLimit

public boolean isResourceTotalOverLimit(float limit,
                                        int currentResourceCount)

Description copied from interface: CrowdLicenseManager

Calculates the percentage of currentResourceCount over the user limit on a license and returns true or false if the percentage is above the passed in limit.

Specified by:

isResourceTotalOverLimit in interface CrowdLicenseManager

Parameters:

limit - the percentage limit to test against

currentResourceCount - the current number of resources in the system.

Returns:

true if over limit, false otherwise.

See Also:

CrowdLicenseManager.isResourceTotalOverLimit(float, int)

isBuildWithinMaintenancePeriod

public boolean isBuildWithinMaintenancePeriod(com.atlassian.extras.api.crowd.CrowdLicense license)

Description copied from interface: CrowdLicenseManager

Return's true if the current Build is within the maintenance period for the Crowd license

Specified by:

isBuildWithinMaintenancePeriod in interface CrowdLicenseManager

isBuildWithinMaintenancePeriod

public boolean isBuildWithinMaintenancePeriod(String licenseKey)

Specified by:

isBuildWithinMaintenancePeriod in interface CrowdLicenseManager

isResourceTotalUnderLimitInLicenseKey

public boolean isResourceTotalUnderLimitInLicenseKey(String licenseKey)

Description copied from interface: CrowdLicenseManager

Validate if a given license key has a higher resource limit than current total resource count

Specified by:

isResourceTotalUnderLimitInLicenseKey in interface CrowdLicenseManager

Parameters:

licenseKey - the license key String to validate

Returns:

true if license limit is higher than current total resource count, false otherwise