com.canto.cumulus.server

Class ServerApplication

java.lang.Object

com.canto.cumulus.server.ServerApplication

public class ServerApplication
extends java.lang.Object

This class is available to server-side running ESPs that need to access the server environment.

Since:

7.0

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getHasFeature(Feature feature) Check whether a given feature is available.
boolean	getHasFeature(int featureID) Deprecated. Use getHasFeature(com.canto.cumulus.constants.Feature) instead.
static ServerApplication	getInstance() Returns the singleton instance.
ModuleJsonPreferences	getModuleConfigurationData(java.lang.String moduleID) Return the shared module preferences for the given module ID.
JPack	getPreferences(java.lang.String path) Return the preferences data of the given path.
java.lang.String	getSerialNumber() Returns the server's base serial number.
UserContextData	getUserContextData(java.lang.String uuid) Returns the user data for the given user UID.
boolean	isEnterpriseServer() Deprecated. Since 7.5 use getHasFeature(int) instead.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static ServerApplication getInstance()

Returns the singleton instance.

Returns:

the current singleton

getUserContextData

public UserContextData getUserContextData(java.lang.String uuid)

Returns the user data for the given user UID.

Parameters:

uuid - the user UID to get the data for

Returns:

the user data

isEnterpriseServer

@Deprecated
public boolean isEnterpriseServer()

Deprecated. Since 7.5 use getHasFeature(int) instead.

Returns whether the server is an Enterprise server.

Returns:

true if this server is an Enterprise server, false otherwise.

getSerialNumber

public java.lang.String getSerialNumber()

Returns the server's base serial number.

Returns:

The server's base serial number.

getHasFeature

@Deprecated
public boolean getHasFeature(int featureID)

Deprecated. Use getHasFeature(com.canto.cumulus.constants.Feature) instead.

Check whether a given feature is available.

Parameters:

featureID - the ID of the feature to check. Use one of the constants of the Feature interface.

Returns:

true if the feature is available, false otherwise.

Since:

7.5

getHasFeature

public boolean getHasFeature(Feature feature)

Check whether a given feature is available.

Parameters:

feature - the feature to check. Use one of the constants of the Feature enum.

Returns:

true if the feature is available, false otherwise.

Since:

8.0

getPreferences

public JPack getPreferences(java.lang.String path)

Return the preferences data of the given path.

Parameters:

path - path of the preferences data

Returns:

preferences pack of the given path

getModuleConfigurationData

public ModuleJsonPreferences getModuleConfigurationData(java.lang.String moduleID)

Return the shared module preferences for the given module ID.

Parameters:

moduleID - the module ID to get the preferences for

Returns:

module preferences