Package de.xima.fc.api.system
Class LicenseAPI
- java.lang.Object
-
- de.xima.fc.api.ASubAPI
-
- de.xima.fc.api.system.LicenseAPI
-
public class LicenseAPI extends ASubAPI
- Author:
- XIMA MEDIA GmbH
-
-
Constructor Summary
Constructors Constructor Description LicenseAPI()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description String
getCustomFeature(ELicenseFeature feature)
Deprecated.Use e.g.String
getCustomFeature(String name)
Deprecated.Use e.g.int
getFrontendServerCount()
Deprecated.LicenseAccess
getLicenseAccess(Mandant client)
Gets the license access based on the given client.String
getLicenseId()
Deprecated.The new license management uses keys instead of IDs.String
getLicenseKey(Mandant scope)
Gets the license key for the given client or system scope.ELizenzTyp
getLicenseType()
Deprecated.The new license management handles license types differently.LicenseAccess
getSystemLicenseAccess()
Gets the access for the system license only!ELicenseVersionState
getSystemLicenseVersionState(UserContext uc)
Gets the version state of the system licenseLicenseModel
getUnchachedLicenseModel(UserContext uc, String licenseKey)
Gets the uncached model of an licenseLicenseModel
getUnchachedSystemLicenseModel(UserContext uc)
Gets the uncached model of the system license-
Methods inherited from class de.xima.fc.api.ASubAPI
getHandlerProvider
-
-
-
-
Method Detail
-
getSystemLicenseAccess
public LicenseAccess getSystemLicenseAccess()
Gets the access for the system license only!- Returns:
- the access to the system license
-
getLicenseKey
public String getLicenseKey(Mandant scope)
Gets the license key for the given client or system scope. When a client license is assigned to the client, the license key from that license is returned. Otherwise, the license key from the system license is returned.- Parameters:
scope
- Client scope for which to get the license key. Usenull
for the system scope.- Returns:
- The license key for the given scope, or
null
when no license was found (e.g. when the system was installed for the first time and no license was uploaded yet.)
-
getLicenseAccess
public LicenseAccess getLicenseAccess(Mandant client)
Gets the license access based on the given client.- Parameters:
client
- the client to get the client license model for- Returns:
- The access with client and system license
-
getSystemLicenseVersionState
public ELicenseVersionState getSystemLicenseVersionState(UserContext uc)
Gets the version state of the system license- Parameters:
uc
- The user context for accessing the database.- Returns:
- the license version state
-
getUnchachedLicenseModel
public LicenseModel getUnchachedLicenseModel(UserContext uc, String licenseKey)
Gets the uncached model of an license- Parameters:
uc
- The user context of the user who requested the license.licenseKey
- the key of the license to get the model from- Returns:
- the license model or
null
-
getUnchachedSystemLicenseModel
public LicenseModel getUnchachedSystemLicenseModel(UserContext uc)
Gets the uncached model of the system license- Parameters:
uc
- The user context of the user who requested the license.- Returns:
- the system license model or
null
-
getCustomFeature
@Deprecated public String getCustomFeature(String name)
Deprecated.Use e.g.getSystemLicenseAccess()
.getStringFeature()
. Also, note that clients may have a separate license now -- if available, use#getLicenseAccess(Client)
with the current client scope.- Parameters:
name
- Name of the feature to check.- Returns:
- The value for the given license feature.
-
getCustomFeature
@Deprecated public String getCustomFeature(ELicenseFeature feature)
Deprecated.Use e.g.getSystemLicenseAccess()
.getStringFeature()
. Also, note that clients may have a separate license now -- if available, use#getLicenseAccess(Client)
with the current client scope.- Parameters:
feature
- Name of the feature to check.- Returns:
- The value for the given license feature.
-
getLicenseId
@Deprecated public String getLicenseId()
Deprecated.The new license management uses keys instead of IDs. UseLicenseCache.getCachedSystemLicense()
.getLicenseKey
instead. Also, note that clients may have a separate license now -- if available, use#getLicenseAccess(Client)
with the current client scope.- Returns:
- The key of the system license.
-
getFrontendServerCount
@Deprecated public int getFrontendServerCount()
Deprecated.UsegetSystemLicenseAccess()
.getNumberFeature(
COUNT_FRONTENDSERVERS
). Also, note that clients may have a separate license now -- if available, use#getLicenseAccess(Client)
with the current client scope.- Returns:
- The number of allowed frontend servers to which the master server can connect.
-
getLicenseType
@Deprecated public ELizenzTyp getLicenseType()
Deprecated.The new license management handles license types differently.- Returns:
- Always
null
.
-
-