Project

General

Profile

« Previous | Next » 

Revision 80e86c86

Added by Andreas Kohlbecker over 11 years ago

site documentation updated

View differences:

.gitattributes
48 48
src/site/apt/index.apt -text
49 49
src/site/fml/faq.fml -text
50 50
src/site/fml/troubleshooting.fml -text
51
src/site/resources/images/cdmlib_overview_webservices.png -text
51 52
src/site/site.xml -text
src/site/apt/index.apt
1
Overview
2

  
3
  The CDM Community Standalone Server exposes data stored in a CDM data base to the web. It is basically a {{{http://wiki.eclipse.org/Jetty}Jetty}} based web application container bundeled with a simple management webapplication and with the remote component of the {{{http://wp5.e-taxonomy.eu/cdmlib/} CDM Library}}. The CDM Community Standalone Server is a Java application, so it can be installed in pronciple on any platform witch supports Java version 1.6. Using the CDM Standalone Server under Debian Linux and derivates or under Windows however is recommended since installers exist with integrate the server as services in the operatoin system.
4
  One single or multiple CDM databases can be exposed by a single installation of the CDM Server. For each data base a separate instance of the CDM Remote web apllication is will be launched which will require an specific amount of memory.
5
  
6
Web Services
7

  
8
  The CDM Web Application expose the CDM data through a bunch of different webservices:
9
  
10
    * <<CDM REST API>>: The {{{http://wp5.e-taxonomy.eu/cdmlib/rest-api.html} CDM REST API}} is a RESTful interface to resources stored in the CDM. The RESTful architecture allows accessing the various resources like Taxa, Names, References, Media, etc by stable URIs. The CDM REST Services architecture is functionally separated into four different parts, the API Service, a clean RESTful bit, which will expose data in a modular, normalized way. The Portal Service which is specially tailored for the needs of dataportals. The External Services are supporting non CDM applications and services like for example a map generation service, LSID Services. The Classification Service exposes special DTOs which combine data from the TaxonBase, TaxonNode and from the Classification entities.
11
    {{{http://wp5.e-taxonomy.eu/cdmlib/rest-api.html} more ...}}
12
    
13
    * <<OAI-PMH>>: In order to allow central aggregators harvesting the CDM Community Stores the {{{http://www.openarchives.org/OAI/openarchivesprotocol.html} OAI-PMH protocol}} with selective date based harvesting has been implemented in to the CDM Community Stores. {{{http://www.biodiversitylibrary.org/} BHL}}, {{{http://www.gbif.net} GBIF}}, {{{http://www.eol.org/} EOL}} or any other data aggregator therefore are able to easily pool CDM data selectively and keep their copy up to date by accessing incremental changes only.
14
   
src/site/fml/troubleshooting.fml
8 8
  <part id="general">
9 9
    <title>General</title>
10 10

  
11
    <faq id="whats-foo">
11
    <faq id="run-cdmlib-webapp">
12 12
      <question>
13
        What is Foo?
13
        How can I get help?
14 14
      </question>
15 15
      <answer>
16
        <p>some markup goes here</p>
17

  
18
        <source>some source code</source>
19

  
20
        <p>some markup goes here</p>
16
        <p>The troubelshooting section is still under construction. I order to get help, please contact us by email: editsupport@bgbm.org</p>
21 17
      </answer>
22 18
    </faq>
23 19

  
......
30 26
      </answer>
31 27
    </faq>
32 28
  </part>
33

  
34
  <part id="install">
35

  
36
    <title>Installation</title>
37

  
38
    <faq id="how-install">
39
      <question>
40
        How do I install Foo?
41
      </question>
42
      <answer>
43
        <p>some markup goes here</p>
44
      </answer>
45
    </faq>
46

  
47
  </part>
48

  
29
  
49 30
</faqs>
src/site/site.xml
8 8
	<body>
9 9
		<menu name="General Information">
10 10
			<item name="Overview" href="index.html"/>
11
			<item name="FAQ" href="faq.html"/>
12
			<item name="Download" href="download.html"/>
11
			<!--<item name="FAQ" href="faq.html"/>
12
			--><item name="Download" href="http://wp5.e-taxonomy.eu/download/cdmserver/stable/"/>
13 13
		</menu>
14 14
		<menu name="Developer">
15
			<item name="Getting started" href="getting-started.html"/>
16
			<item name="Troubleshooting" href="troubleshooting.html"/>
17
			<item name="Wiki" href="http://dev.e-taxonomy.eu/trac/wiki/CommunityServer"/>
15
			<item name="Getting started" href="http://wp5.e-taxonomy.eu/cdm-setups/cdmserver-installation"/>
16
			<!--<item name="Troubleshooting" href="troubleshooting.html"/>
17
			--><item name="Wiki" href="http://dev.e-taxonomy.eu/trac/wiki/CommunityServer"/>
18 18
		</menu>
19 19
		<menu name="Project">
20 20
			<item name="Mailing Lists" href="mail-lists.html"/>

Also available in: Unified diff