/ - Diff - Metacat - Ecoinformatics Redmine

« Previous | Next »

Revision 3081

Added by Matt Jones about 18 years ago

Began work on a web interface for configuring metacat at runtime. This system
checks the 'configured' property when metacat starts up. If configured=false, then
it loads an HTML form containing the properties that need to be set. The user configures the properties and they are written into the metacat.properties file. Then metacat needs to be restarted.

Lots still to do here -- its not really useful yet because I hardcoded 2 properties to be collected (user and password), but really the list should be gotten from the properties file itself.

This should not get in your way because by default I checked in 'configured=true' to the properties file so the configuration code is never called.

     <%@ page    language="java" %>
     <%
     /**
      *  '$RCSfile$'
      *    Copyright: 2006 Regents of the University of California and the
      *               National Center for Ecological Analysis and Synthesis
      *  For Details: http://www.nceas.ucsb.edu/
+     *
      *   '$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
      */
     %>
     <html>
     <head>
     <title>Metacat Configuration Succeeded</title>
     <style language="Javascript">
     <!--
     .section {
         font-size: 16pt;
         font-weight: bold;
         border-bottom: solid #dddddd 1px;
+    }
     -->
     </style>
     </head>
     <body>
     <p><img src="metacat-logo.png" width="75px" align="right"/>
     <h2>Metacat Configuration Succeeded</h2>
     </p>
     <p>Congratulations!</p>
     <p>You have now successfully configured this installation of Metacat. All that
        remains is to restart the metacat servlet for the changes to take effect.
     </p>
     <br clear="right"/>
     <p class="section">Restarting Metacat</p>
     <p>The simplest way to restart metacat is to restart the entire servlet engine.
        For Tomcat, this would mean calling "$TOMCAT_HOME/bin/tomcat.sh restart" or
        an equivalent command appropriate to your operating system.
     </p>
     </body>
     </html>

     <%@ page    language="java" %>
     <%
     /**
      *  '$RCSfile$'
      *    Copyright: 2006 Regents of the University of California and the
      *               National Center for Ecological Analysis and Synthesis
      *  For Details: http://www.nceas.ucsb.edu/
+     *
      *   '$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
      */
     %>
     <html>
     <head>
     <title>Metacat Configuration</title>
     <style language="Javascript">
     <!--
     .section {
         font-size: 16pt;
         font-weight: bold;
         border-bottom: solid #dddddd 1px;
+    }
     -->
     </style>
     </head>
     <body>
     <p><img src="metacat-logo.png" width="75px" align="right"/>
     <h2>Metacat Configuration</h2>
     </p>
     <p>Welcome to MetaCat!</p>
     <p>This installation of Metacat needs to be configured before it can
        function properly. Please fill out the required information and you'll be
        up and running.
     </p>
     <br clear="right"/>
     <p class="section">Database connection</p>
     <form method="POST" action="/knb/metacat">
     <p>Database Username:
        <input type="text" name="user" value="<%= request.getAttribute("user") %>"/></p>
     <p>Database Password: <input type="password" name="password" value="<%= request.getAttribute("password") %>"/></p>
     <p><input type="hidden" name="action" value="configure"/>
     <p><input type="submit" value="Save"/></p>
     </form>
     <p class="section">Access controls</p>
     <p>More options go here.</p>
     </body>
     </html>

+    #
     # Properties file defining options for the MetaCatServlet.java servlet
+    #
     # Matt Jones, Dan Higgins, Jivka Bojilova
     # '$Id$'
+    #
     configured=false
     ######## Configuration section        #########################################
     # This flag indicates whether configuration information has been collected from
     # the user installing metacat yet.
     configured=true
     configurationPage=/configure.jsp
     configurationSuccessPage=/configure-restart.jsp
     version=1.6.0
     ######## Database section             #########################################
     user=@user@
     password=@password@
-...
     cycleTimeOfDBConnection=30000
     ######## Access section               #########################################
     administrators=@administrators@
     moderators=@moderators@
-...
     # that combination has been requested 50 times, set this value to 50
     xml_returnfield_count=0
     # Harvester properties
     ######## Harvester section            #########################################
     connectToMetacat=true
     delay=0
