/*******************************************************************************
* Copyright (c) 2008-2011 Chair for Applied Software Engineering,
* Technische Universitaet Muenchen.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
******************************************************************************/
package org.eclipse.emf.emfstore.server;
import java.io.File;
import java.util.ArrayList;
import java.util.Properties;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.Platform;
import org.eclipse.emf.emfstore.common.model.util.ModelUtil;
import org.eclipse.emf.emfstore.server.accesscontrol.PermissionProvider;
import org.eclipse.emf.emfstore.server.core.helper.PermissionSetConfiguration;
import org.eclipse.emf.emfstore.server.exceptions.FatalEmfStoreException;
import org.osgi.framework.Bundle;
/**
* Represents the current server configuration.
*
* @author koegel
* @author wesendonk
*/
public final class ServerConfiguration {
/**
* Constant for boolean true string.
*/
public static final String TRUE = "true";
/**
* Constant for boolean false string.
*/
public static final String FALSE = "false";
/**
* Constant for the name of the Resource Storage Property.
*/
public static final String RESOURCE_STORAGE = "emfstore.persistence.resourceStorage";
/**
* Constant for the Default Resource Storage.
*/
public static final String RESOURCE_STORAGE_DEFAULT = "org.eclipse.emf.emfstore.server.storage.XMLStorage";
/**
* RMI encryption property, possible values are true and false.
*/
public static final String RMI_ENCRYPTION = "emfstore.connection.rmi.encryption";
/**
* Default RMI encryption property value.
*/
public static final String RMI_ENCRYPTION_DEFAULT = "true";
/**
* Option for defining port of XML RPC.
*/
public static final String XML_RPC_PORT = "emfstore.connection.xmlrpc.port";
/**
* Default port for XML RPC.
*/
public static final String XML_RPC_PORT_DEFAULT = "8080";
/**
* Default name of server keystore file.
*/
public static final String SERVER_KEYSTORE_FILE = "emfstoreServer.keystore";
/**
* Password of keystore, in which the certificate for rmi encryption and password decryption is saved.
*
* @see #KEYSTORE_ALIAS
*/
public static final String KEYSTORE_PASSWORD = "emfstore.keystore.password";
/**
* Default keystore password.
*/
public static final String KEYSTORE_PASSWORD_DEFAULT = "123456"; // av374tb$VBGGtrgwa7tosdfa";
/**
* Alias for certificate in keystore.
*
* @see #KEYSTORE_PASSWORD
*/
public static final String KEYSTORE_ALIAS = "emfstore.keystore.alias";
/**
* Default alias, intentioned for developers.
*/
public static final String KEYSTORE_ALIAS_DEFAULT = "testkeygeneratedbyotto";
/**
* Type of server certificate used for encryption.
*/
public static final String KEYSTORE_CERTIFICATE_TYPE = "emfstore.keystore.certificate.type";
/**
* Default certificate.
*/
public static final String KEYSTORE_CERTIFICATE_TYPE_DEFAULT = "SunX509";
/**
* Type of cipher algorithm used for encryption.
*/
public static final String KEYSTORE_CIPHER_ALGORITHM = "emfstore.keystore.cipher.algorithm";
/**
* Default cipher algorithm.
*/
public static final String KEYSTORE_CIPHER_ALGORITHM_DEFAULT = "RSA";
/**
* Property for projectstate persistence policy in versions. Possible values are <b>lastVersionOnly</b> and
* <b>everyVersion</b>. If you don't have every project state the server has to recalulate certain revisions if
* requested. On the other side saving every project state is quite redundant.
*/
public static final String PROJECTSTATE_VERSION_PERSISTENCE = "emfstore.persistence.version.projectstate";
/**
* Only the project state from the first and last version is stored, the other states are calculated by the changes.
*/
public static final String PROJECTSTATE_VERSION_PERSISTENCE_FIRSTANDLASTVERSIONONLY = "firstAndLastVersionOnly";
/**
* The projectstate of every x versions will be stored. This is used to save memory. Use x=1 to save every version.
*/
public static final String PROJECTSTATE_VERSION_PERSISTENCE_EVERYXVERSIONS = "everyXVersion";
/**
* Property for the count of versions, needed by the everyXVersion policy.
*/
public static final String PROJECTSTATE_VERSION_PERSISTENCE_EVERYXVERSIONS_X = "emfstore.persistence.version.projectstate.everyxversions";
/**
* Default value for the everyXVersion policy.
*/
public static final String PROJECTSTATE_VERSION_PERSISTENCE_EVERYXVERSIONS_X_DEFAULT = "1";
/**
* Default value for projectstate persistence policy in versions.
*/
public static final String PROJECTSPACE_VERSION_PERSISTENCE_DEFAULT = PROJECTSTATE_VERSION_PERSISTENCE_EVERYXVERSIONS;
/**
* Property for the count of versions, needed by the BACKUP everyXVersion policy.
*/
@Deprecated
public static final String PROJECTSTATE_VERSION_BACKUP_PERSISTENCE_EVERYXVERSIONS_X = "emfstore.persistence.version.backup.projectstate.everyxversions";
/**
* Default value for the BACKUP everyXVersion policy.
*/
@Deprecated
public static final String PROJECTSTATE_VERSION_BACKUP_PERSISTENCE_EVERYXVERSIONS_X_DEFAULT = "1";
/**
* Property for timeout time of a user session.
*/
public static final String SESSION_TIMEOUT = "emfstore.accesscontrol.session.timeout";
/**
* Default timeout (=30 min).
*/
public static final String SESSION_TIMEOUT_DEFAULT = "1800000";
/**
* Property for the super user.
*/
public static final String SUPER_USER = "emfstore.accesscontrol.authentication.superuser";
/**
* Default super user name.
*/
public static final String SUPER_USER_DEFAULT = "super";
/**
* Property for the super user's password.
*/
public static final String SUPER_USER_PASSWORD = "emfstore.accesscontrol.authentication.superuser.password";
/**
* Default super user password.
*/
public static final String SUPER_USER_PASSWORD_DEFAULT = "super";
/**
* Property for authentication policy used by server. E.g. ldap or property file.
*/
public static final String AUTHENTICATION_POLICY = "emfstore.accesscontrol.authentication.policy";
/**
* Use ldap for authentication.
*/
public static final String AUTHENTICATION_LDAP = "ldap";
/**
* Beginng tag of every ldap property. Format for ldap configuration is {@link #AUTHENTICATION_LDAP_PREFIX}
* .[numberOfLdapConfiguration].{ {@link #AUTHENTICATION_LDAP_URL}/ {@link #AUTHENTICATION_LDAP_BASE_DEFAULT}/
* {@link #AUTHENTICATION_LDAP_SEARCHDN} .
*/
public static final String AUTHENTICATION_LDAP_PREFIX = "emfstore.accesscontrol.authentication.ldap";
/**
* Ldap url.
*/
public static final String AUTHENTICATION_LDAP_URL = "url";
/**
* LDAP user authentication key.
*/
public static final String AUTHENTICATION_LDAP_AUTHUSER = "authuser";
/**
* LDAP password authentication key.
*/
public static final String AUTHENTICATION_LDAP_AUTHPASS = "authpass";
/**
* Ldap base.
*/
public static final String AUTHENTICATION_LDAP_BASE = "base";
/**
* Searchdn for ldap.
*/
public static final String AUTHENTICATION_LDAP_SEARCHDN = "searchdn";
/**
* Use simple property file for authentication.
*/
public static final String AUTHENTICATION_SPFV = "spfv";
/**
* Default authentication policy: ldap.
*/
public static final String AUTHENTICATION_POLICY_DEFAULT = AUTHENTICATION_SPFV;
/**
* Path to property file for spfv authentication.
*/
public static final String AUTHENTICATION_SPFV_FILEPATH = "emfstore.accesscontrol.authentication.spfv";
/**
* Default filepath for spfv authentication.
*
* @deprecated use {@link #getDefaultSPFVFilePath()}
*/
@Deprecated
public static final String AUTHENTICATION_SPFV_FILEPATH_DEFAULT = getConfDirectory() + "user.properties";
/**
* Property to validate server on start up.
*/
public static final String VALIDATE_SERVERSPACE_ON_SERVERSTART = "emfstore.validation";
/**
* Sets the level of validation. The level is set via bitmask, use the values
* {@link org.eclipse.emf.emfstore.server.startup.EmfStoreValidator#RESOLVEALL},
* {@link org.eclipse.emf.emfstore.server.startup.EmfStoreValidator#MODELELEMENTID} and
* {@link org.eclipse.emf.emfstore.server.startup.EmfStoreValidator#PROJECTGENERATION}. E.g.: If you want to resolve
* all elements and check use the modelelement id validation, you have to set the level to <code>1 | 2</code>, which
* is 3.
*/
public static final String VALIDATION_LEVEL = "emfstore.validation.level";
/**
* Default validation level.
*/
public static final String VALIDATION_LEVEL_DEFAULT = "7";
/**
* Exclude projects from validation, use {@link #MULTI_PROPERTY_SEPERATOR} to seperate them.
*/
public static final String VALIDATION_PROJECT_EXCLUDE = "emfstore.validation.exclude";
/**
* By default, no project is excluded.
*/
public static final String VALIDATION_PROJECT_EXCLUDE_DEFAULT = "";
/**
* Property for loading startup listeners from extension point.
*/
public static final String LOAD_STARTUP_LISTENER = "emfstore.startup.loadlistener";
/**
* Property for loading post startup listeners from extension point.
*/
public static final String LOAD_POST_STARTUP_LISTENER = "emfstore.startup.post.loadlistener";
/**
* Default value for {@link #LOAD_STARTUP_LISTENER}.
*/
public static final String LOAD_STARTUP_LISTENER_DEFAULT = TRUE;
/**
* Property name of accepted client versions. Enter the version's names or any, seperate multiple entries with
* {@link #MULTI_PROPERTY_SEPERATOR}.
*/
public static final String ACCEPTED_VERSIONS = "emfstore.acceptedversions";
/**
* Allow any client version.
*/
public static final String ACCEPTED_VERSIONS_ANY = "any";
/**
* Seperator for multiple properties. E.g. acceptedversions = 0.1,0.2
*/
public static final String MULTI_PROPERTY_SEPERATOR = ",";
/*
* FILE EXTENSIONS
*/
/**
* File extension for main file: emfstore server storage.
*/
public static final String FILE_EXTENSION_MAINSTORAGE = ".uss";
/**
* File extension for main file: emfstore project historyF.
*/
public static final String FILE_EXTENSION_PROJECTHISTORY = ".uph";
/**
* File extension for main file: emfstore project version.
*/
public static final String FILE_EXTENSION_VERSION = ".upv";
/**
* File extension for main file: emfstore project state.
*/
public static final String FILE_EXTENSION_PROJECTSTATE = ".ups";
/**
* File extension for main file: emfstore change package.
*/
public static final String FILE_EXTENSION_CHANGEPACKAGE = ".ucp";
/*
* FILE PREFIXES
*/
/**
* File prefix for file: backup projectstate.
*/
@Deprecated
public static final String FILE_PREFIX_BACKUPPROJECTSTATE = "backup_";
/**
* File prefix for file: changepackage.
*/
public static final String FILE_PREFIX_CHANGEPACKAGE = "changepackage-";
/**
* File prefix for file: projectstate.
*/
public static final String FILE_PREFIX_PROJECTSTATE = "projectstate-";
/**
* File prefix for file: version.
*/
public static final String FILE_PREFIX_VERSION = "version-";
/**
* File prefix for folder: project.
*/
public static final String FILE_PREFIX_PROJECTFOLDER = "project-";
/**
* File name for model release number.
*/
public static final String MODEL_VERSION_FILENAME = "modelReleaseNumber";
/**
* Prefix for EMFStore Home Startup Argument.
*/
public static final String EMFSTORE_HOME = "-EMFStoreHome";
/**
* Whether user names should be matched case insensitively.
*/
public static final String AUTHENTICATION_MATCH_USERS_IGNORE_CASE = "emfstore.accesscontrol.authentication.matchusers.ignorecase";
private static boolean testing;
private static Properties properties;
private ServerConfiguration() {
// nothing to do
}
/**
* Return the configuration directory location.
*
* @return the dir path string
*/
public static String getConfDirectory() {
StringBuffer sb = new StringBuffer(getServerHome());
sb.append(".");
sb.append(File.separatorChar);
sb.append("conf");
sb.append(File.separatorChar);
return sb.toString();
}
/**
* Return the configuration file location.
*
* @return the file path string
*/
public static String getConfFile() {
return getConfDirectory() + "es.properties";
}
private static LocationProvider locationProvider;
private static PermissionSetConfiguration permissionSetConfiguration;
/**
* Return the server home directory location.
*
* @return the dir path string
*/
public static String getServerHome() {
String workspaceDirectory = getLocationProvider().getWorkspaceDirectory();
File workspace = new File(workspaceDirectory);
if (!workspace.exists()) {
workspace.mkdirs();
}
if (!workspaceDirectory.endsWith(File.separator)) {
return workspaceDirectory + File.separatorChar;
}
return workspaceDirectory;
}
/**
* Returns the registered {@link LocationProvider} or if not existent, the {@link DefaultWorkspaceLocationProvider}.
*
* @return workspace location provider
*/
public static LocationProvider getLocationProvider() {
if (locationProvider == null) {
IConfigurationElement[] rawExtensions = Platform.getExtensionRegistry().getConfigurationElementsFor(
"org.eclipse.emf.emfstore.server.locationprovider");
for (IConfigurationElement extension : rawExtensions) {
try {
Object executableExtension = extension.createExecutableExtension("providerClass");
if (executableExtension instanceof LocationProvider) {
locationProvider = (LocationProvider) executableExtension;
}
} catch (CoreException e) {
String message = "Error while instantiating location provider, switching to default location!";
ModelUtil.logWarning(message, e);
}
}
if (locationProvider == null) {
locationProvider = new DefaultServerWorkspaceLocationProvider();
}
ModelUtil.logInfo("Using default path for EMFStore home:" + locationProvider.getWorkspaceDirectory());
}
return locationProvider;
}
/**
* Returns a {@link PermissionProvider} or fails if no such provider is registered
*
* @return
* @throws FatalEmfStoreException
*/
public static PermissionSetConfiguration getPermissionSetConfiguration() throws FatalEmfStoreException {
if (permissionSetConfiguration == null) {
try {
permissionSetConfiguration = new PermissionSetConfiguration(Platform.getExtensionRegistry()
.getConfigurationElementsFor("org.eclipse.emf.emfstore.server.accesscontrol"));
} catch (CoreException e) {
String message = "Error while instantiating permission provider!";
e.printStackTrace();
throw new FatalEmfStoreException(message + " " + e.getMessage());
}
if (permissionSetConfiguration == null) {
String message = "No permission provider found!";
throw new FatalEmfStoreException(message);
}
}
return permissionSetConfiguration;
}
/**
* Gets startup parameter from {@link Platform#getApplicationArgs()} which are in the form of
* -[parameterkey]=[parametervalue].
*
* @param parameter name of parameter key
* @return parameter as string or null
*/
public static String getStartArgument(String parameter) {
for (String arg : Platform.getApplicationArgs()) {
if (arg.startsWith(parameter) && arg.length() > parameter.length() && arg.charAt(parameter.length()) == '=') {
return arg.substring(parameter.length() + 1, arg.length());
}
}
return null;
}
/**
* Checks whether a parameter is set.
*
* @param parameter checks existence of parameter
* @return boolean
*/
public static boolean isStartArgSet(String parameter) {
for (String arg : Platform.getApplicationArgs()) {
if (arg.equals(parameter)) {
return true;
}
}
return false;
}
/**
* Default filepath for spfv authentication.
*
* @return path as string
*/
public static String getDefaultSPFVFilePath() {
return getConfDirectory() + "user.properties";
}
/**
* Gets the server's properties.
*
* @return properties
*/
public static Properties getProperties() {
if (properties == null) {
properties = new Properties();
}
return properties;
}
/**
* This method calls {@link Properties#getProperty(String)} and splits the resulting string, using
* {@link #MULTI_PROPERTY_SEPERATOR}.
*
* @param property property key
* @return String array or null
*/
public static String[] getSplittedProperty(String property) {
String result = getProperties().getProperty(property);
return (result == null) ? null : splitProperty(result);
}
/**
* This method calls {@link Properties#getProperty(String, String)} and splits the resulting string, using
* {@link #MULTI_PROPERTY_SEPERATOR}.
*
* @param property property key
* @param defaultValue default value
* @return String array or null
*/
public static String[] getSplittedProperty(String property, String defaultValue) {
String result = getProperties().getProperty(property, defaultValue);
return (result == null) ? null : splitProperty(result);
}
private static String[] splitProperty(String property) {
ArrayList<String> result = new ArrayList<String>();
for (String str : property.split(ServerConfiguration.MULTI_PROPERTY_SEPERATOR)) {
result.add(str.trim());
}
return result.toArray(new String[result.size()]);
}
/**
* Sets the server's properties.
*
* @param prop properties
*/
public static void setProperties(Properties prop) {
properties = prop;
}
/**
* Returns the path to the server's keystore.
*
* @return path to keystore
*/
public static String getServerKeyStorePath() {
return getServerHome() + SERVER_KEYSTORE_FILE;
}
/**
* Get the server version as in the org.eclipse.emf.emfstore.server manifest file.
*
* @return the server version number
*/
public static String getServerVersion() {
Bundle emfStoreBundle = Platform.getBundle("org.eclipse.emf.emfstore.server");
String emfStoreVersionString = emfStoreBundle.getHeaders().get(org.osgi.framework.Constants.BUNDLE_VERSION);
return emfStoreVersionString;
}
/**
* Determine if this is a release version or not.
*
* @return true if it is a release version
*/
public static boolean isReleaseVersion() {
return !getServerVersion().endsWith("qualifier") && !isInternalReleaseVersion();
}
/**
* Determines if this is an internal release or not.
*
* @return true if it an internal release
*/
public static boolean isInternalReleaseVersion() {
return getServerVersion().endsWith("internal");
}
/**
* Returns path to emfstore's main file.
*
* @return path
*/
public static String getServerMainFile() {
return getServerHome() + "storage" + FILE_EXTENSION_MAINSTORAGE;
}
/**
* Return the name of the model release number file. This file identifies the release number of the model in the
* workspace.
*
* @return the file name
*/
public static String getModelReleaseNumberFileName() {
return getServerHome() + MODEL_VERSION_FILENAME;
}
/**
* @param testing if server is running for testing
*/
public static void setTesting(boolean testing) {
ServerConfiguration.testing = testing;
}
/**
* @return if server is running for testing
*/
public static boolean isTesting() {
return testing;
}
}