server-reference.lyx.svn-base

由国外的一个著名的geonetwork修改而来

#LyX 1.4.2 created this file. For more info see http://www.lyx.org/
\lyxformat 245
\begin_document
\begin_header
\textclass book
\begin_preamble
\usepackage{a4}
\usepackage {times}
\usepackage[left=2cm,right=2cm,top=2cm,bottom=2cm]{geometry}
\let\myTOC\tableofcontents 
\renewcommand{\tableofcontents}{% 
  \begingroup 
%  \let\ps@plain\ps@empty 
  \pagenumbering{roman}
  \myTOC 
  \clearpage 
  \endgroup% 
  \pagenumbering{arabic}
}
\end_preamble
\language english
\inputencoding auto
\fontscheme times
\graphics default
\paperfontsize 12
\spacing single
\papersize a4paper
\use_geometry false
\use_amsmath 1
\cite_engine basic
\use_bibtopic false
\paperorientation portrait
\leftmargin -20cm
\rightmargin -20cm
\secnumdepth 3
\tocdepth 3
\paragraph_separation skip
\defskip medskip
\quotes_language swedish
\papercolumns 1
\papersides 2
\paperpagestyle headings
\tracking_changes false
\output_changes true
\end_header

\begin_body

\begin_layout Standard
\align center
\begin_inset ERT
status collapsed

\begin_layout Standard


\backslash
thispagestyle{empty}
\end_layout

\end_inset


\end_layout

\begin_layout Standard
\begin_inset VSpace vfill
\end_inset


\end_layout

\begin_layout Standard
\align center

\series bold
\size huge
GeoNetwork's Server Reference
\end_layout

\begin_layout Standard
\begin_inset VSpace vfill
\end_inset


\end_layout

\begin_layout Standard
\align center

\size larger
Author: 
\series bold
\noun on
Andrea Carboni
\end_layout

\begin_layout Standard
\begin_inset VSpace bigskip
\end_inset


\end_layout

\begin_layout Standard
\align center

\size larger
Revision 1 (06-Sep-2006)
\end_layout

\begin_layout Standard

\newpage

\end_layout

\begin_layout Standard
\begin_inset ERT
status collapsed

\begin_layout Standard


\backslash
thispagestyle{empty}
\end_layout

\end_inset


\end_layout

\begin_layout Chapter*
Introduction
\begin_inset ERT
status collapsed

\begin_layout Standard


\backslash
thispagestyle{empty}
\end_layout

\end_inset


\end_layout

\begin_layout Standard
This document gives some insights about the internal structure of GeoNetwork.
\end_layout

\begin_layout Standard
\begin_inset LatexCommand \tableofcontents{}

\end_inset


\end_layout

\begin_layout Part
Basic Operations
\end_layout

\begin_layout Chapter
Compiling and running GeoNetwork
\end_layout

\begin_layout Section
System Requirements
\end_layout

\begin_layout Section
Package structure
\end_layout

\begin_layout Section
Source code structure
\end_layout

\begin_layout Section
Compiling GeoNetwork
\end_layout

\begin_layout Part
Protocols
\end_layout

\begin_layout Chapter
Harvesting
\end_layout

\begin_layout Chapter
Metadata Exchange Format
\end_layout

\begin_layout Part
XML Services
\end_layout

\begin_layout Chapter
Calling specifications
\end_layout

\begin_layout Standard
tramite http get/post
\end_layout

\begin_layout Chapter
General services
\end_layout

\begin_layout Section
xml.info
\end_layout

\begin_layout Standard
The 
\family sans
xml.info
\family default
 service can be used to query the site about its configuration, services,
 status and so on.
 For example, it is used by the harvesting web interface to retrieve information
 about a remote node.
\end_layout

\begin_layout Subsection*
Request
\end_layout

\begin_layout Standard
The xml request should contain at least one 
\family sans
\series bold
type
\family default
\series default
 element to indicates the kind of information to retrieve.
 More 
\family sans
\series bold
type
\family default
\series default
 elements can be specified to obtain more information at once.
 The set of allowed values are:
\end_layout

\begin_layout List
\labelwidthstring 00.00.0000

\series bold
site
\series default
 Returns general information about the site like its name, id, etc...
\end_layout

\begin_layout List
\labelwidthstring 00.00.0000

\series bold
categories
\series default
 Returns all the site's categories
\end_layout

\begin_layout List
\labelwidthstring 00.00.0000

\series bold
groups
\series default
 Returns all the site's groups
\end_layout

\begin_layout List
\labelwidthstring 00.00.0000

