Metacat

/**

 *  '$RCSfile$'

 *  Copyright: 2000 Regents of the University of California and the

 *             National Center for Ecological Analysis and Synthesis

 *

 *   '$Author$'

 *     '$Date$'

 * '$Revision$'

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation; either version 2 of the License, or

 * (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 */

package edu.ucsb.nceas.metacat.client;

/**

 * Exception thrown when a Metacat server denies a login authentication

 * request.  Either the username or password are incorrect.

 */

public class MetacatAuthException extends Exception {

    /**

     * Create a new MetacatAuthException.

     *

     * @param message The error or warning message.

     */

    public MetacatAuthException(String message) {

        super(message);

    }

}

/**

 *  '$RCSfile$'

 *  Copyright: 2000 Regents of the University of California and the

 *             National Center for Ecological Analysis and Synthesis

 *

 *   '$Author$'

 *     '$Date$'

 * '$Revision$'

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation; either version 2 of the License, or

 * (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 */

package edu.ucsb.nceas.metacat.client;

/**

 * Exception thrown when an error occurs because a Metacat server operation

 * requires higher access rights than the currently logged in user has.

 */

public class InsufficientKarmaException extends Exception {

    /**

     * Create a new InsufficientKarmaException.

     *

     * @param message The error or warning message.

     */

    public InsufficientKarmaException(String message) {

        super(message);

    }

}

/**

 *  '$RCSfile$'

 *  Copyright: 2000 Regents of the University of California and the

 *             National Center for Ecological Analysis and Synthesis

 *

 *   '$Author$'

 *     '$Date$'

 * '$Revision$'

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation; either version 2 of the License, or

 * (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 */

package edu.ucsb.nceas.metacat.client;

/**

 * Exception thrown when a Metacat server is not accessible for the

 * operation requested.  This can be a network outage, or a configuration error.

 */

public class MetacatInaccessibleException extends Exception {

    /**

     * Create a new MetacatInaccessibleException.

     *

     * @param message The error or warning message.

     */

    public MetacatInaccessibleException(String message) {

        super(message);

    }

}

/**

 *  '$RCSfile$'

 *  Copyright: 2000 Regents of the University of California and the

 *              National Center for Ecological Analysis and Synthesis

 *

 *   '$Author$'

 *     '$Date$'

 * '$Revision$'

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation; either version 2 of the License, or

 * (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 */

package edu.ucsb.nceas.metacat.client;

import java.io.Reader;

/**

 *  This class is a factory which allows the caller to create an instance of

 *  a Metacat object for accessing a metacat server.

 */

public class MetacatFactory

{

    private static final String metacatClientClass = 

         "edu.ucsb.nceas.metacat.client.MetacatClient";

    /**

     *  Create a new instance of a Metacat object of raccessing a server.

     *

     *  @param metacatUrl the url location of the metacat server

     *  @throws MetacatInaccessibleException when the metacat server can not

     *                    be reached

     */

    public static Metacat createMetacatConnection(String metacatUrl) 

           throws MetacatInaccessibleException

    {

        Metacat m = null;

        try {

            Class c = Class.forName(metacatClientClass);

            m = (Metacat)c.newInstance();

        } catch (InstantiationException e) {

            throw new MetacatInaccessibleException(e.getMessage());

        } catch (IllegalAccessException e) {

            throw new MetacatInaccessibleException(e.getMessage());

        } catch (ClassNotFoundException e) {

            throw new MetacatInaccessibleException(e.getMessage());

        }

        m.setMetacatUrl(metacatUrl);

        return m;

    }

}

/**

 *  '$RCSfile$'

 *  Copyright: 2000 Regents of the University of California and the

 *              National Center for Ecological Analysis and Synthesis

 *

 *   '$Author$'

 *     '$Date$'

 * '$Revision$'

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation; either version 2 of the License, or

 * (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 */

package edu.ucsb.nceas.metacat.client;

import java.io.InputStream;

import java.io.Reader;

import java.net.URL;

import java.util.Properties;

import edu.ucsb.nceas.utilities.HttpMessage;

/**

 *  This interface provides methods for initializing and logging in to a 

 *  Metacat server, and then querying, reading, transforming, inserting, 

 *  updating and deleting documents from that server.

 */

public class MetacatClient implements Metacat

{

    /** The URL string for the metacat server */

