ro.sync.exml.workspace.api.license
Interface LicenseInformationProvider

All Superinterfaces:

LicenseCategories, LicenseComponents

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface LicenseInformationProvider
extends LicenseCategories, LicenseComponents

Provides information about how the current running Oxygen instance is licensed.

Since:

12.2

Field Summary

Fields inherited from interface ro.sync.exml.workspace.api.license.LicenseCategories

CATEGORY_ACADEMIC, CATEGORY_ACADEMIC_CLASSROOM, CATEGORY_ACADEMIC_DEPARTMENTAL, CATEGORY_ACADEMIC_FLOATING, CATEGORY_ACADEMIC_SITE, CATEGORY_ENTERPRISE, CATEGORY_ENTERPRISE_CORPORATE, CATEGORY_ENTERPRISE_FLOATING, CATEGORY_ENTERPRISE_SITE, CATEGORY_PROFESSIONAL, CATEGORY_PROFESSIONAL_CORPORATE, CATEGORY_PROFESSIONAL_FLOATING, CATEGORY_PROFESSIONAL_SITE

Fields inherited from interface ro.sync.exml.workspace.api.license.LicenseComponents

AUTHOR_COMPONENT_COMPONENT_NAME, AUTHOR_COMPONENT_NAME, DEBUGGER_COMPONENT_NAME, DEVELOPER_COMPONENT_NAME, DIFF_APPLICATION_COMPONENT_NAME, DIFF_SERVER_COMPONENT_NAME, EDITOR_COMPONENT_NAME, SAXON_SA_COMPONENT_NAME, SVN_CLIENT_COMPONENT_NAME

Method Summary

java.lang.String	getCategory() Get the license category.
java.util.List<java.lang.String>	getComponents() Get the components which are currently licensed.
boolean	isInViolationOfLicense() Check if the current application has exceeded the amount of floating licenses allowed on a server.
boolean	isLicensed() Check if the current application is licensed or not.
boolean	isPermanent() Check if the Oxygen application is permanently licensed or has a trial license.

Method Detail

getCategory

java.lang.String getCategory()

Get the license category. One of the LicenseCategories constants. Can be null if no license is available.

Returns:

the license category. One of the LicenseCategories constants.

isPermanent

boolean isPermanent()

Check if the Oxygen application is permanently licensed or has a trial license.

Returns:

true if the Oxygen application is permanently licensed or false if it has a trial license.

getComponents

java.util.List<java.lang.String> getComponents()

Get the components which are currently licensed. For example { LicenseComponents.EDITOR_COMPONENT_NAME, LicenseComponents.SAXON_SA_COMPONENT_NAME }. Can be null if no license is available.

Returns:

the components which are currently licensed. For example { LicenseComponents.EDITOR_COMPONENT_NAME, LicenseComponents.SAXON_SA_COMPONENT_NAME }

isLicensed

boolean isLicensed()

Check if the current application is licensed or not.

Returns:

true if there is a license for the current application or false if there is no license key for the current application.

isInViolationOfLicense

boolean isInViolationOfLicense()

Check if the current application has exceeded the amount of floating licenses allowed on a server. In this case the user will not be able to open any more files in Oxygen. This situation can change while the application is running and will be reported a couple of minutes after the application has started.

Returns:

true if the current application has exceeded the amount of floating licenses allowed on a server.