/ - Diff - Metacat - Ecoinformatics Redmine

« Previous | Next »

Revision 2113

Added by Matt Jones over 20 years ago

Added the EventLog functionality to the servlet as action=getlog. Valid parameters are ipAddress, principal, docid, event, start, end. All parameters can be repeated except start and end.

     import java.sql.Timestamp;
     import java.text.ParseException;
     import java.text.SimpleDateFormat;
     import java.util.Date;
     import edu.ucsb.nceas.metacat.DBConnectionPool;
     import edu.ucsb.nceas.metacat.EventLog;
-...
             Timestamp startDate = null;
             Timestamp endDate = null;
             try {
                 startDate = new Timestamp((format.parse("2004-04-07 09:32:00")).getTime());
                 endDate = new Timestamp((format.parse("2004-04-07 09:50:00")).getTime());
                 startDate = new Timestamp((format.parse("2004-04-08 02:32:00")).getTime());
                 endDate = new Timestamp((format.parse("2004-04-08 11:20:00")).getTime());
             } catch (ParseException e) {
                 System.out.println("Failed to created endDate from format.");
+            }

             int endIndex = 0;
             if (ipAddress != null) {
                 query.append(formatSqlClause(clauseAdded, "ip_address", ipAddress));
                 query.append(generateSqlClause(clauseAdded, "ip_address", ipAddress));
                 clauseAdded = true;
+            }
             if (principal != null) {
                 query.append(formatSqlClause(clauseAdded, "principal", principal));
                 query.append(generateSqlClause(clauseAdded, "principal", principal));
                 clauseAdded = true;
+            }
             if (docid != null) {
                 query.append(formatSqlClause(clauseAdded, "docid", docid));
                 query.append(generateSqlClause(clauseAdded, "docid", docid));
                 clauseAdded = true;
+            }
             if (event != null) {
                 query.append(formatSqlClause(clauseAdded, "event", event));
                 query.append(generateSqlClause(clauseAdded, "event", event));
                 clauseAdded = true;
+            }
             if (startDate != null) {
-...
                 dbConn = DBConnectionPool.getDBConnection("EventLog.getReport");
                 serialNumber = dbConn.getCheckOutSerialNumber();
                 // Execute the insert statement
                 System.out.println(query.toString());
                 // Execute the query statement
                 PreparedStatement stmt = dbConn.prepareStatement(query.toString());
                 if (startIndex > 0) {
                     stmt.setTimestamp(startIndex, startDate);
-...
+                }
                 stmt.execute();
                 ResultSet rs = stmt.getResultSet();
                 //process the result
                 //process the result and return it as an XML document
                 resultDoc.append("<?xml version=\"1.0\"?>\n");
                 resultDoc.append("<log>\n");
                 while (rs.next()) {
                     resultDoc.append(formatXmlRecord(rs.getString(1), rs.getString(2),
                     resultDoc.append(generateXmlRecord(rs.getString(1), rs.getString(2),
                                     rs.getString(3), rs.getString(4),
                                     rs.getString(5), rs.getTimestamp(6)));
+                }
-...
          * @param values the values to match in the SQL query
          * @return a String representation of the SQL query clause
          */
         private String formatSqlClause(boolean addOperator, String column, String[] values)
         private String generateSqlClause(boolean addOperator, String column,
                 String[] values)
+        {
             StringBuffer clause = new StringBuffer();
             if (addOperator) {
-...
          * @param dateLogged the date on which the event occurred
          * @return String containing the formatted XML
          */
         private String formatXmlRecord(String entryId, String ipAddress, String principal,
                         String docid, String event, Timestamp dateLogged)
         private String generateXmlRecord(String entryId, String ipAddress,
                 String principal, String docid, String event, Timestamp dateLogged)
+        {
             StringBuffer rec = new StringBuffer();
             rec.append("<logEntry>");
             rec.append(formatXmlElement("entryid", entryId));
             rec.append(formatXmlElement("ipAddress", ipAddress));
             rec.append(formatXmlElement("principal", principal));
             rec.append(formatXmlElement("docid", docid));
             rec.append(formatXmlElement("event", event));
             rec.append(formatXmlElement("dateLogged", dateLogged.toString()));
             rec.append(generateXmlElement("entryid", entryId));
             rec.append(generateXmlElement("ipAddress", ipAddress));
             rec.append(generateXmlElement("principal", principal));
             rec.append(generateXmlElement("docid", docid));
             rec.append(generateXmlElement("event", event));
             rec.append(generateXmlElement("dateLogged", dateLogged.toString()));
             rec.append("</logEntry>\n");
             return rec.toString();
-...
          * @param value the content of the xml element
          * @return the formatted XML element as a String
          */
         private String formatXmlElement(String name, String value)
         private String generateXmlElement(String name, String value)
+        {
             return "<" + name + ">" + value + "</" + name + ">";
+        }

     import java.sql.PreparedStatement;
     import java.sql.ResultSet;
     import java.sql.SQLException;
     import java.sql.Timestamp;
     import java.text.ParseException;
     import java.text.SimpleDateFormat;
     import java.util.Enumeration;
     import java.util.Hashtable;
     import java.util.PropertyResourceBundle;
-...
      * action=getdataguide -- retrieve a Data Guide <br>
      * action=getprincipals -- retrieve a list of principals in XML <br>
      * datadoc -- data document name (id) <br>
      * action=getlog -- get a report of events that have occurred in the system<br>
      * ipAddress --  filter on one or more IP addresses<br>
      * principal -- filter on one or more principals (LDAP DN syntax)<br>
      * docid -- filter on one or more document identifiers (with revision)<br>
      * event -- filter on event type (e.g., read, insert, update, delete)<br>
      * start -- filter out events before the start date-time<br>
      * end -- filter out events before the end date-time<br>
      * <p>
      * The particular combination of parameters that are valid for each particular
      * action value is quite specific. This documentation will be reorganized to
-...
+        {
             // Close all db connection
             System.out.println("Destroying MetacatServlet");
             connPool.release();
             DBConnectionPool.release();
+        }
         /** Handle "GET" method requests from HTTP clients */
-...
                     PrintWriter out = response.getWriter();
                     out.println(Version.getVersionAsXml());
                     out.close();
                 } else if (action.equals("getlog")) {
                     handleGetLogAction(params, request, response);
                 } else if (action.equals("login") || action.equals("logout")) {
                 } else if (action.equals("protocoltest")) {
                     String testURL = "metacat://dev.nceas.ucsb.edu/NCEAS.897766.9";
-...
                 DocumentImpl doc = new DocumentImpl(docid);
                 //check the permission for read
                 if (!doc.hasReadPermission(user, groups, docid)) {
                 if (!DocumentImpl.hasReadPermission(user, groups, docid)) {
                     Exception e = new Exception("User " + user
                             + " does not have permission"
                             + " to read the document with the docid " + docid);
-...
                     DocumentImpl doc = new DocumentImpl(docid);
                     //check the permission for read
                     if (!doc.hasReadPermission(user, groups, docid)) {
                     if (!DocumentImpl.hasReadPermission(user, groups, docid)) {
                         Exception e = new Exception("User " + user
                                 + " does not have "
                                 + "permission to read the document with the docid "
-...
                 out.println(e.getMessage());
                 out.println("</error>");
+            }
+        }
         /**
          * Print a report from the event log based on filter parameters passed in
          * from the web.
+         *
          * TODO: make sure urlencoding of timestamp params is working
+         *
          * @param params the parameters from the web request
          * @param request the http request object for getting request details
          * @param response the http response object for writing output
          */
         private void handleGetLogAction(Hashtable params, HttpServletRequest request,
                 HttpServletResponse response)
+        {
             // Get all of the parameters in the correct formats
             String[] ipAddress = (String[])params.get("ipaddress");
             String[] principal = (String[])params.get("principal");
             String[] docid = (String[])params.get("docid");
             String[] event = (String[])params.get("event");
             String[] startArray = (String[]) params.get("start");
             String[] endArray = (String[]) params.get("end");
             String start = null;
             String end = null;
             if (startArray != null) {
                 start = startArray[0];
+            }
             if (endArray != null) {
                 end = endArray[0];
+            }
             Timestamp startDate = null;
             Timestamp endDate = null;
             SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
             try {
                 if (start != null) {
                     startDate = new Timestamp((format.parse(start)).getTime());
+                }
                 if (end != null) {
                     endDate = new Timestamp((format.parse(end)).getTime());
+                }
             } catch (ParseException e) {
                 System.out.println("Failed to created Timestamp from input.");
+            }
             // Request the report by passing the filter parameters
             try {
                 response.setContentType("text/xml");
                 PrintWriter out = response.getWriter();
                 out.println(EventLog.getInstance().getReport(ipAddress, principal,
                         docid, event, startDate, endDate));
                 out.close();
             } catch (IOException e) {
                 MetaCatUtil.debugMessage(
                         "Could not open http response for writing: "
                         + e.getMessage(), 5);
+            }
+        }
         /**
          * Handle documents passed to metacat that are encoded using the
          * "multipart/form-data" mime type. This is typically used for uploading
          * data files which may be binary and large.

Also available in: Unified diff

Project

General

Profile

Metacat

Revision 2113

Added by Matt Jones over 20 years ago