server-reference.lyx.svn-base

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

\emph default
, '80') : The port to connect to.
\end_layout

\begin_layout Itemize

\series bold
servlet
\series default
 (
\emph on
string
\emph default
, 'geonetwork').
 The servlet name choosen in the remote site.
\end_layout

\end_deeper
\begin_layout Itemize

\series bold
account
\series default
 : A container for account information.
 Can be omitted.
\end_layout

\begin_deeper
\begin_layout Itemize

\series bold
use
\series default
 (
\emph on
boolean
\emph default
, 'false') : True means that the harvester will use the provided username
 and password to authenticate itself.
\end_layout

\begin_layout Itemize

\series bold
username
\series default
 (
\emph on
string
\emph default
, '') : Username on the remote node.
\end_layout

\begin_layout Itemize

\series bold
password
\series default
 (
\emph on
string
\emph default
, '') : Password on the remote node.
\end_layout

\end_deeper
\begin_layout Itemize

\series bold
searches
\series default
 : A container for search parameters.
 Can be omitted.
\end_layout

\begin_deeper
\begin_layout Itemize

\series bold
search
\series default
 : A container for a single search on a siteID.
 You can specify 0 or more searches but to properly harvest you have to
 provide at least one.
\end_layout

\begin_deeper
\begin_layout Itemize

\series bold
freeText
\series default
 (
\emph on
string
\emph default
, '') : Free text to search.
 This and the following parameters are the same used during normal search
 using the web interface.
\end_layout

\begin_layout Itemize

\series bold
title
\series default
 (
\emph on
string
\emph default
, '')
\end_layout

\begin_layout Itemize

\series bold
abstract
\series default
 (
\emph on
string
\emph default
, '')
\end_layout

\begin_layout Itemize

\series bold
keywords
\series default
 (
\emph on
string
\emph default
, '')
\end_layout

\begin_layout Itemize

\series bold
digital
\series default
 (
\emph on
boolean
\emph default
, 'false')
\end_layout

\begin_layout Itemize

\series bold
hardcopy
\series default
 (
\emph on
boolean
\emph default
, 'false')
\end_layout

\begin_layout Itemize

\series bold
siteId
\series default
 (
\emph on
string
\emph default
, '') : On of the siteIDs present on the remote node.
\end_layout

\end_deeper
\end_deeper
\begin_layout Itemize

\series bold
options
\series default
 : A container for generic options.
 Can be omitted.
\end_layout

\begin_deeper
\begin_layout Itemize

\series bold
every
\series default
 (
\emph on
integer
\emph default
, '90') : Harvesting interval in minutes.
\end_layout

\begin_layout Itemize

\series bold
createGroups
\series default
 (
\emph on
boolean
\emph default
, 'true') : If true, GeoNetwork tries to keep remote privileges creating
 local groups.
 After the harvesting, the local node will have all the remote node's groups.
 A group is created locally only if it does not already exist.
 The group's name is used to establish that.
\end_layout

\begin_layout Itemize

\series bold
oneRunOnly
\series default
 (
\emph on
boolean
\emph default
, 'false') : After the first run, the entry's status will be set to 
\family sans
\series bold
inactive
\family default
\series default
.
\end_layout

\end_deeper
\end_deeper
\begin_layout Standard
Please note that even if clients can store empty values ('') for many parameters
, before starting the harvesting entry those parameters should be properly
 set in order to avoid errors.
\end_layout

\begin_layout Standard
Here is an example of an XML request to create a GeoNetwork entry:
\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
<node name="South Africa" type="geonetwork">   
\end_layout

\begin_layout LyX-Code

\size footnotesize
   <site>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <host>south.africa.org</host>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <port>8080</port>     
\end_layout

\begin_layout LyX-Code

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

\begin_layout LyX-Code

\size footnotesize
      <account>       
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <use>true</use>       
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <username>admin</username>       
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <password>admin</password>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      </account>   
\end_layout

\begin_layout LyX-Code

\size footnotesize
   </site>   
\end_layout

\begin_layout LyX-Code

\size footnotesize
   <searches>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <search>       
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <freeText />       
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <title />       
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <abstract />       
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <keywords />       
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <digital>true</digital>       
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <hardcopy>false</hardcopy>       
\end_layout

\begin_layout LyX-Code

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

\begin_layout LyX-Code

\size footnotesize
      </search>   
\end_layout

\begin_layout LyX-Code

\size footnotesize
   </searches>   
\end_layout

\begin_layout LyX-Code

\size footnotesize
   <options>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <every>90</every>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <createGroups>true</createGroups>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <oneRunOnly>false</oneRunOnly>   
\end_layout

\begin_layout LyX-Code

\size footnotesize
   </options> 
\end_layout

\begin_layout LyX-Code

\size footnotesize
</node> 
\end_layout

\begin_layout LyX-Code

\end_layout

\end_inset


\end_layout

\begin_layout Standard
To create a WebFolder entry, the following XML information should be provided:
\end_layout

\begin_layout Itemize

\series bold
node
\series default
 : This is the root container.
 The 
\family sans
\series bold
name
\family default
\series default
 attribute specifies the entry's name.
 If omitted, an empty string is considered.
 The 
\family sans
\series bold
type
\family default
\series default
 attribute is mandatory and must be 
\family sans
\series bold
webFolder
\family default
\series default
.
\end_layout

