com.communote.server.core.config

Class StartupPropertiesImpl

java.lang.Object

com.communote.server.core.config.StartupPropertiesImpl

All Implemented Interfaces:

StartupProperties

public class StartupPropertiesImpl
extends Object
implements StartupProperties

Holds the properties that are required for the startup of the application.

Author:

Communote GmbH - http://www.communote.com/

Field Summary

Fields inherited from interface com.communote.server.api.core.config.StartupProperties

DEFAULT_PROTOCOL_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
StartupPropertiesImpl(String webAppRealPath) Constructs a new instance of the startup properties.

Method Summary

Modifier and Type	Method and Description
File	getCacheRootDirectory() Returns the root directory for caching data of the running instance.
File	getConfigurationDirectory() Returns the configuration directory of the running instance.
String	getCoreProperty(CoreConfigurationPropertyConstant property)
String	getDatabaseDriverClassName() Returns the driver class name.
String	getDatabaseHost() The name the database or null if not set.
String	getDatabaseName() The name the database or null if not set.
Integer	getDatabasePort() The port the database is listening on or null if not set or not required.
String	getDatabaseProtocol() The protocol of the database connection or null if not set.
String	getDatabaseProtocolSeparator() The protocol separator of the database connection or null if not set.
String	getDatabaseSchemaSeparator() The schema separator of the database connection or the default if not set.
String	getDatabaseUrl() Returns the JDBC URL to connect to the database or null if not all required properties are set.
String	getDatabaseUserName() Returns the user name of the user that accesses the database or null if not set.
String	getDatabaseUserPassword() Returns the password of the user that accesses the database or null if not set.
File	getDataDirectory() Returns the directory where Communote stores its data.
String	getHibernateDialect() Returns the full qualified class name of the Hibernate dialect class.
String	getInstanceName() Returns the name of the running instance.
KeyStore	getKeyStore() Return the key store containing secure keys (dont conflict it with the trust store!)
File	getPluginDir() Returns the plug in directory
String	getServerId() Returns the server ID of this installation.
KeyStore	getTrustStore()
boolean	isFulltextSearch()
boolean	isInstallationDone() Whether the installation is done.
void	setCertificate(String alias, Certificate certificate)

Methods inherited from class java.lang.Object

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

Constructor Detail

StartupPropertiesImpl

public StartupPropertiesImpl(String webAppRealPath)
                      throws ConfigurationInitializationException

Constructs a new instance of the startup properties.

Parameters:

webAppRealPath - the file system path to the web application which is used to resolve the server installation directory.

Throws:

ConfigurationInitializationException - in case retrieving some of the required properties fails

Method Detail

getCacheRootDirectory

public File getCacheRootDirectory()

Description copied from interface: StartupProperties

Returns the root directory for caching data of the running instance.

Specified by:

getCacheRootDirectory in interface StartupProperties

Returns:

the root directory

getConfigurationDirectory

public File getConfigurationDirectory()

Description copied from interface: StartupProperties

Returns the configuration directory of the running instance.

Specified by:

getConfigurationDirectory in interface StartupProperties

Returns:

the configuration directory

getCoreProperty

public String getCoreProperty(CoreConfigurationPropertyConstant property)

Specified by:

getCoreProperty in interface StartupProperties

Parameters:

property - The property.

Returns:

The value for property or null if not existend.

getDatabaseDriverClassName

public String getDatabaseDriverClassName()

Description copied from interface: StartupProperties

Returns the driver class name.

Specified by:

getDatabaseDriverClassName in interface StartupProperties

Returns:

the name of the driver class

getDatabaseHost

public String getDatabaseHost()

Description copied from interface: StartupProperties

The name the database or null if not set.

Specified by:

getDatabaseHost in interface StartupProperties

Returns:

the database name

getDatabaseName

public String getDatabaseName()

Description copied from interface: StartupProperties

The name the database or null if not set.

Specified by:

getDatabaseName in interface StartupProperties

