karaf/karaf-maven-plugin/src/site/apt/index.apt

   1 ~~ Licensed to the Apache Software Foundation (ASF) under one
   2 ~~ or more contributor license agreements.  See the NOTICE file
   3 ~~ distributed with this work for additional information
   4 ~~ regarding copyright ownership.  The ASF licenses this file
   5 ~~ to you under the Apache License, Version 2.0 (the
   6 ~~ "License"); you may not use this file except in compliance
   7 ~~ with the License.  You may obtain a copy of the License at
   8 ~~
   9 ~~ http://www.apache.org/licenses/LICENSE-2.0
  10 ~~
  11 ~~ Unless required by applicable law or agreed to in writing,
  12 ~~ software distributed under the License is distributed on an
  13 ~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  14 ~~ KIND, either express or implied.  See the License for the
  15 ~~ specific language governing permissions and limitations
  16 ~~ under the License.
  17
  18
  19   ------
  20   Introduction
  21   ------
  22
  23 Introduction
  24
  25   The karaf-maven-plugin includes three packagings to produce karaf specific artifacts, and a number of other mojos for various purposes.
  26
  27 Packagings
  28
  29 * feature
  30
  31   The feature packaging generates a new or augments a supplied feature.xml file to produce a features descriptor.  The transitive maven dependencies of the project are used as the
  32   bundles and feature and kar dependencies of a feature in the output feature.xml file.
  33
  34 * kar
  35
  36   The kar packaging augments the feature packaging to generate a kar archive including the generated features.xml file, suitable resources from the project such as configuration files,
  37   and optionally the bundle listed in the feature.xml file.
  38
  39 * karaf-assembly
  40
  41   The karaf-assembly packaging assembles and packages a karaf server from the maven dependencies of the project. Kar dependencies are unpacked into the server.  Feature dependencies
  42    (including those found in unpacked kar files) have their bundles installed into the karaf system directory and may have their bundles added at the specified startlevel to startup.properties.
  43
  44
  45 Mojos
  46
  47 * cmdhelp
  48