    private String metacatUrl;

    /**

     * Constructor to create a new instance. Protected because instances

     * should only be created by the factory MetacatFactory.

     */

    protected MetacatClient()

    {

    }

    /**

     *  Method used to log in to a metacat server. Implementations will need

     *  to cache a cookie value to make the session persistent.  Each time a

     *  call is made to one of the other methods (e.g., read), the cookie will

     *  need to be passed back to the metacat server along with the request.

     *

     *  @param username   the username of the user, like an LDAP DN

     *  @param password   the password for that user for authentication

     *  @throws MetacatAuthException when the username/password could

     *                    not be authenticated

     */

    public void login(String username, String password) 

           throws MetacatAuthException, MetacatInaccessibleException

    {

    }

    /**

     * Read an XML document from the metacat server session, accessed by docid,

     * and returned as a Reader.

     *

     * @param docid the identifier of the document to be read

     * @return a Reader for accessing the document

     * @throws InsufficientKarmaException when the user has insufficent rights 

     *                                    for the operation

     */

    public Reader read(String docid) throws InsufficientKarmaException

    {

        Reader r = null;

        return r;

    }

    /**

     * Query the metacat document store with the given metacat-compatible 

     * query document, and return the result set as a Reader.

     *

     * @param xmlQuery a Reader for accessing the XML version of the query

     * @return a Reader for accessing the result set

     */

    public Reader query(Reader xmlQuery)

    {

        Reader r = null;

        return r;

    }

    /**

     * Insert an XML document into the repository.

     *

     * @param docid the docid to insert the document

     * @param xmlDocument a Reader for accessing the XML document to be inserted

     * @param schema a Reader for accessing the DTD or XML Schema for 

     *               the document

     * @throws InsufficientKarmaException when the user has insufficent rights 

     *                                    for the operation

     */

    public void insert(String docid, Reader xmlDocument, Reader schema)

        throws InsufficientKarmaException

    {

    }

    /**

     * Update an XML document in the repository.

     *

     * @param docid the docid to update

     * @param xmlDocument a Reader for accessing the XML text to be updated

     * @param schema a Reader for accessing the DTD or XML Schema for 

     *               the document

     * @throws InsufficientKarmaException when the user has insufficent rights 

     *                                    for the operation

     */

    public void update(String docid, Reader xmlDocument, Reader schema)

        throws InsufficientKarmaException

    {

    }

    /**

     * Delete an XML document in the repository.

     *

     * @param docid the docid to delete

     * @throws InsufficientKarmaException when the user has insufficent rights 

     *                                    for the operation

     */

    public void delete(String docid)

        throws InsufficientKarmaException

    {

    }

    /**

     * When the MetacatFactory creates an instance it needs to set the

     * MetacatUrl to which connections should be made.

     *

     * @param metacatUrl the URL for the metacat server

     */

    public void setMetacatUrl(String metacatUrl)

    {

    }

    /************************************************************************

     * PRIVATE METHODS

     ************************************************************************/

    synchronized private InputStream sendDataOnce(Properties prop) 

        throws Exception

    {

        InputStream returnStream = null;

        URL url = new URL(metacatUrl);

        HttpMessage msg = new HttpMessage(url);

        returnStream = msg.sendPostData(prop);

        return returnStream;

    }

    /**

     * Send a request to Metacat

     *

     * @param prop  the properties to be sent to Metacat

     * @return      InputStream as returned by Metacat

     */

    synchronized private InputStream sendData(Properties prop) throws Exception

    {   

        InputStream returnStream = null;

        /*

            Note:  The reason that there are three try statements all executing

            the same code is that there is a problem with the initial connection

            using the HTTPClient protocol handler.  These try statements make 

            sure that a connection is made because it gives each connection a 

            2nd and 3rd chance to work before throwing an error.

            THIS IS A TOTAL HACK.  THIS NEEDS TO BE LOOKED INTO AFTER THE BETA1

            RELEASE OF MORPHO!!!  cwb (7/24/01)

          */

        try {

           return sendDataOnce(prop);

        } catch (Exception e) {

            try {

                return sendDataOnce(prop);

            } catch (Exception e2) {

                try {

                    return sendDataOnce(prop);

                } catch (Exception e3) {

                    System.err.println(

                            "Failed to send data to metacat 3 times.");

                    throw e3;

                }

            }

        }

    }

}

