<?xml version="1.0"?>
<document>
<!--
 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.
-->
  <properties>
    <title>Shale API Target Audiences and Stability Ratings</title>
  </properties>

  <body>

    <a name="stability"/>
    <section name="Shale API Target Audiences and Stability Ratings">

      <a name="stability-introduction"/>
      <subsection name="Introduction">

        <p>The core services provided by Shale are packaged in a series of
        JAR files, so that applications not utiizing some of the optional
        services need not include them.  For each service, the APIs in
        particular Java packages are intended for public use by application
        developers, while other packages represent the internal implementation
        of Shale features, and would only be accessed directly if you intend to
        modify Shale's standard functionality.  In the tables below, the
        intended target audience of each package is described by one of the
        following terms:</p>

        <ul>
        <li><em>Application</em> - Applications based on Shale may
            depend on APIs provided by this package.  In general,
            such APIs will focus on avoiding backwards incompatble
            changes as they evolve.</li>
        <li><em>Framework</em> - Developers who wish to extend or
            modify the default implementation of Shale features
            may depend on APIs provided by this package.  Stability
            of APIs across releases will still be a goal, but
            ongoing evolution will likely lead to some incompatible
            changes.</li>
        <li><em>Private</em> - This package is not intended for public
            use by developers, and its APIs are subject to change
            in later releases at any time.</li>
        </ul>

        <p>In addition to the intent described above, each package is also
        annotated with a stability rating, which is an indication of the
        expected rate of future change, described by one of the following
        terms:</p>

        <ul>
        <li><em>Private</em> - This package is not intended for public
            use by developers, and its APIs are subject to change
            in later releases at any time.</li>
        <li><em>Developing</em> - This package is under active development,
            and changes (including backwards incompatible changes) are likely
            in future versions.</li>
        <li><em>Evolving</em> - This package is continuing to be developed,
            but changes will generally add new features only, while maintaing
            backwards compatibility.</li>
        <li><em>Stable</em> - This package may continue to be developed,
            but offers the highest possible assurance of backwards compatibility
            in both public API and in functionality.</li>
        <li><em>Deprecated</em> - This package contains API that was available
            in previous versions, and is maintained (for a short while) for
            backwards compatibility purposes.  However, dependencies on these
            APIs should be migrated appropriately, as at some point in time
            the package will be subject to removal.</li>
        </ul>

      </subsection>

      <a name="stability-application"/>
      <subsection name="Packages Intended For Application Developer Use">

          <table>
              <thead>
                  <tr>
                      <th width="15%">Library JAR</th>
                      <th width="25%">Package Name</th>
                      <th width="10%">Stability</th>
                      <th width="40%">Additional Comments</th>
                  </tr>
              </thead>
              <tbody>
                  <tr>
                      <td><a href="shale-application/index.html">shale-application</a></td>
                      <td><a href="shale-application/apidocs/org/apache/shale/application/package-summary.html">org.apache.shale.application</a></td>
                      <td>Evolving</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-clay/index.html">shale-clay</a></td>
                      <td><a href="shale-clay/apidocs/org/apache/shale/clay/component/package-summary.html">org.apache.shale.clay.component</a></td>
                      <td>Evolving</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-clay/index.html">shale-clay</a></td>
                      <td><a href="shale-clay/apidocs/org/apache/shale/clay/convert/package-summary.html">org.apache.shale.clay.convert</a></td>
                      <td>Evolving</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-core/index.html">shale-core</a></td>
                      <td><a href="shale-core/apidocs/org/apache/shale/component/package-summary.html">org.apache.shale.component</a></td>
                      <td>Evolving</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-core/index.html">shale-core</a></td>
                      <td><a href="shale-core/apidocs/org/apache/shale/util/package-summary.html">org.apache.shale.util</a></td>
                      <td>Evolving</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-dialog/index.html">shale-dialog</a></td>
                      <td><a href="shale-dialog/apidocs/org/apache/shale/dialog/package-summary.html">org.apache.shale.dialog</a></td>
                      <td>Evolving</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-dialog/index.html">shale-dialog</a></td>
                      <td><a href="shale-dialog/apidocs/org/apache/shale/dialog/base/package-summary.html">org.apache.shale.dialog.base</a></td>
                      <td>Evolving</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-test/index.html">shale-test</a></td>
                      <td><a href="shale-test/apidocs/org/apache/shale/test/base/package-summary.html">org.apache.shale.test.base</a></td>
                      <td>Developing</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-test/index.html">shale-test</a></td>
                      <td><a href="shale-test/apidocs/org/apache/shale/test/htmlunit/package-summary.html">org.apache.shale.test.htmlunit</a></td>
                      <td>Developing</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-test/index.html">shale-test</a></td>
                      <td><a href="shale-test/apidocs/org/apache/shale/test/jmock/package-summary.html">org.apache.shale.test.jmock</a></td>
                      <td>Developing</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-test/index.html">shale-test</a></td>
                      <td><a href="shale-test/apidocs/org/apache/shale/test/mock/package-summary.html">org.apache.shale.test.mock</a></td>
                      <td>Developing</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-tiger/index.html">shale-tiger</a></td>
                      <td><a href="shale-tiger/apidocs/org/apache/shale/tiger/managed/package-summary.html">org.apache.shale.tiger.managed</a></td>
                      <td>Evolving</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-tiger/index.html">shale-tiger</a></td>
                      <td><a href="shale-tiger/apidocs/org/apache/shale/tiger/register/package-summary.html">org.apache.shale.tiger.register</a></td>
                      <td>Evolving</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-tiger/index.html">shale-tiger</a></td>
                      <td><a href="shale-tiger/apidocs/org/apache/shale/tiger/view/package-summary.html">org.apache.shale.tiger.view</a></td>
                      <td>Evolving</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-validator/index.html">shale-validator</a></td>
                      <td><a href="shale-validator/apidocs/org/apache/shale/validator/package-summary.html">org.apache.shale.validator</a></td>
                      <td>Evolving</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-validator/index.html">shale-validator</a></td>
                      <td><a href="shale-validator/apidocs/org/apache/shale/validator/converter/package-summary.html">org.apache.shale.validator.converter</a></td>
                      <td>Developing</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-validator/index.html">shale-validator</a></td>
                      <td><a href="shale-validator/apidocs/org/apache/shale/validator/util/package-summary.html">org.apache.shale.validator.util</a></td>
                      <td>Developing</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-validator/index.html">shale-validator</a></td>
                      <td><a href="shale-validator/apidocs/org/apache/shale/validator/validator/package-summary.html">org.apache.shale.validator.validator</a></td>
                      <td>Developing</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-view/index.html">shale-view</a></td>
                      <td><a href="shale-view/apidocs/org/apache/shale/view/package-summary.html">org.apache.shale.view</a></td>
                      <td>Evolving</td>
                      <td>---</td>
                  </tr>
              </tbody>    
          </table>

      </subsection>

      <a name="stability-framework"/>
      <subsection name="Packages Intended For Framework Extender Use">

          <table>
              <thead>
                  <tr>
                      <th width="15%">Library JAR</th>
                      <th width="25%">Package Name</th>
                      <th width="10%">Stability</th>
                      <th width="40%">Additional Comments</th>
                  </tr>
              </thead>
              <tbody>
                  <tr>
                      <td><a href="shale-application/index.html">shale-application</a></td>
                      <td><a href="shale-application/apidocs/org/apache/shale/application/faces/package-summary.html">org.apache.shale.application.faces</a></td>
                      <td>Developing</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-clay/index.html">shale-clay</a></td>
                      <td><a href="shale-clay/apidocs/org/apache/shale/clay/component/chain/package-summary.html">org.apache.shale.clay.component.chain</a></td>
                      <td>Developing</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-clay/index.html">shale-clay</a></td>
                      <td><a href="shale-clay/apidocs/org/apache/shale/clay/config/package-summary.html">org.apache.shale.clay.config</a></td>
                      <td>Developing</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-clay/index.html">shale-clay</a></td>
                      <td><a href="shale-clay/apidocs/org/apache/shale/clay/config/beans/package-summary.html">org.apache.shale.clay.config.beans</a></td>
                      <td>Developing</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-clay/index.html">shale-clay</a></td>
                      <td><a href="shale-clay/apidocs/org/apache/shale/clay/faces/package-summary.html">org.apache.shale.clay.faces</a></td>
                      <td>Developing</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-clay/index.html">shale-clay</a></td>
                      <td><a href="shale-clay/apidocs/org/apache/shale/clay/parser/package-summary.html">org.apache.shale.clay.parser</a></td>
                      <td>Developing</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-clay/index.html">shale-clay</a></td>
                      <td><a href="shale-clay/apidocs/org/apache/shale/clay/parser/builder/package-summary.html">org.apache.shale.clay.parser.builder</a></td>
                      <td>Developing</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-clay/index.html">shale-clay</a></td>
                      <td><a href="shale-clay/apidocs/org/apache/shale/clay/parser/builder/chain/package-summary.html">org.apache.shale.clay.parser.builder.chain</a></td>
                      <td>Developing</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-clay/index.html">shale-clay</a></td>
                      <td><a href="shale-clay/apidocs/org/apache/shale/clay/taglib/package-summary.html">org.apache.shale.clay.taglib</a></td>
                      <td>Developing</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-clay/index.html">shale-clay</a></td>
                      <td><a href="shale-clay/apidocs/org/apache/shale/clay/utils/package-summary.html">org.apache.shale.clay.utils</a></td>
                      <td>Developing</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-core/index.html">shale-core</a></td>
                      <td><a href="shale-core/apidocs/org/apache/shale/faces/package-summary.html">org.apache.shale.faces</a></td>
                      <td>Developing</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-core/index.html">shale-core</a></td>
                      <td><a href="shale-core/apidocs/org/apache/shale/renderer/package-summary.html">org.apache.shale.renderer</a></td>
                      <td>Developing</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-core/index.html">shale-core</a></td>
                      <td><a href="shale-core/apidocs/org/apache/shale/taglib/package-summary.html">org.apache.shale.taglib</a></td>
                      <td>Developing</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-dialog/index.html">shale-dialog</a></td>
                      <td><a href="shale-dialog/apidocs/org/apache/shale/dialog/faces/package-summary.html">org.apache.shale.dialog.faces</a></td>
                      <td>Evolving</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-dialog-basic/index.html">shale-dialog-basic</a></td>
                      <td><a href="shale-dialog-basic/apidocs/org/apache/shale/dialog/basic/package-summary.html">org.apache.shale.dialog.basic</a></td>
                      <td>Evolving</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-dialog-basic/index.html">shale-dialog-basic</a></td>
                      <td><a href="shale-dialog-basic/apidocs/org/apache/shale/dialog/basic/config/package-summary.html">org.apache.shale.dialog.basic.config</a></td>
                      <td>Evolving</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-dialog-basic/index.html">shale-dialog-basic</a></td>
                      <td><a href="shale-dialog-basic/apidocs/org/apache/shale/dialog/basic/model/package-summary.html">org.apache.shale.dialog.basic.model</a></td>
                      <td>Evolving</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-dialog-scxml/index.html">shale-dialog-scxml</a></td>
                      <td><a href="shale-dialog-scxml/apidocs/org/apache/shale/dialog/scxml/package-summary.html">org.apache.shale.dialog.scxml</a></td>
                      <td>Evolving</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-dialog-scxml/index.html">shale-dialog-scxml</a></td>
                      <td><a href="shale-dialog-scxml/apidocs/org/apache/shale/dialog/scxml/action/package-summary.html">org.apache.shale.dialog.scxml.action</a></td>
                      <td>Evolving</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-dialog-scxml/index.html">shale-dialog-scxml</a></td>
                      <td><a href="shale-dialog-scxml/apidocs/org/apache/shale/dialog/scxml/config/package-summary.html">org.apache.shale.dialog.scxml.config</a></td>
                      <td>Evolving</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-dialog-scxml/index.html">shale-dialog-scxml</a></td>
                      <td><a href="shale-dialog-scxml/apidocs/org/apache/shale/dialog/scxml/impl/package-summary.html">org.apache.shale.dialog.scxml.impl</a></td>
                      <td>Evolving</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-spring/index.html">shale-spring</a></td>
                      <td><a href="shale-spring/apidocs/org/apache/shale/spring/package-summary.html">org.apache.shale.spring</a></td>
                      <td>Evolving</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-test/index.html">shale-test</a></td>
                      <td><a href="shale-test/apidocs/org/apache/shale/test/cargo/package-summary.html">org.apache.shale.test.cargo</a></td>
                      <td>Developing</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-test/index.html">shale-test</a></td>
                      <td><a href="shale-test/apidocs/org/apache/shale/test/el/package-summary.html">org.apache.shale.test.el</a></td>
                      <td>Developing</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-tiger/index.html">shale-tiger</a></td>
                      <td><a href="shale-tiger/apidocs/org/apache/shale/tiger/config/package-summary.html">org.apache.shale.tiger.config</a></td>
                      <td>Developing</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-tiger/index.html">shale-tiger</a></td>
                      <td><a href="shale-tiger/apidocs/org/apache/shale/tiger/faces/package-summary.html">org.apache.shale.tiger.faces</a></td>
                      <td>Developing</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-tiger/index.html">shale-tiger</a></td>
                      <td><a href="shale-tiger/apidocs/org/apache/shale/tiger/managed/config/package-summary.html">org.apache.shale.tiger.managed.config</a></td>
                      <td>Developing</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-tiger/index.html">shale-tiger</a></td>
                      <td><a href="shale-tiger/apidocs/org/apache/shale/tiger/managed/rules/package-summary.html">org.apache.shale.tiger.managed.rules</a></td>
                      <td>Developing</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-tiger/index.html">shale-tiger</a></td>
                      <td><a href="shale-tiger/apidocs/org/apache/shale/tiger/register/faces/package-summary.html">org.apache.shale.tiger.register.faces</a></td>
                      <td>Developing</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-tiger/index.html">shale-tiger</a></td>
                      <td><a href="shale-tiger/apidocs/org/apache/shale/tiger/view/faces/package-summary.html">org.apache.shale.tiger.view.faces</a></td>
                      <td>Evolving</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-validator/index.html">shale-validator</a></td>
                      <td><a href="shale-validator/apidocs/org/apache/shale/validator/faces/package-summary.html">org.apache.shale.validator.faces</a></td>
                      <td>Developing</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-validator/index.html">shale-validator</a></td>
                      <td><a href="shale-validator/apidocs/org/apache/shale/validator/tag/package-summary.html">org.apache.shale.validator.tag</a></td>
                      <td>Developing</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-view/index.html">shale-view</a></td>
                      <td><a href="shale-view/apidocs/org/apache/shale/view/faces/package-summary.html">org.apache.shale.view.faces</a></td>
                      <td>Evolving</td>
                      <td>---</td>
                  </tr>
                  <tr>
                      <td><a href="shale-view/index.html">shale-view</a></td>
                      <td><a href="shale-view/apidocs/org/apache/shale/view/impl/package-summary.html">org.apache.shale.view.impl</a></td>
                      <td>Evolving</td>
                      <td>---</td>
                  </tr>
              </tbody>    
          </table>

      </subsection>

    </section>

  </body>

</document>