Returns:

the database name

getDatabasePort

public Integer getDatabasePort()

Description copied from interface: StartupProperties

The port the database is listening on or null if not set or not required.

Specified by:

getDatabasePort in interface StartupProperties

Returns:

the port of the database connection

getDatabaseProtocol

public String getDatabaseProtocol()

Description copied from interface: StartupProperties

The protocol of the database connection or null if not set.

Specified by:

getDatabaseProtocol in interface StartupProperties

Returns:

the protocol

getDatabaseProtocolSeparator

public String getDatabaseProtocolSeparator()

Description copied from interface: StartupProperties

The protocol separator of the database connection or null if not set.

Specified by:

getDatabaseProtocolSeparator in interface StartupProperties

Returns:

The protocol separator.

getDatabaseSchemaSeparator

public String getDatabaseSchemaSeparator()

Description copied from interface: StartupProperties

The schema separator of the database connection or the default if not set.

Specified by:

getDatabaseSchemaSeparator in interface StartupProperties

Returns:

The schema separator.

getDatabaseUrl

public String getDatabaseUrl()

Description copied from interface: StartupProperties

Returns the JDBC URL to connect to the database or null if not all required properties are set.

Specified by:

getDatabaseUrl in interface StartupProperties

Returns:

the database URL

getDatabaseUserName

public String getDatabaseUserName()

Description copied from interface: StartupProperties

Returns the user name of the user that accesses the database or null if not set.

Specified by:

getDatabaseUserName in interface StartupProperties

Returns:

the user name

getDatabaseUserPassword

public String getDatabaseUserPassword()

Description copied from interface: StartupProperties

Returns the password of the user that accesses the database or null if not set.

Specified by:

getDatabaseUserPassword in interface StartupProperties

Returns:

the password

getDataDirectory

public File getDataDirectory()

Description copied from interface: StartupProperties

Returns the directory where Communote stores its data.

Specified by:

getDataDirectory in interface StartupProperties

Returns:

the data directory

getHibernateDialect

public String getHibernateDialect()

Description copied from interface: StartupProperties

Returns the full qualified class name of the Hibernate dialect class.

Specified by:

getHibernateDialect in interface StartupProperties

Returns:

the hibernate dialect class name

getInstanceName

public String getInstanceName()

Description copied from interface: StartupProperties

Returns the name of the running instance.

Specified by:

getInstanceName in interface StartupProperties

Returns:

the name of the instance

getKeyStore

public KeyStore getKeyStore()

Description copied from interface: StartupProperties

Return the key store containing secure keys (dont conflict it with the trust store!)

Specified by:

getKeyStore in interface StartupProperties

Returns:

the key store

getPluginDir

public File getPluginDir()

Description copied from interface: StartupProperties

Returns the plug in directory

Specified by:

getPluginDir in interface StartupProperties

Returns:

String

getServerId

public String getServerId()

Description copied from interface: StartupProperties

Returns the server ID of this installation.

Specified by:

getServerId in interface StartupProperties

Returns:

the server ID

getTrustStore

public KeyStore getTrustStore()

Specified by:

getTrustStore in interface StartupProperties

Returns:

The actual KeyStore or null, if there where errors.

isFulltextSearch

public boolean isFulltextSearch()

Specified by:

isFulltextSearch in interface StartupProperties

Returns:

True, if the full text features of the database should be used. If the database does not support the fulltext feature this property is ignored and queries will fall back to LIKE.

isInstallationDone

public boolean isInstallationDone()

Description copied from interface: StartupProperties

Whether the installation is done.

Specified by:

isInstallationDone in interface StartupProperties

Returns:

true if the installation is done.

setCertificate

public void setCertificate(String alias,
                           Certificate certificate)
                    throws KeyStoreException

Specified by:

setCertificate in interface StartupProperties

Parameters:

alias - Alias of the certificate.

certificate - The new certificate. If null, the certificate will be removed.

Throws:

KeyStoreException - Exception.