ARCHER Metadata Editor Service Provider Interface (SPI)
            ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

General
~~~~~~~
    This sub-project provides the interfaces expressed by objects that facilitate
    editing of metadata by Archer applications.  It also provides a Record Broker service
    based on one of the SPI interfaces, plus a factory class for that implementation
    allowing the object to be shared by Archer applications and the Metadata Editing
    Facility through the web server JNDI service.

    The code generated is packeaged into the following JAR files:
        archer-client-metaservice.jar            Interfaces and Exception classes
        archer-server-metaservice.jar            As Above, plus RecordBroker and Factory classes
        au.edu.archer.metadata.spi-doc.jar       Javadoc

    The first is used by developers during application development. It
    contains the interfaces defined in the au.edu.archer.metaedit.spi
    package.

    The second contains all compiled classes and must be deployed to the
    applications via the Tomcat server $CATALINA_HOME/common/lib directory.
    An entry naming the Factory is also required in the servers config
    file $CATALINA_HOME/conf/context.xml as described in the Javadocs.

Dependencies
~~~~~~~~~~~~
    (see MDE_README.txt Dependencies)


Deployment
~~~~~~~~~~
    Copy the file "archer-server-metaservice.jar" to the Apache Tomcat shared
    library directory $CATALINA_HOME/common/lib.  Edit the server context
    descriptor $CATALINA_HOME/conf/context.xml to include the following
    within the <context> tag:

    <Resource name="bean/RecordBrokerFactory"
              auth="Container"
              type="au.edu.archer.metadata.spi.MetadataServiceProvider"
              factory="au.edu.archer.metadata.spi.recordbroker.RecordBrokerFactory" />

    The name is not important as long as it is shared by JNDI users.
    In the demonstration classes, the above name is configured in the
    deployment descriptor (web.xml).  Changing it will require unpacking
    and repacking the WAR file.

    Note that the server must be restarted after these changes, and whenever
    the jar is updated.

Testing
~~~~~~~
    Examine the Catalina logs after startup to ensure no exceptions have been
    reported.

Developers
~~~~~~~~~~
    Copy (or import) the file "archer-client-metaservice.jar" to the classpath
    of the application(s) under development.  Under Eclipse, you may also wish
    to link the Source to au.edu.archer.metadata.spi-src.jar .

    NOTE: development environments should -never- see the actual implementation
    class for the Factory, nor the class it creates contained in the other jar.

    The Ant build.xml may be used to build and deploy to $CATALINA_HOME:

        ant release
        ant deploy.tomcat

    Other targets are available.  Read the build.xml file for details.



                                    oOo