Metacat

/**

 *        Name: MetaCatServlet.java

 *     Purpose: A Class that implements a metadata catalog as a java Servlet

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

 *              National Center for Ecological Analysis and Synthesis

 *     Authors: Matt Jones

 * 

 *     Version: '$Id: MetaCatServlet.java 82 2000-05-05 21:50:00Z jones $'

 */

package edu.ucsb.nceas.metacat;

import java.io.PrintWriter;

import java.io.IOException;

import java.io.Reader;

import java.io.StringReader;

import java.io.BufferedReader;

import java.util.Enumeration;

import java.util.Hashtable;

import java.util.ResourceBundle;

import java.util.PropertyResourceBundle;

import java.net.URL;

import java.net.MalformedURLException;

import java.sql.Connection;

import java.sql.SQLException;

import javax.servlet.ServletConfig;

import javax.servlet.ServletContext;

import javax.servlet.ServletException;

import javax.servlet.ServletInputStream;

import javax.servlet.http.HttpServlet;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import javax.servlet.http.HttpUtils;

import oracle.xml.parser.v2.XSLStylesheet;

import oracle.xml.parser.v2.XSLException;

import oracle.xml.parser.v2.XMLDocumentFragment;

import oracle.xml.parser.v2.XSLProcessor;

import oracle.xml.parser.v2.*;    //Oracle parser - DFH

/**

 * A metadata catalog server implemented as a Java Servlet

   *

   * <p>Valid parameters are:<br>

   * action=query -- query the values of all elements and attributes

   *                     and return a result set of nodes<br>

   * action=getdocument -- display an XML document in XML or HTML<br>

   * qformat=xml -- display resultset from query in XML<br>

   * qformat=html -- display resultset from query in HTML<br>

   * action=getdocument -- display an XML document in XML or HTML<br>

   * docid=34 -- display the document with the document ID number 34<br>

   * action=putdocument -- load an XML document into the database store<br>

   * doctext -- XML text ofthe document to load into the database<br>

   * query -- actual query text (to go with 'action=query')<br>

   * action=validate -- vallidate the xml contained in validatetext<br>

   * valtext -- XML text to be validated

 */

public class MetaCatServlet extends HttpServlet {

  private ServletConfig		config = null;

  private ServletContext	context = null;

  Connection 		conn = null;

  DBSimpleQuery		queryobj = null;

  DBReader		docreader = null;

  String 	user = null;

  String 	password = null;

  String 	defaultDB = null;

  String 	resultStyleURL = null;

  //String 	resultStyleURL = "file:///home/httpd/html/xmltodb/resultset.xsl";

  PropertyResourceBundle options = null;

  /**

   * Initialize the servlet by creating appropriate database connections

   */

  public void init( ServletConfig config ) throws ServletException {

    try {

      super.init( config );

      this.config = config;

      this.context = config.getServletContext();

      System.out.println("Servlet Initialize");

      // Get the configuration file

      options = (PropertyResourceBundle)PropertyResourceBundle.getBundle("edu.ucsb.nceas.metacat.metacat");

      user = (String)options.handleGetObject("user");

      password = (String)options.handleGetObject("password");

      defaultDB = (String)options.handleGetObject("defaultDB");

      resultStyleURL = (String)options.handleGetObject("resultStyleURL");

      try {

        // Open a connection to the database

        conn = MetaCatUtil.openDBConnection(

                "oracle.jdbc.driver.OracleDriver",

                defaultDB, user, password);

        queryobj = new DBSimpleQuery(conn);

        docreader = new DBReader(conn);

      } catch (Exception e) {

      }

    } catch ( ServletException ex ) {

      throw ex;

    }

  }

  /** Handle "GET" method requests from HTTP clients */

  public void doGet (HttpServletRequest request, HttpServletResponse response)

    throws ServletException, IOException {

    // Process the data and send back the response

    handleGetOrPost(request, response);

  }

  /** Handle "POST" method requests from HTTP clients */

  public void doPost( HttpServletRequest request, HttpServletResponse response)

    throws ServletException, IOException {

    // Process the data and send back the response

    handleGetOrPost(request, response);

  }

  /**

   * Control servlet response depending on the action parameter specified

   */

  private void handleGetOrPost(HttpServletRequest request, 

    HttpServletResponse response) 

