@ExperimentalApi public interface

LicenseRoleDetails

com.atlassian.jira.license.LicenseRoleDetails
Known Indirect Subclasses

@ExperimentalApi

This interface is considered usable by external developers but its contracts have not stabilized.

Experimental APIs may be changed at any time before being marked @Internal or @PublicApi.

Class Overview

Encapsulates license role information for a given license.

Typical usage: 

     JiraLicenseManager jlm = ...;
     LicenseDetails licenseDetails = jlm.getLicense();
     LicenseRoleDetails roleDetails = licenseDetails.getLicenseRoleDetails();

     Set licenseRoles = roleDetails.getLicenseRoles();
     for (LicenseRoleId role : licenseRoles)
     {
         int numSeats = roleDetails.getUserLimit( role );
         ...
     }

Summary

Constants
int UNLIMITED_USERS The integer constant indicating an effectively unlimited number of users/seats.
Public Methods
@Nonnull Set<LicenseRoleId> getLicenseRoles()
Returns the license roles encoded in the present license.
int getUserLimit(LicenseRoleId role)
Returns the number of seats for the given LicenseRoleId.

Constants

public static final int UNLIMITED_USERS

The integer constant indicating an effectively unlimited number of users/seats.

Constant Value: -1 (0xffffffff)

Public Methods

@Nonnull public Set<LicenseRoleId> getLicenseRoles ()

Returns the license roles encoded in the present license.

public int getUserLimit (LicenseRoleId role)

Returns the number of seats for the given LicenseRoleId.

Returns
  • the number of users/seats for the given license role; see also UNLIMITED_USERS.