karaf/karaf-maven-plugin/src/site/xdoc/karaf-property-instructions-model.xml

   1 <?xml version="1.0"?>
   2     <!--
   3
   4         Licensed to the Apache Software Foundation (ASF) under one or more
   5         contributor license agreements.  See the NOTICE file distributed with
   6         this work for additional information regarding copyright ownership.
   7         The ASF licenses this file to You under the Apache License, Version 2.0
   8         (the "License"); you may not use this file except in compliance with
   9         the License.  You may obtain a copy of the License at
  10
  11            http://www.apache.org/licenses/LICENSE-2.0
  12
  13         Unless required by applicable law or agreed to in writing, software
  14         distributed under the License is distributed on an "AS IS" BASIS,
  15         WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16         See the License for the specific language governing permissions and
  17         limitations under the License.
  18     -->
  19
  20
  21
  22 <!-- =================== DO NOT EDIT THIS FILE ====================         -->
  23 <!-- Generated by Modello 1.8.3,                                            -->
  24 <!-- any modifications will be overwritten.                                 -->
  25 <!-- ==============================================================         -->
  26 <document>
  27   <properties>
  28     <title>KarafPropertyInstructionsModel</title>
  29   </properties>
  30   <body>
  31     <section name="KarafPropertyInstructionsModel">
  32       <p>
  33         Specifications for how to modify Karaf property files to customize an installation.
  34     </p>
  35       <source>
  36 &lt;<a href="#class_property-edits">property-edits</a> xmlns="http://karaf.apache.org/tools/property-edits/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  37   xsi:schemaLocation="http://karaf.apache.org/tools/property-edits/1.0.0 <a href="http://karaf.apache.org/xsd/property-edits-1.0.0.xsd">http://karaf.apache.org/xsd/property-edits-1.0.0.xsd</a>"&gt;
  38   &lt;edits&gt;
  39     &lt;<a href="#class_edit">edit</a>&gt;
  40       &lt;<a href="#class_operation">operation</a> prepend=.. /&gt;
  41       &lt;file/&gt;
  42       &lt;key/&gt;
  43       &lt;value/&gt;
  44     &lt;/edit&gt;
  45   &lt;/edits&gt;
  46 &lt;/property-edits&gt;
  47 </source>
  48       <a name="class_property-edits"/>
  49       <subsection name="property-edits">
  50         <p>
  51                 A collection instructions. Each instruction is either a 'put' or an 'edit',
  52                 and calls out a file, a property name, and a property value.
  53             </p>
  54         <table>
  55           <tr>
  56             <th>Element</th>
  57             <th>Type</th>
  58             <th>Description</th>
  59           </tr>
  60           <tr>
  61             <td>
  62               <code>edits/<a href="#class_edit">edit</a>*</code>
  63             </td>
  64             <td>
  65               <code>List&lt;KarafPropertyEdit&gt;</code>
  66             </td>
  67             <td><b>(Many)</b> The list of edits to perform.</td>
  68           </tr>
  69         </table>
  70       </subsection>
  71       <a name="class_edit"/>
  72       <subsection name="edit">
  73         <p>
  74                 A single property edit.
  75             </p>
  76         <table>
  77           <tr>
  78             <th>Element</th>
  79             <th>Type</th>
  80             <th>Description</th>
  81           </tr>
  82           <tr>
  83             <td>
  84               <code>
  85                 <a href="#class_operation">operation</a>
  86               </code>
  87             </td>
  88             <td>
  89               <code>Operation</code>
  90             </td>
  91             <td>
  92                         The operation to perform: 'put' or 'extend'.
  93                     </td>
  94           </tr>
  95           <tr>
  96             <td>
  97               <code>file</code>
  98             </td>
  99             <td>
 100               <code>String</code>
 101             </td>
 102             <td>
 103                         The pathname, relative to the the Karaf etc directory, of the file to manipulate.
 104                     </td>
 105           </tr>
 106           <tr>
 107             <td>
 108               <code>key</code>
 109             </td>
 110             <td>
 111               <code>String</code>
 112             </td>
 113             <td>
 114                         The property key.
 115                     </td>
 116           </tr>
 117           <tr>
 118             <td>
 119               <code>value</code>
 120             </td>
 121             <td>
 122               <code>String</code>
 123             </td>
 124             <td>
 125                         The property value.
 126                     </td>
 127           </tr>
 128         </table>
 129       </subsection>
 130       <a name="class_operation"/>
 131       <subsection name="operation">
 132         <p>No description.</p>
 133         <p>
 134           <b>Element Content: </b>
 135                         'extend' to extend the existing value, 'put' to replace.
 136                     </p>
 137         <table>
 138           <tr>
 139             <th>Attribute</th>
 140             <th>Type</th>
 141             <th>Description</th>
 142           </tr>
 143           <tr>
 144             <td>
 145               <code>prepend</code>
 146             </td>
 147             <td>
 148               <code>boolean</code>
 149             </td>
 150             <td>for the 'extend' operation, indicates that the value should be placed at the head of the list.<br/><strong>Default value is</strong>: <code>false</code>.</td>
 151           </tr>
 152         </table>
 153       </subsection>
 154     </section>
 155   </body>
 156 </document>