com.communote.server.api.core.config

Interface StartupProperties

All Known Implementing Classes:

StartupPropertiesImpl

public interface StartupProperties

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

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_PROTOCOL_SEPARATOR The default protocol separator for jdbc url if no separator is configured

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)

Field Detail

DEFAULT_PROTOCOL_SEPARATOR

static final String DEFAULT_PROTOCOL_SEPARATOR

The default protocol separator for jdbc url if no separator is configured

See Also:

Constant Field Values

Method Detail

getCacheRootDirectory

File getCacheRootDirectory()

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

Returns:

the root directory

getConfigurationDirectory

File getConfigurationDirectory()

Returns the configuration directory of the running instance.

Returns:

the configuration directory

getCoreProperty

String getCoreProperty(CoreConfigurationPropertyConstant property)

Parameters:

property - The property.

Returns:

The value for property or null if not existend.

getDatabaseDriverClassName

String getDatabaseDriverClassName()

Returns the driver class name.

Returns:

the name of the driver class

getDatabaseHost

String getDatabaseHost()

The name the database or null if not set.

Returns:

the database name

getDatabaseName

String getDatabaseName()

The name the database or null if not set.

Returns:

the database name

getDatabasePort

Integer getDatabasePort()

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

Returns:

the port of the database connection

getDatabaseProtocol

String getDatabaseProtocol()

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

Returns:

the protocol

getDatabaseProtocolSeparator

String getDatabaseProtocolSeparator()

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

Returns:

The protocol separator.

getDatabaseSchemaSeparator

String getDatabaseSchemaSeparator()

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

Returns:

The schema separator.

getDatabaseUrl

String getDatabaseUrl()

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

Returns:

the database URL

getDatabaseUserName

String getDatabaseUserName()

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

Returns:

the user name

getDatabaseUserPassword

String getDatabaseUserPassword()

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

Returns:

the password

getDataDirectory

File getDataDirectory()

Returns the directory where Communote stores its data.

Returns:

the data directory

getHibernateDialect

String getHibernateDialect()

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

Returns:

the hibernate dialect class name

getInstanceName

String getInstanceName()

Returns the name of the running instance.

Returns:

the name of the instance

getKeyStore

KeyStore getKeyStore()

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

Returns:

the key store

getPluginDir

File getPluginDir()

Returns the plug in directory

Returns:

String

getServerId

String getServerId()

Returns the server ID of this installation.

Returns:

the server ID

getTrustStore

KeyStore getTrustStore()

Returns:

The actual KeyStore or null, if there where errors.

isFulltextSearch

boolean isFulltextSearch()

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

boolean isInstallationDone()

Whether the installation is done.

Returns:

true if the installation is done.

setCertificate

void setCertificate(String alias,
                    Certificate certificate)
             throws KeyStoreException

Parameters:

alias - Alias of the certificate.

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

Throws:

KeyStoreException - Exception.