\begin_deeper
\begin_layout Itemize

\series bold
site
\series default
 : A container for site information.
 Can be omitted.
\end_layout

\begin_deeper
\begin_layout Itemize

\series bold
url
\series default
 (
\emph on
string
\emph default
, '') : The URL to harvest from.
 If provided, must be a valid URL starting with 'HTTP://'.
\end_layout

\begin_layout Itemize

\series bold
account
\series default
 : A container for account information.
 Can be omitted.
\end_layout

\begin_deeper
\begin_layout Itemize

\series bold
use
\series default
 (
\emph on
boolean
\emph default
, 'false') : If true, GeoNetwork will use the basic HTTP authentication.
\end_layout

\begin_layout Itemize

\series bold
username
\series default
 (
\emph on
string
\emph default
, '') : Username on the remote node.
\end_layout

\begin_layout Itemize

\series bold
password
\series default
 (
\emph on
string
\emph default
, '') : Password on the remote node.
\end_layout

\end_deeper
\end_deeper
\begin_layout Itemize

\series bold
privileges
\series default
 : A container for privileges that must be associated to the harvested metadata.
 Can be omitted but doing so the harvested metadata will not be visible.
\end_layout

\begin_deeper
\begin_layout Itemize

\series bold
group
\series default
 : A container for the privileges to associate to this group.
 It must have an 
\family sans
\series bold
id
\family default
\series default
 attribute which value should be the identifier of a GeoNetwork group.
 If the id is not a valid group id, the contained privileges will be discarded.
\end_layout

\begin_deeper
\begin_layout Itemize

\series bold
operation
\series default
 : Specifies an operation to associate to the containing group.
 It must have a 
\family sans
\series bold
name
\family default
\series default
 attribute which value can be one of : 
\family sans
\series bold
view
\family default
\series default
, 
\family sans
\series bold
download
\family default
\series default
, 
\family sans
\series bold
dynamic
\family default
\series default
, 
\family sans
\series bold
notify
\family default
\series default
, 
\family sans
\series bold
featured
\family default
\series default
.
\end_layout

\end_deeper
\end_deeper
\begin_layout Itemize

\series bold
options
\series default
 : A container for generic options.
 Can be omitted.
\end_layout

\begin_deeper
\begin_layout Itemize

\series bold
every
\series default
 (
\emph on
integer
\emph default
, '90') : Harvesting interval in minutes.
\end_layout

\begin_layout Itemize

\series bold
oneRunOnly
\series default
 (
\emph on
boolean
\emph default
, 'false') : After the first run, the entry's status will be set to 
\family sans
\series bold
inactive
\family default
\series default
.
\end_layout

\begin_layout Itemize

\series bold
structure
\series default
 (
\emph on
boolean
\emph default
, 'false') : When true, the folders present at the remote host will provide
 additional information about categories and siteIDs.
\end_layout

\begin_layout Itemize

\series bold
validate
\series default
 (
\emph on
boolean
\emph default
, 'false') : When true, GeoNetwork will validate every metadata against
 its schema.
 If the metadata is not valid, it will not be imported.
\end_layout

\end_deeper
\end_deeper
\begin_layout Standard
Here is an example of an XML request to create a web folder entry:
\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
<node name="Asia remote node" type="webFolder">   
\end_layout

\begin_layout LyX-Code

\size footnotesize
   <site>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <url>http://www.mynode.org/metadata</url>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <account>       
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <use>true</use>       
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <username>admin</username>       
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <password>admin</password>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      </account>   
\end_layout

\begin_layout LyX-Code

\size footnotesize
   </site>   
\end_layout

\begin_layout LyX-Code

\size footnotesize
   <options>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <every>90</every>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <oneRunOnly>false</oneRunOnly>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <structure>false</structure>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <validate>true</validate>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <status>inactive</status>   
\end_layout

\begin_layout LyX-Code

\size footnotesize
   </options>   
\end_layout

\begin_layout LyX-Code

\size footnotesize
   <privileges>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <group id="0">       
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <operation name="view" />     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      </group>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <group id="14">       
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <operation name="download" />     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      </group>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
   </privileges>
\end_layout

\begin_layout LyX-Code

\size footnotesize
</node> 
\end_layout

\begin_layout LyX-Code

\end_layout

\end_inset


\end_layout

\begin_layout Subsection*
Response
\end_layout

\begin_layout Standard
The service's response is the output of the 
\family sans
\series bold
xml.harvesting.get
\family default
\series default
 service of the newly created entry.
 So, the response is similar to the request but with some more information:
\end_layout

\begin_layout Itemize
An 
\family sans
\series bold
id
\family default
\series default
 attribute to the 
\family sans
\series bold
node
\family default
\series default
 root element.
 This is the internal identifier that must be used to update/start/stop
 the entry.
\end_layout

\begin_layout Itemize
An 
\family sans
\series bold
info
\family default
\series default
 element with some information and statistics.
\end_layout

\begin_layout Section
xml.harvesting.update
\end_layout

\begin_layout Standard
This service is responsible to change the entry's parameters.
 A typical request has a 
\family sans
\series bold
node
\family default
\series default
 root element and must include the 
\family sans
\series bold
id
\family default
\series default
 attribute:
\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
<node id="24">
\end_layout

\begin_layout LyX-Code