\series bold
knownNodes
\series default
 Returns all geonetwork nodes that the remote site knows.
 Every time the remote site harvests from other nodes, it collects information
 about their address, name, siteId etc...
 This allows the propagation of the GeoNetwork sites to facilitate harvesting
 of new sites.
 Anyway, the remote node may know other nodes by other ways.
\end_layout

\begin_layout Standard
Request example:
\end_layout

\begin_layout Standard
\begin_inset Box Boxed
position "t"
hor_pos "c"
has_inner_box 1
inner_pos "t"
use_parbox 0
width "100col%"
special "none"
height "1in"
height_special "totalheight"
status open

\begin_layout LyX-Code

\size footnotesize
<request>
\end_layout

\begin_layout LyX-Code

\size footnotesize
   <type>site</type>
\end_layout

\begin_layout LyX-Code

\size footnotesize
   <type>groups</type>
\end_layout

\begin_layout LyX-Code

\size footnotesize
</request>
\end_layout

\end_inset


\end_layout

\begin_layout Subsection*
Response
\end_layout

\begin_layout Standard
Each 
\family sans
\series bold
type
\family default
\series default
 element produces an XML subtree so the response to the previous request
 is like this:
\end_layout

\begin_layout Standard
\begin_inset Box Boxed
position "t"
hor_pos "c"
has_inner_box 1
inner_pos "t"
use_parbox 0
width "100col%"
special "none"
height "1in"
height_special "totalheight"
status open

\begin_layout LyX-Code

\size footnotesize
<response>
\end_layout

\begin_layout LyX-Code

\size footnotesize
   <site>...</site>
\end_layout

\begin_layout LyX-Code

\size footnotesize
   <groups>...</groups>
\end_layout

\begin_layout LyX-Code

\size footnotesize
</response>
\end_layout

\end_inset


\end_layout

\begin_layout Standard
Here follows the structure of each subtree:
\end_layout

\begin_layout Itemize

\series bold
site
\series default
 : This is the container
\end_layout

\begin_deeper
\begin_layout Itemize

\series bold
name
\series default
 : Human readable site name
\end_layout

\begin_layout Itemize

\series bold
siteId
\series default
 : Universal unique identifier of the site
\end_layout

\begin_layout Itemize

\series bold
logo
\series default
 : Absolute path of the site's logo image.
 This is the full path except for the host name/port.
 Note that the name of the image is its UUID
\end_layout

\begin_layout Itemize

\series bold
platform
\series default
 : This is just a container to hold the site's backend
\end_layout

\begin_deeper
\begin_layout Itemize

\series bold
name
\series default
 : Plaform name.
 For GeoNetwork installations it must be 
\family sans
\series bold
geonetwork
\family default
\series default
.
\end_layout

\begin_layout Itemize

\series bold
version
\series default
 : Platform version, given in the X.Y.Z format
\end_layout

\end_deeper
\end_deeper
\begin_layout Standard
Example:
\end_layout

\begin_layout Standard
\begin_inset Box Boxed
position "t"
hor_pos "s"
has_inner_box 1
inner_pos "t"
use_parbox 0
width "100col%"
special "none"
height "1in"
height_special "totalheight"
status open

\begin_layout LyX-Code

\size footnotesize
<site>
\end_layout

\begin_layout LyX-Code

\size footnotesize
   <name>My site</name>
\end_layout

\begin_layout LyX-Code

\size footnotesize
   <siteId>0619cc50-708b-11da-8202-000d9335906e</siteId>
\end_layout

\begin_layout LyX-Code

\size footnotesize
   <icon>/geonetwork/images/logos/
\end_layout

\begin_layout LyX-Code

\size footnotesize
          0619cc50-708b-11da-8202-000d9335906e.png</icon>
\end_layout

\begin_layout LyX-Code

\size footnotesize
   <platform>
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <name>geonetwork</name>
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <version>2.1.0</version>
\end_layout

\begin_layout LyX-Code

\size footnotesize
   </platform>
\end_layout

\begin_layout LyX-Code

\size footnotesize
</site>
\end_layout

\end_inset


\end_layout

\begin_layout Itemize

\series bold
categories
\series default
 : This is the container for categories
\end_layout

\begin_deeper
\begin_layout Itemize

\series bold
category
\series default
 [0..n] : A single GeoNetwork's category
\end_layout

\begin_deeper
\begin_layout Itemize

\series bold
name
\series default
 : Category's name
\end_layout

\begin_layout Itemize

\series bold
label
\series default
 : The label used to show the category on screen.
 This is just a container for the localized strings in all supported languages.
\end_layout

