Metacat

/**

 *  '$RCSfile$'

 *  Copyright: 2004 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.metacattest;

import java.io.File;

import java.io.FileNotFoundException;

import java.io.IOException;

import edu.ucsb.nceas.metacat.DBConnectionPool;

import edu.ucsb.nceas.metacat.EventLog;

import edu.ucsb.nceas.metacat.EventLogData;

import edu.ucsb.nceas.metacat.MetaCatUtil;

import edu.ucsb.nceas.utilities.Options;

import junit.framework.TestCase;

/**

 * Test the logging facility against the database connection.

 * 

 * @author jones

 */

public class EventLogTest extends TestCase

{

    protected void setUp() throws Exception

    {

        super.setUp();

        try {

            File propertyFile = new File("./lib/metacat.properties");

            Options options = Options.initialize(propertyFile);

            MetaCatUtil util = new MetaCatUtil();

            DBConnectionPool pool = DBConnectionPool.getInstance();

        } catch (FileNotFoundException e) {

            fail(e.getMessage());

        } catch (IOException e) {

            fail(e.getMessage());

        }

    }

    /**

     * Test whether a valid instance of the EventLog can be retrieved.

     *

     */

    public void testGetInstance()

    {

        EventLog logger = EventLog.getInstance();

        assertTrue(logger != null);

    }

    public void testLog()

    {

        EventLogData event = new EventLogData("192.168.1.103", "public", 

                "test.1", 1, "read");

        assertTrue(event != null);

        EventLog.getInstance().log(event);

    }

}

DROP SEQUENCE access_log_id_seq;

DROP TABLE access_log;

/*

 *Logging -- table to store metadata and data access log

 */

CREATE SEQUENCE access_log_id_seq;

CREATE TABLE access_log (

  entryid       INT8 default nextval ('access_log_id_seq'),

  ip_address    VARCHAR(512),

  principal     VARCHAR(512),

  docid         VARCHAR(250),	-- the document id #

  rev           INT8,           -- the revision number

  event         VARCHAR(512),

  date_logged   TIMESTAMP,

  CONSTRAINT access_log_pk PRIMARY KEY (entryid)

);

/**

 *  '$RCSfile$'

 *  Copyright: 2004 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;

/**

 * @author jones

 *

 * TODO To change the template for this generated type comment go to

 * Window - Preferences - Java - Code Generation - Code and Comments

 */

public class EventLogData {

	private String ipAddress;

	private String principal;

	private String docid;

    private long revision;

	private String event;

	/**

	 * @param ipAddress

	 * @param principal

	 * @param docid

	 * @param revision

	 * @param event

	 */

	public EventLogData(String ipAddress, String principal, String docid,

			long revision, String event) {

		this.ipAddress = ipAddress;

		this.principal = principal;

		this.docid = docid;

		this.revision = revision;

		this.event = event;

	}

	/**

	 * @return Returns the docid.

	 */

	public String getDocid() {

		return docid;

	}

	/**

	 * @param docid The docid to set.

	 */

	public void setDocid(String docid) {

		this.docid = docid;

	}

	/**

	 * @return Returns the event.

	 */

	public String getEvent() {

		return event;

	}

	/**

	 * @param event The event to set.

	 */

	public void setEvent(String event) {

		this.event = event;

	}

	/**

	 * @return Returns the ipAddress.

	 */

	public String getIpAddress() {

		return ipAddress;

	}

	/**

	 * @param ipAddress The ipAddress to set.

	 */

	public void setIpAddress(String ipAddress) {

		this.ipAddress = ipAddress;

	}

	/**

	 * @return Returns the principal.

	 */

	public String getPrincipal() {

		return principal;

	}

	/**

	 * @param principal The principal to set.

	 */

	public void setPrincipal(String principal) {

		this.principal = principal;

	}

	/**

	 * @return Returns the revision.

	 */

	public long getRevision() {

		return revision;

	}

	/**

	 * @param revision The revision to set.

	 */

	public void setRevision(long revision) {

		this.revision = revision;

	}

}

