diff options
Diffstat (limited to 'plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/operators/Doc00_OperatingServer.java')
-rw-r--r-- | plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/operators/Doc00_OperatingServer.java | 99 |
1 files changed, 99 insertions, 0 deletions
diff --git a/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/operators/Doc00_OperatingServer.java b/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/operators/Doc00_OperatingServer.java new file mode 100644 index 0000000000..1f77849777 --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/operators/Doc00_OperatingServer.java @@ -0,0 +1,99 @@ +/* + * Copyright (c) 2015 Eike Stepper (Berlin, Germany) and others. + * 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: + * Eike Stepper - initial API and implementation + */ +package org.eclipse.emf.cdo.doc.operators; + +import org.eclipse.emf.cdo.doc.operators.Doc01_ConfiguringRepositories.Element_store; +import org.eclipse.emf.cdo.doc.users.Doc02_ManagingRepositories; + +/** + * Operating a CDO Server + * <p> + * <b>Table of Contents</b> {@toc} + * + * @author Eike Stepper + */ +public class Doc00_OperatingServer +{ + /** + * Deploying a CDO Server + * <p> + * The easiest way to deploy a stand-alone CDO Server is to download the latest + * <a href="http://wiki.eclipse.org/Eclipse_Installer">Eclipse Installer</a> for the target environment: + * <ul> + * <li><a href="http://www.eclipse.org/downloads/download.php?file=/oomph/products/latest/eclipse-inst-win64.exe">Windows 64 Bit</a> (self-extracting exe) + * <li><a href="http://www.eclipse.org/downloads/download.php?file=/oomph/products/latest/eclipse-inst-win32.exe">Windows 32 Bit</a> (self-extracting exe) + * <li><a href="http://www.eclipse.org/downloads/download.php?file=/oomph/products/latest/eclipse-inst-mac64.tar.gz">Mac OS 64 Bit</a> (tar.gz) + * <li><a href="http://www.eclipse.org/downloads/download.php?file=/oomph/products/latest/eclipse-inst-linux64.tar.gz">Linux 64 Bit</a> (tar.gz) + * <li><a href="http://www.eclipse.org/downloads/download.php?file=/oomph/products/latest/eclipse-inst-linux32.tar.gz">Linux 32 Bit</a> (tar.gz) + * </ul> + * <p> + * When the Eclipse Installer is started, select the "CDO Server" application: + * {@img eclipse-installer.png} + * <p> + * On the second page make sure you select the product version (of the CDO Server) that matches your clients' versions: + * {@img eclipse-installer.png} + * <p> + * When the installation has finished the "eclipse" folder under the installation folder contains the <b>cdo-server.xml</b> + * configuration file, which looks similar to this: + * {@link #cdoServerXML() cdo‑server.xml} + * <p> + * Please note that many {@link Doc02_ManagingRepositories repository configuration options} can <b>not</b> be changed anymore after the repository + * has been started the first time. + * + * @see Doc01_ConfiguringRepositories + * @see Doc02_ConfiguringAcceptors + * @see Doc03_ManagingSecurity + */ + public class Doc_ServerDeploy + { + /** + * @snippet xml cdo-server.xml + */ + public void cdoServerXML() + { + } + } + + /** + * Starting a CDO Server + * <p> + * Starting a CDO Server differs a little bit depending on the target environment: + * <ul> + * <li> On <b>Windows</b> double-click the <code>eclipsec.exe</code> file (mind the last "c"). + * <li> On <b>Mac OS</b> start the <code>Eclipse.app/Contents/MacOS/eclipse</code> executable from a terminal window. + * <li> On <b>Linux</b> start the normal <code>eclipse</code> executable from a terminal window. + * </ul> + * <p> + * After successful start of the server the console should look similar to this: + * {@img server-start.png} + * <p> + * Please note that many {@link Doc02_ManagingRepositories repository configuration options} can <b>not</b> be changed anymore after the repository + * has been started the first time. + * + * @see Doc01_ConfiguringRepositories + */ + public class Doc_ServerStart + { + } + + /** + * Stopping a CDO Server + * <p> + * To gracefully shut down a running CDO server enter the command "<code>close</code>" into the console and confirm with "<code>yes</code>": + * {@img server-stop.png} + * <p> + * Please note that the {@link Element_store DBStore} supports automatic crash detection and recovery at startup time. + * Other store may or may not support similar functionality. + */ + public class Doc_ServerStop + { + } +} |