-...
     # End of Harvester properties
     # BEGIN spatial options
     ######## Spatial section              #########################################
     runSpatialOption=true
     regenerateCacheOnRestart=true

                 Options options = null;
                 try {
                     options = Options.initialize(propertyFile);
                     logMetacat.info("Options configured: "
                         + options.getOption("configured"));
                 } catch (IOException ioe) {
                     logMetacat.error("Error in loading options: "
                             + ioe.getMessage());
+                }
                 // Check if the servlet was configured, and if not stop the
                 // initialization and skip to the configuration web form when
                 // metacat is called
                 boolean configured = options.getOption("configured").equals("true");
                 if (!configured) {
                     logMetacat.info("Options configured: " + configured);
                     return;
+                }
                 MetaCatUtil util = new MetaCatUtil();
                 //initialize DBConnection pool
-...
             MetaCatUtil util = new MetaCatUtil();
             Logger logMetacat = Logger.getLogger(MetaCatServlet.class);
             // Each time metacat is called, see if it has been configured,
             // and if not, then go ahead and configure it's options
             boolean configured = MetaCatUtil.getOption("configured").equals("true");
             if (!configured) {
                 handleServletConfiguration(request, response);
                 return;
+            }
             /*
              * logMetacat.debug("Connection pool size: "
              * +connPool.getSizeOfDBConnectionPool(),10);
-...
             //logMetacat.debug("The docid will be read is "+newAccNum);
             return newAccNum;
+      }
         /**
          * Handle configuration of the servlet the first time that Metacat starts
          * by collecting necessary configuration information from the administrator.
+         *
          * @param request the http request information
          * @param response the http response to be sent back to the client
          */
         private void handleServletConfiguration(HttpServletRequest request,
                 HttpServletResponse response) {
             String action = request.getParameter("action");
             if (action == null || !action.equals("configure")) {
                 // The servlet configuration parameters have not been set, so
                 // redirect to a web form for configuring metacat
                 // First add attributes to the request for all configuration options
                 // TODO: MBJ should not hard code these, but get them from the config
                 // Then the list of attributes can be passed to the form so that the
                 // form can autogenerate the right number of fields.  Still need
                 // to determine a way to get some metadata about each attribute to
                 // the form jsp, such as a description and possibly a widget type
                 // to use and possibly a controlled values list
                 request.setAttribute( "user", MetaCatUtil.getOption("user"));
                 request.setAttribute( "password", MetaCatUtil.getOption("password"));
                 // Forward the request
                 forwardRequest(request, response,
                         MetaCatUtil.getOption("configurationPage"));
             } else {
                 // The configuration form is being submitted and needs to be
                 // processed, setting the properties in the configuration file
                 // then restarting metacat
                 // TODO: Should first validate that the options provided are
                 // legitimate, and possibly even test them (for example, use
                 // the database connection info to connect to the database)
                 // TODO: MBJ should not hard code these, but get them from the config
                 checkAndSetOption(request, response, "user");
                 checkAndSetOption(request, response, "password");
                 // Now that the options have been set, change the 'configured'
                 // option to 'true' so that normal metacat requests will go through
                 MetaCatUtil.setOption("configured", "true");
                 // Reload the servlet so that the database connections are loaded
                 // In the absence of being able to do this programatically, then
                 // redirect to a response page with instructions to restart
                 forwardRequest(request, response,
                         MetaCatUtil.getOption("configurationSuccessPage"));
+            }
+        }
         /**
          * Take input from the user in an HTTP request about an option to be
          * changed and update the options property file with that new value
          * if it has changed from the value that was originally set.
+         *
          * @param request that was generated by the user
          * @param response to send output back to the user
          * @param optionName the name of the option to be checked and set
          */
         private void checkAndSetOption(HttpServletRequest request,
                 HttpServletResponse response, String optionName) {
             String value = MetaCatUtil.getOption(optionName);
             String newValue = request.getParameter(optionName);
             if (!newValue.equals(value)) {
                 MetaCatUtil.setOption(optionName, newValue);
+            }
+        }
         /**
          * Forward a request that was received by this servlet on to another
          * JSP page or servlet to continue handling the request.
+         *
          * @param request to be forwarded
          * @param response that can be used for writing output to the client
          * @param destination the context-relative URL to which the request is forwarded
          */
         private void forwardRequest(HttpServletRequest request,
                 HttpServletResponse response, String destination) {
             try {
                 getServletConfig().getServletContext().getRequestDispatcher(
                         destination).forward(request, response);
             } catch (Exception e1) {
                 try {
                     PrintWriter out = response.getWriter();
                     out.println("Error while forwarding to: " + destination);
                     out.close();
                 } catch (IOException e) {
                     Logger logMetacat = Logger.getLogger(MetaCatServlet.class);
                     logMetacat.debug("Unable to return error message to servlet.");
+                }
+            }
+        }
+    }

Also available in: Unified diff

Project

General

Profile

Metacat

Revision 3081

Added by Matt Jones about 18 years ago