/**

 *  '$RCSfile$'

 *  Copyright: 2000 Regents of the University of California and the

 *              National Center for Ecological Analysis and Synthesis

 *

 *   '$Author$'

 *     '$Date$'

 * '$Revision$'

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation; either version 2 of the License, or

 * (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 */

package edu.ucsb.nceas.metacat.client;

import java.io.Reader;

/**

 *  This interface provides methods for initializing and logging in to a 

 *  Metacat server, and then querying, reading, transforming, inserting, 

 *  updating and deleting documents from that server.

 */

public interface Metacat

{

    /**

     *  Method used to log in to a metacat server. Implementations will need

     *  to cache a cookie value to make the session persistent.  Each time a

     *  call is made to one of the other methods (e.g., read), the cookie will

     *  need to be passed back to the metacat server along with the request.

     *

     *  @param username   the username of the user, like an LDAP DN

     *  @param password   the password for that user for authentication

     *  @throws MetacatAuthException when the username/password could

     *                    not be authenticated

     */

    public void login(String username, String password) 

           throws MetacatAuthException, MetacatInaccessibleException;

    /**

     * Read an XML document from the metacat server session, accessed by docid,

     * and returned as a Reader.

     *

     * @param docid the identifier of the document to be read

     * @return a Reader for accessing the document

     * @throws InsufficientKarmaException when the user has insufficent rights 

     *                                    for the operation

     */

    public Reader read(String docid) throws InsufficientKarmaException;

    /**

     * Query the metacat document store with the given metacat-compatible 

     * query document, and return the result set as a Reader.

     *

     * @param xmlQuery a Reader for accessing the XML version of the query

     * @return a Reader for accessing the result set

     */

    public Reader query(Reader xmlQuery);

    /**

     * Insert an XML document into the repository.

     *

     * @param docid the docid to insert the document

     * @param xmlDocument a Reader for accessing the XML document to be inserted

     * @param schema a Reader for accessing the DTD or XML Schema for 

     *               the document

     * @throws InsufficientKarmaException when the user has insufficent rights 

     *                                    for the operation

     */

    public void insert(String docid, Reader xmlDocument, Reader schema)

        throws InsufficientKarmaException;

    /**

     * Update an XML document in the repository.

     *

     * @param docid the docid to update

     * @param xmlDocument a Reader for accessing the XML text to be updated

     * @param schema a Reader for accessing the DTD or XML Schema for 

     *               the document

     * @throws InsufficientKarmaException when the user has insufficent rights 

     *                                    for the operation

     */

    public void update(String docid, Reader xmlDocument, Reader schema)

        throws InsufficientKarmaException;

    /**

     * Delete an XML document in the repository.

     *

     * @param docid the docid to delete

     * @throws InsufficientKarmaException when the user has insufficent rights 

     *                                    for the operation

     */

    public void delete(String docid)

        throws InsufficientKarmaException;

    /**

     * When the MetacatFactory creates an instance it needs to set the

     * MetacatUrl to which connections should be made.

     *

     * @param metacatUrl the URL for the metacat server

     */

    public void setMetacatUrl(String metacatUrl);

}

      <property name="utilitiesdir" value="../utilities" />

                value="lib/httpclient.jar" />

      <property name="util"

                value="lib/utilities.jar" />

                value="${xmlp}:${xalan}:${apis}:${jdbc}:${jsdk}:${srb}:${cos}:${morpho}:${emlparser}:${jdbc-add1}:${jdbc-add2}:${util}:${httpclient}"/>

   <target name="utilities" depends="config">

     <ant dir="${utilitiesdir}" target="clean"/>

     <ant dir="${utilitiesdir}" target="jar"/>

     <copy file="${utilitiesdir}/lib/httpclient.jar" todir="lib" />

     <copy file="${utilitiesdir}/build/utilities.jar" todir="lib" />

   </target>

   <target name="client" depends="utilities, prepare">

       <javac srcdir="${build.src}"

              destdir="${build.dest}"

              classpath="${cpath}"

              includes="edu/ucsb/nceas/metacat/client/*" />

   </target>

   <target name="clientjar" depends="client">

       <delete file="${build.dir}/${name}-client.jar" />

       <jar jarfile="${build.dir}/${name}-client.jar" basedir="${build.dest}"

            includes="**/metacat/client/" />

   </target>