com.atlassian.greenhopper.license

Interface SoftwareAuthorizationService

All Known Implementing Classes:

SoftwareAuthorizationServiceImpl

public interface SoftwareAuthorizationService

Method Summary

Modifier and Type	Method and Description
boolean	canUseApplication(com.atlassian.jira.user.ApplicationUser user) Determines whether the given user is allowed to access the JIRA Software application.
Collection<com.atlassian.application.api.ApplicationAccess.AccessError>	getSoftwareLicensingAccessErrors() Get any errors that would occur when accessing the Software application.
void	verifySoftwareLicense() Determines whether a valid license is present for the JIRA Software application.

Method Detail

canUseApplication

boolean canUseApplication(@Nullable
                          com.atlassian.jira.user.ApplicationUser user)

Determines whether the given user is allowed to access the JIRA Software application.

Parameters:

user - the user to check for access rights - if this is null, this method returns false

Returns:

true if the user has been assigned to JIRA Software and the application is backed by a license.

verifySoftwareLicense

void verifySoftwareLicense()
                    throws com.atlassian.extras.common.LicenseException

Determines whether a valid license is present for the JIRA Software application.

Throws:

com.atlassian.extras.common.LicenseException - if a Software license is not present, or if the Software license has expired, or if the number of users specified in the Software license has been exceeded.

getSoftwareLicensingAccessErrors

Collection<com.atlassian.application.api.ApplicationAccess.AccessError> getSoftwareLicensingAccessErrors()

Get any errors that would occur when accessing the Software application. Note, this only checks access errors resulting from licensing, not from particular users accessing the Software application.

Returns:

a collection of com.atlassian.greenhopper.license.ApplicationAccessError that represents various licensing violations. An empty collection means there is no violation.