com.atlassian.jira.license

Class DefaultLicenseRoleManager

java.lang.Object

com.atlassian.jira.license.DefaultLicenseRoleManager

All Implemented Interfaces:

LicenseRoleManager

public final class DefaultLicenseRoleManager
extends Object
implements LicenseRoleManager

Default implementation of LicenseRoleManager.

Since:

6.3

Constructor Summary

Constructors

Constructor and Description
DefaultLicenseRoleManager(com.atlassian.cache.CacheManager cacheManager, LicenseRoleStore store, LicenseRoleDefinitions definitions, GroupManager groupManager)

Method Summary

Methods

Modifier and Type	Method and Description
void	clearCache(ClearCacheEvent event)
Set<String>	getGroupsForInstalledLicenseRoles() Get groups that has been associated with all authenticated license roles
com.atlassian.fugue.Option<LicenseRole>	getLicenseRole(LicenseRoleId licenseRoleId) Return the installed LicenseRole associated with the passed ID or Option.none() if no such role exists.
Set<LicenseRole>	getLicenseRoles() Returns the Set of all currently installed LicenseRoles.
int	getUserCount(LicenseRoleId roleId) Retrieve the number of active users for a specific license role (product).
boolean	isLicenseRoleInstalled(LicenseRoleId licenseRoleId) Return true when the passed LicenseRoleId is installed.
void	onDirectoryModified(com.atlassian.crowd.event.DirectoryEvent event)
void	onDirectorySynchronisation(com.atlassian.crowd.event.directory.RemoteDirectorySynchronisedEvent event)
void	onFeatureChange(FeatureEvent event)
void	onGroupCreated(com.atlassian.crowd.event.group.GroupCreatedEvent createdEvent)
void	onGroupDeleted(com.atlassian.crowd.event.group.GroupDeletedEvent deletedEvent)
void	onLicenseChanged(NewLicenseEvent event)
void	onLicenseRoleDefined(LicenseRoleDefinedEvent event)
void	onLicenseRoleUndefined(LicenseRoleUndefinedEvent event)
void	removeGroupFromLicenseRoles(String groupName) Removes any/all associations of the given group from all license roles.
LicenseRole	setLicenseRole(LicenseRole role) Save the passed LicenseRole information to the database.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultLicenseRoleManager

public DefaultLicenseRoleManager(@Nonnull
                         com.atlassian.cache.CacheManager cacheManager,
                         @Nonnull
                         LicenseRoleStore store,
                         @Nonnull
                         LicenseRoleDefinitions definitions,
                         @Nonnull
                         GroupManager groupManager)

Method Detail

getLicenseRole

@Nonnull
public com.atlassian.fugue.Option<LicenseRole> getLicenseRole(@Nonnull
                                                             LicenseRoleId licenseRoleId)

Description copied from interface: LicenseRoleManager

Return the installed LicenseRole associated with the passed ID or Option.none() if no such role exists. An installed LicenseRole has been defined by a plugin/product AND has an accompanying license that grants that role.

Specified by:

getLicenseRole in interface LicenseRoleManager

Parameters:

licenseRoleId - the ID to search for.

Returns:

the LicenseRole associated with the passed ID.

getLicenseRoles

@Nonnull
public Set<LicenseRole> getLicenseRoles()

Description copied from interface: LicenseRoleManager

Returns the Set of all currently installed LicenseRoles. An installed LicenseRole has been defined by a plugin/product AND has an accompanying license that grants that role.

Specified by:

getLicenseRoles in interface LicenseRoleManager

Returns:

the Set of installed LicenseRoles.

getGroupsForInstalledLicenseRoles

@Nonnull
public Set<String> getGroupsForInstalledLicenseRoles()

Get groups that has been associated with all authenticated license roles

Specified by:

getGroupsForInstalledLicenseRoles in interface LicenseRoleManager

Returns:

groups that has been associated with all authenticated license roles

See Also:

LicenseRoleAdminService

removeGroupFromLicenseRoles

public void removeGroupFromLicenseRoles(@Nonnull
                               String groupName)

Description copied from interface: LicenseRoleManager

Removes any/all associations of the given group from all license roles.

Specified by:

removeGroupFromLicenseRoles in interface LicenseRoleManager

Parameters:

groupName - the name of the group to remove.

isLicenseRoleInstalled

public boolean isLicenseRoleInstalled(@Nonnull
                             LicenseRoleId licenseRoleId)

Description copied from interface: LicenseRoleManager

Return true when the passed LicenseRoleId is installed. An installed LicenseRole has been defined by a plugin/product AND has an accompanying license that grants that role.

Specified by:

isLicenseRoleInstalled in interface LicenseRoleManager

Parameters:

licenseRoleId - the ID to check.

Returns:

true when the passed LicenseRoleId is installed.

setLicenseRole

@Nonnull
public LicenseRole setLicenseRole(@Nonnull
                                 LicenseRole role)

Description copied from interface: LicenseRoleManager

Save the passed LicenseRole information to the database. This method will only accept the passed role if:

1. The role is active, that is, it is defined by a product/plugin and has an accompanying license that is current.
2. The role only contains currently valid groups.
3. The primary group is contained within the role.

Specified by:

setLicenseRole in interface LicenseRoleManager

Parameters:

role - the role to save.

Returns:

the role as persisted to the database.

getUserCount

public int getUserCount(@Nonnull
               LicenseRoleId roleId)

Description copied from interface: LicenseRoleManager

Retrieve the number of active users for a specific license role (product). It will uniquely count all users who are found in the groups associated with the product.

Specified by:

getUserCount in interface LicenseRoleManager

Parameters:

roleId - is the license role ID used to identify the product.

Returns:

the number of active users for the product identified by roleId

clearCache

@EventListener
public void clearCache(ClearCacheEvent event)

onLicenseRoleDefined

@EventListener
public void onLicenseRoleDefined(LicenseRoleDefinedEvent event)

onLicenseRoleUndefined

@EventListener
public void onLicenseRoleUndefined(LicenseRoleUndefinedEvent event)

onLicenseChanged

@EventListener
public void onLicenseChanged(NewLicenseEvent event)

onFeatureChange

@EventListener
public void onFeatureChange(FeatureEvent event)

onGroupDeleted

@EventListener
public void onGroupDeleted(com.atlassian.crowd.event.group.GroupDeletedEvent deletedEvent)

onGroupCreated

@EventListener
public void onGroupCreated(com.atlassian.crowd.event.group.GroupCreatedEvent createdEvent)

onDirectoryModified

@EventListener
public void onDirectoryModified(com.atlassian.crowd.event.DirectoryEvent event)

onDirectorySynchronisation

@EventListener
public void onDirectorySynchronisation(com.atlassian.crowd.event.directory.RemoteDirectorySynchronisedEvent event)