001: /*
002: * Licensed to the Apache Software Foundation (ASF) under one
003: * or more contributor license agreements. See the NOTICE file
004: * distributed with this work for additional information
005: * regarding copyright ownership. The ASF licenses this file
006: * to you under the Apache License, Version 2.0 (the
007: * "License"); you may not use this file except in compliance
008: * with the License. You may obtain a copy of the License at
009: *
010: * http://www.apache.org/licenses/LICENSE-2.0
011: *
012: * Unless required by applicable law or agreed to in writing,
013: * software distributed under the License is distributed on an
014: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015: * KIND, either express or implied. See the License for the
016: * specific language governing permissions and limitations
017: * under the License.
018: */
019: package org.apache.openjpa.lib.jdbc;
020:
021: import java.sql.Connection;
022: import java.sql.Statement;
023: import java.util.EventObject;
024:
025: /**
026: * A JDBC event. The event source will be the connection.
027: *
028: * @author Marc Prud'hommeaux
029: * @author Abe White
030: * @see JDBCListener
031: */
032: public class JDBCEvent extends EventObject {
033:
034: /**
035: * Type code indicating that a {@link Statement} is being prepared.
036: */
037: public static final short BEFORE_PREPARE_STATEMENT = 1;
038:
039: /**
040: * Type code indicating that a {@link Statement} is being prepared.
041: */
042: public static final short AFTER_PREPARE_STATEMENT = 2;
043:
044: /**
045: * Type code indicating that a {@link Statement} is being created.
046: */
047: public static final short BEFORE_CREATE_STATEMENT = 3;
048:
049: /**
050: * Type code indicating that a {@link Statement} is being created.
051: */
052: public static final short AFTER_CREATE_STATEMENT = 4;
053:
054: /**
055: * Type code indicating that a {@link Statement} is about to be executed.
056: */
057: public static final short BEFORE_EXECUTE_STATEMENT = 5;
058:
059: /**
060: * Type code indicating that a {@link Statement} completed execution.
061: */
062: public static final short AFTER_EXECUTE_STATEMENT = 6;
063:
064: /**
065: * Type code indicating that a {@link Connection} is about to be committed.
066: */
067: public static final short BEFORE_COMMIT = 7;
068:
069: /**
070: * Type code indicating that a {@link Connection} was just committed.
071: */
072: public static final short AFTER_COMMIT = 8;
073:
074: /**
075: * Type code indicating that a rollback is about to occur.
076: */
077: public static final short BEFORE_ROLLBACK = 9;
078:
079: /**
080: * Type code indicating that a rollback just occured.
081: */
082: public static final short AFTER_ROLLBACK = 10;
083:
084: /**
085: * Type code indicating that a connection was obtained. This does
086: * not necessarily mean that the connection is new if pooling is enabled.
087: */
088: public static final short AFTER_CONNECT = 11;
089:
090: /**
091: * Type code indicating that a connection was closed. This does
092: * not necessarily mean that the underlying database connection was
093: * severed if pooling is enabled.
094: */
095: public static final short BEFORE_CLOSE = 12;
096:
097: private final short type;
098: private final long time;
099: private final String sql;
100: private final JDBCEvent associatedEvent;
101: private final transient Statement statement;
102:
103: /**
104: * Constructor.
105: */
106: public JDBCEvent(Connection source, short type,
107: JDBCEvent associatedEvent, Statement statement, String sql) {
108: super (source);
109: this .type = type;
110: this .time = System.currentTimeMillis();
111: this .associatedEvent = associatedEvent;
112: this .sql = sql;
113: this .statement = statement;
114: }
115:
116: /**
117: * Return the event's type code.
118: */
119: public final short getType() {
120: return type;
121: }
122:
123: /**
124: * Return the Connection for this event.
125: */
126: public final Connection getConnection() {
127: return (Connection) getSource();
128: }
129:
130: /**
131: * Return the time the event was constructed.
132: */
133: public final long getTime() {
134: return time;
135: }
136:
137: /**
138: * Return the associated {@link JDBCEvent} for this event.
139: * For AFTER_XXX events, this will typically be the JDBCEvent
140: * that was created in the BEFORE_XXX stage. This may be null when
141: * an association is not appropriate for the event.
142: */
143: public final JDBCEvent getAssociatedEvent() {
144: return associatedEvent;
145: }
146:
147: /**
148: * Return the SQL associated with this event; may be null.
149: */
150: public final String getSQL() {
151: return sql;
152: }
153:
154: /**
155: * Return the Statement for this event, may be null for events
156: * unrelated to Statement execution.
157: */
158: public final Statement getStatement() {
159: return statement;
160: }
161: }
|