\begin_deeper
\begin_layout Itemize

\series bold
en
\series default
 : Localized label in english
\end_layout

\begin_layout Itemize

\series bold
fr
\series default
 : Localized label in french
\end_layout

\begin_layout Itemize
...
\end_layout

\end_deeper
\end_deeper
\end_deeper
\begin_layout Standard
\begin_inset Box Boxed
position "t"
hor_pos "c"
has_inner_box 1
inner_pos "t"
use_parbox 0
width "100col%"
special "none"
height "1in"
height_special "totalheight"
status open

\begin_layout LyX-Code

\size footnotesize
<categories>
\end_layout

\begin_layout LyX-Code

\size footnotesize
   <category>
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <name>datasets</name>
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <label>
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <en>Datasets</en>
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <fr>I don't know</fr>
\end_layout

\begin_layout LyX-Code

\size footnotesize
      </label>
\end_layout

\begin_layout LyX-Code

\size footnotesize
   </category>
\end_layout

\begin_layout LyX-Code

\size footnotesize
</categories>
\end_layout

\begin_layout LyX-Code

\end_layout

\end_inset


\end_layout

\begin_layout Itemize

\series bold
groups
\series default
 : This is the container for groups
\end_layout

\begin_deeper
\begin_layout Itemize

\series bold
group
\series default
 [2..n] : This is a Geonetwork group.
 There are at least the internet and intranet groups
\end_layout

\begin_deeper
\begin_layout Itemize

\series bold
name
\series default
 : Group's name
\end_layout

\begin_layout Itemize

\series bold
label
\series default
 : The label used to show the group on screen.
 This is just a container for the localized strings in all supported languages.
\end_layout

\begin_deeper
\begin_layout Itemize

\series bold
en
\series default
 : Localized label in english
\end_layout

\begin_layout Itemize

\series bold
fr
\series default
 : Localized label in french
\end_layout

\begin_layout Itemize
...
\end_layout

\end_deeper
\end_deeper
\end_deeper
\begin_layout Standard
\begin_inset Box Boxed
position "t"
hor_pos "c"
has_inner_box 1
inner_pos "t"
use_parbox 0
width "100col%"
special "none"
height "1in"
height_special "totalheight"
status open

\begin_layout LyX-Code

\size footnotesize
<groups>
\end_layout

\begin_layout LyX-Code

\size footnotesize
   <group>
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <name>editors</name>
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <label>
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <en>Editors</en>
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <fr>I don't know</fr>
\end_layout

\begin_layout LyX-Code

\size footnotesize
      </label>
\end_layout

\begin_layout LyX-Code

\size footnotesize
   </group>
\end_layout

\begin_layout LyX-Code

\size footnotesize
</groups>
\end_layout

\end_inset


\end_layout

\begin_layout Itemize

\series bold
knownNodes
\series default
 : This is the container
\end_layout

\begin_deeper
\begin_layout Itemize

\series bold
node
\series default
 [0..n] : A known GeoNetwork node
\end_layout

\begin_deeper
\begin_layout Itemize

\series bold
name
\series default
 : Node's name
\end_layout

\begin_layout Itemize

\series bold
siteId
\series default
 : Node's unique identifier
\end_layout

\begin_layout Itemize

\series bold
icon
\series default
 : relative local path of the remote node's icon.
 Notice that this is the path to get the icon from the node being queried
 not the path on the remote note.
 To discover that, call 
\family sans
\series bold
xml.info
\family default
\series default
 on the remote note.
\end_layout

\begin_layout Itemize

\series bold
host
\series default
 : Node's host
\end_layout

\begin_layout Itemize

\series bold
port
\series default
 : Node's port.
 Can be empty
\end_layout

\begin_layout Itemize

\series bold
servlet
\series default
 : Node's servlet.
 Together with host and port can be used to call services on the remote
 node.
\end_layout

\begin_layout Itemize

\series bold
metadata
\series default
 : This is just the number of metadata that have been harvested from the
 remote node.
 This is used by the harvesting web interface to provide some hints to the
 user.
\end_layout

\end_deeper
\end_deeper
\begin_layout Standard
\begin_inset Box Boxed
position "t"
hor_pos "c"
has_inner_box 1
inner_pos "t"
use_parbox 0
width "100col%"
special "none"
height "1in"
height_special "totalheight"
status open

\begin_layout LyX-Code

\size footnotesize
<knownNodes>
\end_layout

\begin_layout LyX-Code

\size footnotesize
   <node>
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <name>My Host</name>
\end_layout

\begin_layout LyX-Code

\size footnotesize