|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@ExperimentalApi public interface LicenseRoleManager
Provides read and write capabilities regarding LicenseRole
s. Unless otherwise stated, the methods on this
class only deal with authenticated LicenseRole
s. An authenticated LicenseRole
is defined by a
plugin AND is licensed. A LicenseRole
is licensed when there is a license in JIRA that
indicates the role is licensed.
Method Summary | |
---|---|
Set<String> |
getGroupsForAuthenticatedLicenseRoles()
Get groups that has been associated with all authenticated license roles. |
com.atlassian.fugue.Option<LicenseRole> |
getLicenseRole(LicenseRoleId licenseRoleId)
Return the authenticated LicenseRole associated with the passed ID or Option.none() if no such
role exists. |
Set<LicenseRole> |
getLicenseRoles()
Returns the Set of all currently authenticated LicenseRole s. |
boolean |
isAuthenticated(LicenseRoleId licenseRoleId)
Return true when the passed LicenseRoleId is authenticated. |
LicenseRole |
setLicenseRole(LicenseRole role)
Save the passed LicenseRole information to the database. |
Method Detail |
---|
@Nonnull com.atlassian.fugue.Option<LicenseRole> getLicenseRole(@Nonnull LicenseRoleId licenseRoleId)
LicenseRole
associated with the passed ID or Option.none()
if no such
role exists. An authenticated LicenseRole
is both defined and licensed.
licenseRoleId
- the ID to search for.
LicenseRole
associated with the passed ID.@Nonnull Set<LicenseRole> getLicenseRoles()
Set
of all currently authenticated LicenseRole
s.
An authenticated LicenseRole
is both defined and licensed.
Set
of authenticated LicenseRole
s.@Nonnull Set<String> getGroupsForAuthenticatedLicenseRoles()
boolean isAuthenticated(@Nonnull LicenseRoleId licenseRoleId)
true
when the passed LicenseRoleId
is authenticated.
A LicenseRoleId
is authenticated when a plugin provides a
LicenseRoleDefinition
and it is also licensed.
licenseRoleId
- the ID to check.
true
when the passed LicenseRoleId
is authenticated.@Nonnull LicenseRole setLicenseRole(@Nonnull LicenseRole role)
LicenseRole
information to the database. This method will
only accept the passed role if:
role
- the role to save.
IllegalArgumentException
- if passed role does not contain valid groups, if the primary group
is invalid or if the role is not authenticated.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |