@Deprecated public abstract class Controller extends Object implements com.tridion.configuration.Configurable, com.sdl.web.licensing.events.LicenseEventHandler
Modifier and Type | Field and Description |
---|---|
protected static String |
CONFIG_GLOBAL
Deprecated.
The name of the global configuration element.
|
protected static String |
CONFIG_LICENSE
Deprecated.
The name of the License configuration element.
|
protected static String |
CONFIG_PRESENTATIONS
Deprecated.
The name of the presentations configuration element.
|
protected static String |
CONFIG_PUBLICATIONS
Deprecated.
The name of the publications configuration element.
|
protected static String |
DEFAULT_LICENSE_FILE
Deprecated.
The name of the default license file.
|
protected static String |
DEFAULT_LOG_FILE
Deprecated.
The default logfile that is used before loggers are initialized (
tridion.log
in the system temporary folder). |
static String |
LICENSELOCK_DEFAULTDIRECTORY
Deprecated.
License lock default directory.
|
static String |
LICENSELOCK_DIRECTORY
Deprecated.
Location of hidden lock file used for checking of license (TT52851).
|
protected static String |
VERSION_RELEASE
Deprecated.
|
protected static String |
VERSION_RELEASE_BUILD
Deprecated.
|
Modifier | Constructor and Description |
---|---|
protected |
Controller()
Deprecated.
Constructs a new
Controller and configures the using the appropriate configuration file,
and sets up a Logger instance, ready for logging. |
protected |
Controller(boolean limited)
Deprecated.
Constructs a new
Controller and configures the using the appropriate configuration file,
and sets up a Logger instance, ready for logging. |
Modifier and Type | Method and Description |
---|---|
protected abstract void |
flushInstance()
Deprecated.
Resets the instance to null.
|
protected abstract String |
getConfigFileName()
Deprecated.
Returns the configuration file name that should be used for configuring this
Controller . |
protected abstract String |
getConfigSchemaName()
Deprecated.
Returns the file name of the schema used to validate the configuration file used by this
Controller . |
com.tridion.configuration.Configuration |
getConfiguration()
Deprecated.
Returns a reference to the configuration being used by this
Controller instance. |
abstract com.tridion.configuration.Configuration |
getConfiguration(int id)
Deprecated.
Returns the local configuration for the supplied id.
|
URL |
getConfigurationFile()
Deprecated.
Returns a URL representing the file that was used to load the configuration for this instance.
|
com.tridion.configuration.Configuration |
getGlobalConfiguration()
Deprecated.
Returns a
Configuration object containing the properties defined in the Global section of the
configuration file. |
protected com.sdl.web.licensing.events.LicenseFileTracker |
getLicenseFileTracker()
Deprecated.
|
protected com.sdl.web.licensing.events.LicenseTracker |
getLicenseTimeTracker()
Deprecated.
|
abstract URL |
getManifestURL()
Deprecated.
Returns the location of this
Controller 's manifest file as a URL . |
abstract String |
getProductName()
Deprecated.
Returns the official name of the child
Controller class. |
String |
getVersion()
Deprecated.
Gets the version information string for this
Controller . |
boolean |
isFeatureEnabled(String featureName)
Deprecated.
Checks whether the feature passed in the argument has been enabled or not.
|
boolean |
isProductEnabled()
Deprecated.
Checks whether the product is enabled.
|
protected com.tridion.configuration.Configuration |
loadConfiguration()
Deprecated.
Loads the configuration from the configuration file and validates it against the appropriate schema.
|
protected void |
logInfo()
Deprecated.
Logs the version of the
Controller instance, the System properties and the configuration file used
by the instance. |
protected void |
setConfiguration(com.tridion.configuration.Configuration configuration)
Deprecated.
|
protected void |
setLicenseFileTracker(com.sdl.web.licensing.events.LicenseFileTracker licenseFileTracker)
Deprecated.
|
protected void |
setLicenseTimeTracker(com.sdl.web.licensing.events.LicenseTracker licenseTimeTracker)
Deprecated.
|
void |
updateLicenseFile(com.sdl.web.licensing.events.LicenseFileEvent licenseFileEvent)
Deprecated.
This is a thread which checks to see if a license file has been changed or removed.
|
void |
updateLicenseTime(com.sdl.web.licensing.events.LicenseTimeEvent licenseTimeEvent)
Deprecated.
This is a thread which checks whether the license for this product has expired.
|
protected static final String VERSION_RELEASE
protected static final String VERSION_RELEASE_BUILD
protected static final String CONFIG_GLOBAL
protected static final String CONFIG_PRESENTATIONS
protected static final String CONFIG_PUBLICATIONS
protected static final String CONFIG_LICENSE
protected static final String DEFAULT_LOG_FILE
tridion.log
in the system temporary folder).protected static final String DEFAULT_LICENSE_FILE
public static final String LICENSELOCK_DIRECTORY
public static final String LICENSELOCK_DEFAULTDIRECTORY
protected Controller(boolean limited) throws com.tridion.configuration.ConfigurationException
Controller
and configures the using the appropriate configuration file,
and sets up a Logger
instance, ready for logging.limited
- Whether this Controller
is limited in some way (e.g. limited broker for file system
deployment only).com.tridion.configuration.ConfigurationException
protected Controller() throws com.tridion.configuration.ConfigurationException
Controller
and configures the using the appropriate configuration file,
and sets up a Logger
instance, ready for logging.com.tridion.configuration.ConfigurationException
- If something goes wrong configuring this Controller
.protected com.sdl.web.licensing.events.LicenseFileTracker getLicenseFileTracker()
protected void setLicenseFileTracker(com.sdl.web.licensing.events.LicenseFileTracker licenseFileTracker)
protected com.sdl.web.licensing.events.LicenseTracker getLicenseTimeTracker()
protected void setLicenseTimeTracker(com.sdl.web.licensing.events.LicenseTracker licenseTimeTracker)
protected void setConfiguration(com.tridion.configuration.Configuration configuration)
public boolean isFeatureEnabled(String featureName)
featureName
- The name of the feature to check.public boolean isProductEnabled()
public void updateLicenseTime(com.sdl.web.licensing.events.LicenseTimeEvent licenseTimeEvent)
updateLicenseTime
in interface com.sdl.web.licensing.events.LicenseEventHandler
licenseTimeEvent
- An event to monitor.public void updateLicenseFile(com.sdl.web.licensing.events.LicenseFileEvent licenseFileEvent)
updateLicenseFile
in interface com.sdl.web.licensing.events.LicenseEventHandler
licenseFileEvent
- The event which affects the license file.public com.tridion.configuration.Configuration getGlobalConfiguration()
Configuration
object containing the properties defined in the Global section of the
configuration file.public com.tridion.configuration.Configuration getConfiguration()
Controller
instance.protected void logInfo()
Controller
instance, the System properties and the configuration file used
by the instance.public String getVersion()
Controller
.public URL getConfigurationFile()
protected com.tridion.configuration.Configuration loadConfiguration() throws com.tridion.configuration.ConfigurationException
Configuration
.com.tridion.configuration.ConfigurationException
- If the configuration could not be loaded. This may be because the configuration
file could not be found or the file is not well-formed XML.protected abstract String getConfigFileName()
Controller
.protected abstract String getConfigSchemaName()
Controller
.protected abstract void flushInstance()
public abstract String getProductName()
Controller
class. This is used for licensing as well as
displaying when logging information about this Controller
.public abstract com.tridion.configuration.Configuration getConfiguration(int id)
Controller
instance.id
- The id indicating which local configuration should be returned.public abstract URL getManifestURL()
Controller
's manifest file as a URL
.Copyright (c) 2014-2021 All Rights Reserved by the RWS Group for and on behalf of its affiliates and subsidiaries