org.argeo.slc/src/main/java/org/argeo/slc/ant/package.html

   1 <html>
   2 <head></head>
   3 <body>
   4 Bases classes for SLC Ant extensions.
   5 <h2>Introduction</h2>
   6 SLC Ant allows to integrate Ant and Spring in order to run an
   7 application based on top of SLC. Sequence of actions are defined in Ant
   8 files with specific Ant tasks referencing Spring beans implementing the
   9 SLC interfaces. The properties of these beans can be overridden at
  10 runtime in the Ant scripts.
  11 <br />
  12 SLC Ant also provides a tree-based implementation of the SLC structure
  13 which allows to uniquely identify and reference the various actions.
  14
  15 <h2>Installation</h2>
  16 The structure will be first defined by the directory tree where the Ant
  17 files are stored. In order to define the root of this tree, you need to
  18 place in the root directory an
  19 <b>SLC Ant root file</b>
  20 (default name: slcRoot.properties).
  21 <br />
  22 In this root file you can define a configuration directory and a work
  23 directory (default values are provided if they are not explicitly set).
  24 <br />
  25 Additional properties can then be defined in files stored under the
  26 configuration directory.
  27 <br />
  28 For details about the configuration and the various properties, please
  29 refer to {@link org.argeo.slc.ant.SlcAntConfig}.
  30
  31 <h2>Running SLC Ant</h2>
  32 SLC Ant can be run either via pure Ant scripts or programmatically using
  33 {@link org.argeo.slc.ant.AntRegistryUtil}. In both cases, make sure that
  34 SLC and its dependencies are in the classpath (Spring (always), logging
  35 system such as log4j, Hibernate, etc.).
  36
  37 </body>
  38 </html>