com.tridion

Class Controller

java.lang.Object

com.tridion.Controller

All Implemented Interfaces:

com.sdl.web.licensing.events.LicenseEventHandler, com.tridion.configuration.Configurable

Deprecated.

@Deprecated
public abstract class Controller
extends Object
implements com.tridion.configuration.Configurable, com.sdl.web.licensing.events.LicenseEventHandler

The Controller class serves as an abstract base class for classes that control certain functionality. It provides access to the configuration and to logging.

Field Summary

Fields

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.

Constructor Summary

Constructors

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.

Method Summary

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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tridion.configuration.Configurable

configure

Field Detail

VERSION_RELEASE

protected static final String VERSION_RELEASE

Deprecated.

See Also:

Constant Field Values

VERSION_RELEASE_BUILD

protected static final String VERSION_RELEASE_BUILD

Deprecated.

See Also:

Constant Field Values

CONFIG_GLOBAL

protected static final String CONFIG_GLOBAL

Deprecated.

The name of the global configuration element.

See Also:

Constant Field Values

CONFIG_PRESENTATIONS

protected static final String CONFIG_PRESENTATIONS

Deprecated.

The name of the presentations configuration element.

See Also:

Constant Field Values

CONFIG_PUBLICATIONS

protected static final String CONFIG_PUBLICATIONS

Deprecated.

The name of the publications configuration element.

See Also:

Constant Field Values

CONFIG_LICENSE

protected static final String CONFIG_LICENSE

Deprecated.

The name of the License configuration element.

See Also:

Constant Field Values

DEFAULT_LOG_FILE

protected static final String DEFAULT_LOG_FILE

Deprecated.

The default logfile that is used before loggers are initialized (tridion.log in the system temporary folder).

See Also:

Constant Field Values

DEFAULT_LICENSE_FILE

protected static final String DEFAULT_LICENSE_FILE

Deprecated.

The name of the default license file.

See Also:

Constant Field Values

LICENSELOCK_DIRECTORY

public static final String LICENSELOCK_DIRECTORY

Deprecated.

Location of hidden lock file used for checking of license (TT52851).

See Also:

Constant Field Values

LICENSELOCK_DEFAULTDIRECTORY

public static final String LICENSELOCK_DEFAULTDIRECTORY

Deprecated.

License lock default directory.

Constructor Detail

Controller

protected Controller(boolean limited)
              throws com.tridion.configuration.ConfigurationException

Deprecated.

Constructs a new Controller and configures the using the appropriate configuration file, and sets up a Logger instance, ready for logging.

Parameters:

limited - Whether this Controller is limited in some way (e.g. limited broker for file system deployment only).

Throws:

com.tridion.configuration.ConfigurationException

Controller

protected Controller()
              throws com.tridion.configuration.ConfigurationException

Deprecated.

Constructs a new Controller and configures the using the appropriate configuration file, and sets up a Logger instance, ready for logging.

Throws:

com.tridion.configuration.ConfigurationException - If something goes wrong configuring this Controller.

Method Detail

getLicenseFileTracker

protected com.sdl.web.licensing.events.LicenseFileTracker getLicenseFileTracker()

Deprecated.

setLicenseFileTracker

protected void setLicenseFileTracker(com.sdl.web.licensing.events.LicenseFileTracker licenseFileTracker)

Deprecated.

getLicenseTimeTracker

protected com.sdl.web.licensing.events.LicenseTracker getLicenseTimeTracker()

Deprecated.

setLicenseTimeTracker

protected void setLicenseTimeTracker(com.sdl.web.licensing.events.LicenseTracker licenseTimeTracker)

Deprecated.

setConfiguration

protected void setConfiguration(com.tridion.configuration.Configuration configuration)

Deprecated.

isFeatureEnabled

public boolean isFeatureEnabled(String featureName)

Deprecated.

Checks whether the feature passed in the argument has been enabled or not. This is an internal method, used for verification.

Parameters:

featureName - The name of the feature to check.

Returns:

true if feature is enabled, false if not enabled

isProductEnabled

public boolean isProductEnabled()

Deprecated.

Checks whether the product is enabled.

Returns:

true if product is enabled, false it not enabled

updateLicenseTime

public void updateLicenseTime(com.sdl.web.licensing.events.LicenseTimeEvent licenseTimeEvent)

Deprecated.

This is a thread which checks whether the license for this product has expired.

Specified by:

updateLicenseTime in interface com.sdl.web.licensing.events.LicenseEventHandler

Parameters:

licenseTimeEvent - An event to monitor.

updateLicenseFile

public 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.

Specified by:

updateLicenseFile in interface com.sdl.web.licensing.events.LicenseEventHandler

Parameters:

licenseFileEvent - The event which affects the license file.

getGlobalConfiguration

public com.tridion.configuration.Configuration getGlobalConfiguration()

Deprecated.

Returns a Configuration object containing the properties defined in the Global section of the configuration file.

Returns:

The global configuration.

getConfiguration

public com.tridion.configuration.Configuration getConfiguration()

Deprecated.

Returns a reference to the configuration being used by this Controller instance.

Returns:

The configuration.

logInfo

protected void logInfo()

Deprecated.

Logs the version of the Controller instance, the System properties and the configuration file used by the instance.

getVersion

public String getVersion()

Deprecated.

Gets the version information string for this Controller.

Returns:

The version information string.

getConfigurationFile

public URL getConfigurationFile()

Deprecated.

Returns a URL representing the file that was used to load the configuration for this instance.

Returns:

A URL representing the configuration file.

loadConfiguration

protected com.tridion.configuration.Configuration loadConfiguration()
                                                             throws com.tridion.configuration.ConfigurationException

Deprecated.

Loads the configuration from the configuration file and validates it against the appropriate schema.

Returns:

The loaded Configuration.

Throws:

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.

getConfigFileName

protected abstract String getConfigFileName()

Deprecated.

Returns the configuration file name that should be used for configuring this Controller.

Returns:

The configuration file name.

getConfigSchemaName

protected abstract String getConfigSchemaName()

Deprecated.

Returns the file name of the schema used to validate the configuration file used by this Controller.

Returns:

The configuration schema file name.

flushInstance

protected abstract void flushInstance()

Deprecated.

Resets the instance to null. This method is used to reload configuration and licensing information.

getProductName

public abstract String getProductName()

Deprecated.

Returns the official name of the child Controller class. This is used for licensing as well as displaying when logging information about this Controller.

Returns:

The product name.

getConfiguration

public abstract com.tridion.configuration.Configuration getConfiguration(int id)

Deprecated.

Returns the local configuration for the supplied id. This id can be a Publication or Presentation id depending on the Controller instance.

Parameters:

id - The id indicating which local configuration should be returned.

Returns:

The local configuration for the supplied id.

getManifestURL

public abstract URL getManifestURL()

Deprecated.

Returns the location of this Controller's manifest file as a URL.

Returns:

The location of the manifest file.