| <?xml version="1.0"?> |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, |
| software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations |
| under the License. |
| --> |
| |
| <document> |
| |
| <properties> |
| <title>Intake Component</title> |
| <author email="epugh@upstate.com">Eric Pugh</author> |
| </properties> |
| |
| <body> |
| |
| <section name="Overview"> |
| <p> |
| This service provides access to input processing objects based on an XML |
| specification. |
| </p> |
| |
| <p> |
| It is written |
| for use in Turbine but it can be used in any container compatible |
| with Avalon's ECM container. |
| </p> |
| |
| <p> |
| The component uses the following services from the Fulcrum Repository |
| <ul> |
| <li> |
| <a href="http://turbine.apache.org/fulcrum/fulcrum-parser/">Fulcrum Parser Service</a> |
| </li> |
| </ul> |
| </p> |
| |
| </section> |
| |
| <section name="Configuration"> |
| <subsection name="Role Configuration"> |
| <source><![CDATA[ |
| <role |
| name="org.apache.fulcrum.intake.IntakeService" |
| shorthand="intake" |
| default-class="org.apache.fulcrum.intake.IntakeServiceImpl"/> |
| ]]></source> |
| </subsection> |
| |
| <subsection name="Component Configuration"> |
| <table> |
| <tr> |
| <th>Item</th> |
| <th>Datatype</th> |
| <th>Cardinality</th> |
| <th>Description</th> |
| </tr> |
| <tr> |
| <td>serialDataPath</td> |
| <td>String</td> |
| <td>[0|1]</td> |
| <td> |
| The file where the serialized XML files will be stored. The |
| default is <code>WEB-INF/appData.ser</code>. |
| </td> |
| </tr> |
| <tr> |
| <td>xmlPaths</td> |
| <td>Complex</td> |
| <td>[0|1]</td> |
| <td> |
| The list of XML files that contain rules for Intake. The |
| default is <code>WEB-INF/conf/intake.xml</code> |
| </td> |
| </tr> |
| <tr> |
| <td>xmlPaths/xmlPath</td> |
| <td>String</td> |
| <td>[1..n]</td> |
| <td> |
| A name of an XML file that contains rules for Intake. |
| </td> |
| </tr> |
| </table> |
| </subsection> |
| |
| <subsection name="Component Configuration Example"> |
| <source><![CDATA[ |
| <intake> |
| <serialDataPath>./target/appData.ser</serialDataPath> |
| <xmlPaths> |
| <xmlPath>src/test/xmlConf.xml</xmlPath> |
| <xmlPath>src/test/xmlConf2.xml</xmlPath> |
| </xmlPaths> |
| </intake> |
| ]]></source> |
| </subsection> |
| </section> |
| |
| </body> |
| </document> |
