If-Modified-Since header, only a 304 status code
@@ -184,6 +187,15 @@
log.info(LogManager.getHeader(context, "view_bitstream",
"bitstream_id=" + bitstream.getID()));
+ AbstractUsageEvent ue = (AbstractUsageEvent)PluginManager.getSinglePlugin(AbstractUsageEvent.class);
+ ue.setSessionID(request.getSession().getId());
+ ue.setSource(request.getRemoteAddr());
+ ue.setEperson(context.getCurrentUser());
+ ue.setEventType(AbstractUsageEvent.VIEW); // FIXME move to org.dspace.core.Constants?
+ ue.setObjectType(Constants.BITSTREAM);
+ ue.setID(bitstream.getID());
+ ue.fire();
+
// Modification date
// TODO: Currently the date of the item, since we don't have dates
// for files
Index: src/org/dspace/app/webui/servlet/RetrieveServlet.java
===================================================================
--- src/org/dspace/app/webui/servlet/RetrieveServlet.java (.../DSpace/current) (revision 111)
+++ src/org/dspace/app/webui/servlet/RetrieveServlet.java (.../SUEI/trunk) (working copy)
@@ -54,8 +54,11 @@
import org.dspace.core.Constants;
import org.dspace.core.Context;
import org.dspace.core.LogManager;
+import org.dspace.core.PluginManager;
import org.dspace.core.Utils;
+import edu.iupui.ulib.dspace.app.statistics.AbstractUsageEvent;
+
/**
* Servlet for retrieving bitstreams. The bits are simply piped to the user.
*
@@ -113,6 +116,15 @@
log.info(LogManager.getHeader(context, "view_bitstream",
"bitstream_id=" + bitstream.getID()));
+ AbstractUsageEvent ue = (AbstractUsageEvent)PluginManager.getSinglePlugin(AbstractUsageEvent.class);
+ ue.setSessionID(request.getSession().getId());
+ ue.setSource(request.getRemoteAddr());
+ ue.setEperson(context.getCurrentUser());
+ ue.setEventType(AbstractUsageEvent.VIEW); // FIXME move to org.dspace.core.Constants?
+ ue.setObjectType(Constants.BITSTREAM);
+ ue.setID(bitstream.getID());
+ ue.fire();
+
// Set the response MIME type
response.setContentType(bitstream.getFormat().getMIMEType());
Index: src/edu/iupui/ulib/dspace/app/statistics/PassiveUsageEvent.java
===================================================================
--- src/edu/iupui/ulib/dspace/app/statistics/PassiveUsageEvent.java (.../DSpace/current) (revision 0)
+++ src/edu/iupui/ulib/dspace/app/statistics/PassiveUsageEvent.java (.../SUEI/trunk) (revision 160)
@@ -0,0 +1,59 @@
+/*
+ * PassiveUsageEvent.java
+ *
+ * Version: $Revision: 0 $
+ *
+ * Date: $Date: 2008/02/08 10:33:00 $
+ *
+ * Copyright (C) 2008, Hewlett-Packard Company and Massachusetts
+ * Institute of Technology. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * - Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * - Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * - Neither the name of the Hewlett-Packard Company nor the name of the
+ * Massachusetts Institute of Technology nor the names of their
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
+ * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
+ * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
+ * DAMAGE.
+ */
+
+package edu.iupui.ulib.dspace.app.statistics;
+
+/**
+ * A null implementation of AbstractUsageEvent to absorb events harmlessly and
+ * cheaply.
+ *
+ * @author Mark H. Wood
+ * @version $Revision: 0 $
+ */
+public class PassiveUsageEvent extends AbstractUsageEvent
+{
+ /**
+ * Do nothing and return. Effectively, the event is discarded.
+ */
+ public void fire()
+ {
+ return;
+ }
+}
Index: src/edu/iupui/ulib/dspace/app/statistics/UsageEventXMLLogger.java
===================================================================
--- src/edu/iupui/ulib/dspace/app/statistics/UsageEventXMLLogger.java (.../DSpace/current) (revision 0)
+++ src/edu/iupui/ulib/dspace/app/statistics/UsageEventXMLLogger.java (.../SUEI/trunk) (revision 160)
@@ -0,0 +1,125 @@
+/*
+ * UsageEventXmlLogger.java
+ *
+ * Version: $Revision: 0 $
+ *
+ * Date: $Date: 2008/02/08 10:33:00 $
+ *
+ * Copyright (C) 2008, Hewlett-Packard Company and Massachusetts
+ * Institute of Technology. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * - Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * - Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * - Neither the name of the Hewlett-Packard Company nor the name of the
+ * Massachusetts Institute of Technology nor the names of their
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
+ * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
+ * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
+ * DAMAGE.
+ */
+
+package edu.iupui.ulib.dspace.app.statistics;
+
+import java.io.FileNotFoundException;
+import java.io.PrintWriter;
+import java.util.Date;
+
+import org.apache.log4j.Logger;
+
+import org.dspace.core.ConfigurationManager;
+
+/**
+ * Serialize AbstractUsageEvent data to a file as XML. Requires configuration:
+ * in dspace.cfg specify the path to the file as the value of
+ * {@code usageEvent.xmlLogger.file}.
+ *
+ * @author Mark H. Wood
+ * @version $Revision: 0 $
+ */
+public class UsageEventXMLLogger extends AbstractUsageEvent
+{
+ /** log4j category */
+ private static Logger errorLog = Logger
+ .getLogger(UsageEventXMLLogger.class);
+
+ /** File on which to write event records */
+ private static PrintWriter log = null;
+
+ public UsageEventXMLLogger()
+ {
+ super();
+
+ if (null == log)
+ {
+ String logPath = ConfigurationManager
+ .getProperty("usageEvent.xmlLogger.file");
+ if (null == logPath)
+ {
+ errorLog
+ .error("UsageEventXMLLogger unconfigured, will not log events");
+ return;
+ }
+
+ try
+ {
+ log = new PrintWriter(logPath);
+ }
+ catch (FileNotFoundException e)
+ {
+ errorLog
+ .error(
+ "UsageEventXMLLogger cannot open file, will not log events",
+ e);
+ return;
+ }
+
+ log.println("");
+ log.println("
+Defines usage event instrumentation points and provides implementations for
+testing.
+
+This package makes usage instrumentation (for statistics, or whatever else
+you may fancy) pluggable, while avoiding any unnecessary assumptions about how
+usage events may be transmitted, persisted, or processed.
+
+At appropriate points in the processing of user actions, events may be
+assembled and "fired". What happens when an event is fired is configurable
+via the PluginManager. One must configure a plugin for the AbstractUsageEvent
+class, defined in this package, to select an event processing implementation.
+
+Two "stock" implementations are provided.
+
+
+
Add the -l option to to pass the ingestion crosswalk a list of elements instead of a whole document, as if the List form of the ingest() method had been called. This is needed to test ingesters for formats like DC that get called with lists of elements instead of a root element.
A usage instrumentation plugin is configured as a singleton plugin for the abstract class edu.iupui.ulib.dspace.app.statistics.AbstractUsageEvent.
+
The XML Logger plugin is provided as the class edu.iupui.ulib.dspace.app.statistics.UsageEventXMLLogger. It writes event records to a file in a simple XML-like format. If left unconfigured, an error will be noted in the DSpace log and no file will be produced. To specify the file path, provide an absolute path as the value for usageEvent.xmlLogger.file in dspace.cfg.
The purpose of the checker is to verify that the content in a DSpace repository has not become corrupted or been tampered with. The functionality can be invoked on an ad-hoc basis from the command line, or configured via cron or similar. Options exist to support large repositories that cannot be entirely checked in one run of the tool. The tool is extensible to new reporting and checking priority approaches.
+DSpace can report usage events, such as bitstream downloads, to a pluggable event processor. This can be used for developing customized usage statistics, for example. A sample event processor plugin writes event records to a file as XML.
+