    throws ServletException, IOException {

    // Get a handle to the output stream back to the client

    PrintWriter out = response.getWriter();

    String name = null;

    String[] value = null;

    Hashtable params = new Hashtable();

    Enumeration paramlist = request.getParameterNames();

    while (paramlist.hasMoreElements()) {

      name = (String)paramlist.nextElement();

      value = request.getParameterValues(name);

      params.put(name,value);

    }

    String action = ((String[])params.get("action"))[0];

    if (action.equals("query")) {

      handleQueryAction(out, params, response);

    } else if (action.equals("getdocument")) {

      handleGetDocumentAction(out, params, response);

    } else if (action.equals("putdocument")) {

      handlePutDocumentAction(out, params, response);

    } else if (action.equals("validate")) {

      handleValidateAction(out, params, response);  

    } else {

      out.println("Error: action not registered.  Please report this error.");

    }

    // Close the stream to the client

    out.close();

  }

  /** 

   * Handle the database query request and return a result set, possibly

   * transformed from XML into HTML

   */

  private void handleQueryAction(PrintWriter out, Hashtable params, 

               HttpServletResponse response) {

      // Run the query

      Hashtable nodelist = null;

      String query = ((String[])params.get("query"))[0]; 

      if (queryobj != null) {

        nodelist = queryobj.findRootNodes(query);

      } else {

        out.println("Query Object Init failed.");

        out.println(user);

        out.println(defaultDB);

      }

      // Create a buffer to hold the xml result

      StringBuffer resultset = new StringBuffer();

      // Print the resulting root nodes

      long nodeid;

      resultset.append("<?xml version=\"1.0\"?>\n");

      resultset.append("<resultset>\n");

      resultset.append("  <query>" + query + "</query>");

      Enumeration rootlist = nodelist.keys(); 

      while (rootlist.hasMoreElements()) {

        nodeid = ((Long)rootlist.nextElement()).longValue();

        resultset.append("  <nodeid>" + nodeid + "</nodeid>");

      }

      resultset.append("</resultset>");

      String qformat = ((String[])params.get("qformat"))[0]; 

      if (qformat.equals("xml")) {

        // set content type and other response header fields first

        response.setContentType("text/xml");

        out.println(resultset.toString());

      } else if (qformat.equals("html")) {

        // set content type and other response header fields first

        response.setContentType("text/html");

        //out.println("Converting to HTML...");

        XMLDocumentFragment htmldoc = null;

        try {

          XSLStylesheet style = new XSLStylesheet(new URL(resultStyleURL), null);

          htmldoc = (new XSLProcessor()).processXSL(style, 

                     (Reader)(new StringReader(resultset.toString())),null);

          htmldoc.print(out);

        } catch (Exception e) {

          out.println("Error transforming document:\n" + e.getMessage());

        }

      }

  }

  /** 

   * Handle the database getdocument request and return a XML document, 

   * possibly transformed from XML into HTML

   */

  private void handleGetDocumentAction(PrintWriter out, Hashtable params, 

               HttpServletResponse response) {

      // Get the document indicated

      String docid = ((String[])params.get("docid"))[0]; 

      String doc = docreader.readXMLDocument((new Long(docid)).longValue());

      // set content type and other response header fields first

      response.setContentType("text/xml");

      out.println(doc);

  }

  /** 

   * Handle the database putdocument request and write an XML document 

   * to the database connection

   */

  private void handlePutDocumentAction(PrintWriter out, Hashtable params, 

               HttpServletResponse response) {

      // Get the document indicated

      String[] doctext = (String[])params.get("doctext");

      StringReader xml = new StringReader(doctext[0]);

      // write the document to the database

      try {

        DBSAXWriter dbw = new DBSAXWriter(xml, conn);

      } catch (SQLException e1) {

          out.println("Error 1 loading document:<p>\n" + e1.getMessage());

      }catch (IOException e2) {

          out.println("Error 2 loading document:<p>\n" + e2.getMessage());

      }catch (ClassNotFoundException e3) {

          out.println("Error 3 loading document:<p>\n" + e3.getMessage());

      }

      // set content type and other response header fields first

      response.setContentType("text/xml");

      out.println(doctext[0]);

  }

  /** 

   * Handle the validtion request and return the results 

   * to the requestor - DFH

   */

  private void handleValidateAction(PrintWriter out, Hashtable params, HttpServletResponse response) {

      // Get the document indicated

      String[] valtext = (String[])params.get("valtext");

      SAXParser parser = new SAXParser();           // works for both Xerces and Oracle

      parser.setValidationMode(true);               // Oracle

      GenericXMLValidate gxv = new GenericXMLValidate(parser);

      boolean valid = gxv.validateString(valtext[0]);

      // set content type and other response header fields first

      response.setContentType("text/plain");

      if (valid) {

        out.println("The input XML is VALID!");

      }

      else {

        out.println("The input XML is NOT VALID\n" + gxv.returnErrors());

      } 

    }

}