/**

 *  '$RCSfile$'

 *  Copyright: 2004 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;

import java.sql.SQLException;

import java.sql.Statement;

import java.text.SimpleDateFormat;

import java.util.Date;

/**

 * EventLog is used to intialize and store a log of events that occur in an

 * application. The events are registered with the logger as they occur, but

 * EventLog writes them to permenant storage when it is most convenient or

 * efficient. EventLog is a Singleton as there should always be only one object

 * for these logging events.

 * 

 * TODO: Logging to the database needn't be synchronous with the event.  

 * Instead, a separate thread can be launched that periodically sleeps and only

 * wakes periodically to see if metacat is idle.  The log event can be cached

 * and inserted later when the thread wakes and finds metacat idle.

 * 

 * TODO: Write a function that archives a part of the log table to an 

 * external text file so that the log table doesn't get to big.  This 

 * function should be able to be called manually or on a schedule. 

 * 

 * TODO: Write oracle sql code for creating logging table

 * 

 * TODO: Write an access function that returns an XML report for a

 * specific subset of events.  Users should be able to query on

 * principal, docid/rev, date, event, and possibly other fields.

 * 

 * @author jones

 */

public class EventLog

{

    /**

     * The single instance of the event log that is always returned.

     */

    private static EventLog self = null;

    /**

     * A private constructor that initializes the class when getInstance() is

     * called.

     */

    private EventLog()

    {

    }

    /**

     * Return the single instance of the event log after initializing it if it

     * wasn't previously initialized.

     * 

     * @return the single EventLog instance

     */

    public static EventLog getInstance()

    {

        if (self == null) {

            self = new EventLog();

        }

        return self;

    }

    /**

     * Log an event of interest to the application. The information logged can

     * include basic identification information about the principal or computer

     * that initiated the event.

     * 

     * @param logData the data to be logged when an event occurs

     */

    public void log(EventLogData logData)

    {

        insertLogEntry(logData);

    }

    /**

     * Insert a single log event record to the database.

     * 

     * @param logData the data to be logged when an event occurs

     */

    private void insertLogEntry(EventLogData logData)

    {

        SimpleDateFormat simpleDateFormat = new SimpleDateFormat(

                "dd-MMM-yyyy HH:mm:ss");

        String insertString = "insert into access_log"

                + "(ip_address, principal, docid, rev, "

                + "event, date_logged) "

                + "values ("

                + "'" + logData.getIpAddress() + "', " 

                + "'" + logData.getPrincipal() + "', "

                + "'" + logData.getDocid() + "', "

                + logData.getRevision() + ", "

                + "'" + logData.getEvent() + "', "

                + "'" + simpleDateFormat.format(new Date()) + "')"; 

        DBConnection dbConn = null;

        int serialNumber = -1;

        try {

            // Get a database connection from the pool

            dbConn = DBConnectionPool.getDBConnection("EventLog.writeLog");

            serialNumber = dbConn.getCheckOutSerialNumber();

            // Execute the insert statement

            Statement stmt = dbConn.createStatement();

            stmt.executeUpdate(insertString);

            stmt.close();

        } catch (SQLException e) {

            MetaCatUtil.debugMessage("Error while logging event to database: " 

                    + e.getMessage(), 5);

        } finally {

            // Return database connection to the pool

            DBConnectionPool.returnDBConnection(dbConn, serialNumber);

        }

    }

}

/*

 * logging.sql -- Create or replace tables for logging events

 */

/*

 *Logging -- table to store metadata and data access log

 */

CREATE SEQUENCE access_log_id_seq;

CREATE TABLE access_log (

  entryid       INT8 default nextval ('access_log_id_seq'),

  ip_address    VARCHAR(512),

  principal     VARCHAR(512),

  docid         VARCHAR(250),	-- the document id #

  rev           INT8,           -- the revision number

  event         VARCHAR(512),

  date_logged   TIMESTAMP,

  CONSTRAINT access_log_pk PRIMARY KEY (entryid)

);