Project

General

Profile

Actions

CDM Server » History » Revision 13

« Previous | Revision 13/32 (diff) | Next »
Andreas Kohlbecker, 11/13/2009 02:32 PM


CDM Community Server

A Central datastore for a community of users (taxonomically, geographically or otherwise defined). The community store server is used to centrally host versionable CommonDataModel data.

The store makes use of the CdmLibrary and exposes webservices based on the CdmLibrary service layer.

The CDM store is a central piece of the platform and applications that are able to interface with this store are considered part of the platform.


Getting Started

The CDM Community Server comes in two flavors. As standalone server (@cdmserver-standalone.jar@) and as war archive (@cdmserver.war@). Using the standalone server is the easiest and recommended way to get a CDM Community Server up and running. Installing the cdmserver.war into Tomcat is currently not recommended due to a known memory leak which occured only in this combination. The standalone server does not have this problem.

In the following the required steps to install the standalone server are described. Currently there is no official guidance on installing the war, bur interested developers may refer to the WebserviceDeployment page to get some hints.

Installing the standalone server

The standalone server is platform independent, so it can be installed and run on Windows, Linux and Mac OS as long as the Java runtime environment is installed on the system.

This install guide describes the installation of the standalone server on a Debian linux system and should also be compatible with Ubuntu systems.

  1. Download the cdmserver-standalone.jar":http://dev.e-taxonomy.eu/download/cdmserver/2.2/cdmserver-standalone.jar and the init script "cdmserver":http://dev.e-taxonomy.eu/download/cdmserver/2.2/initscript/cdmserver and the "datasources.xml

  2. Store cdmserver-standalone.jar in the filesystem of your server.

  3. Copy the init script cdmserver into /etc/init.d/ and adapt the permissions and the ownership:

cp cdmserver /etc/init.d/
chmod 755 cdmserver
chown root:root cdmserver
  1. Edit in the init script cdmserver the CDM_HOME path variable to macth the path where cdmserver-standalone.jar has been stored in step 2.

  2. Create the .cdmLibrary folder in CDM_HOME

  3. Install the init script cdmserver by running the following command:

update-rc.d cdmserver defaults
  1. Copy datasources.xml into it and edit this file to match your cdm data bases.

  2. Start the cdm server:

/etc/init.d/cdmserver start
  1. You can stop the server by executing
/etc/init.d/cdmserver stop

Webservices

Srvices/APIs exposed by the community store are:

XML/JSON REST

Mainly read operations exposing CdmDataTransferObjects for the CdmDataportal. The services are URL encoded REST services and the http content-type of a request specifies whether XML (default) or JSON will be returned. For further details please refer to CDM REST Services.

The detailed list of implemented and planned operations can be found at wiki:CdmAPI#RemoteAPI

RSS Search feeds

Additionally to the search services provided by the REST API above, the same search methods will also be exposed as RSS feeds. This allows RSS clients, or wikipedia:Aggregator, to "subscribe" to specific searches as RSS feeds are natively ordered chronologically and new search entries therefore can easily be identified. It is planned that all PrimaryCdmObjects will be exposed for searches.

OAI-PMH

In order to build central aggregators is is planned to support the OAI-PMH protocol with selective date based harvesting. GBIF":http://www.gbif.net, "EOL or any other data aggregator will therefore be able to easily pool CDM data and keep their copy up to date by accessing incremental changes only - and not the entire CDM dataset every time.

LSID

The CDM Store will include an LSID resolver exposing PrimaryCdmObjects objects in RDF as TDWG LSID voc

Linkback Annotations

All pages should expose a linkback mechanism that allows to be aware of external comments done on popular blogging software. See Wikipedia:Linkback


File Server

Images

Please see ImageServer

Documents/PDF

We will use Drupal as a start

Updated by Andreas Kohlbecker over 14 years ago · 13 revisions