KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > quadcap > sql > file > Logger


1 package com.quadcap.sql.file;
2
3 /* Copyright 1999 - 2003 Quadcap Software. All rights reserved.
4  *
5  * This software is distributed under the Quadcap Free Software License.
6  * This software may be used or modified for any purpose, personal or
7  * commercial. Open Source redistributions are permitted. Commercial
8  * redistribution of larger works derived from, or works which bundle
9  * this software requires a "Commercial Redistribution License"; see
10  * http://www.quadcap.com/purchase.
11  *
12  * Redistributions qualify as "Open Source" under one of the following terms:
13  *
14  * Redistributions are made at no charge beyond the reasonable cost of
15  * materials and delivery.
16  *
17  * Redistributions are accompanied by a copy of the Source Code or by an
18  * irrevocable offer to provide a copy of the Source Code for up to three
19  * years at the cost of materials and delivery. Such redistributions
20  * must allow further use, modification, and redistribution of the Source
21  * Code under substantially the same terms as this license.
22  *
23  * Redistributions of source code must retain the copyright notices as they
24  * appear in each source code file, these license terms, and the
25  * disclaimer/limitation of liability set forth as paragraph 6 below.
26  *
27  * Redistributions in binary form must reproduce this Copyright Notice,
28  * these license terms, and the disclaimer/limitation of liability set
29  * forth as paragraph 6 below, in the documentation and/or other materials
30  * provided with the distribution.
31  *
32  * The Software is provided on an "AS IS" basis. No warranty is
33  * provided that the Software is free of defects, or fit for a
34  * particular purpose.
35  *
36  * Limitation of Liability. Quadcap Software shall not be liable
37  * for any damages suffered by the Licensee or any third party resulting
38  * from use of the Software.
39  */

40
41 import java.io.IOException JavaDoc;
42
43 import java.util.Properties JavaDoc;
44
45 import com.quadcap.util.collections.LongMap;
46
47 /**
48  *
49  *
50  * @author Stan Bailes
51  */

52 public interface Logger {
53     /**
54      * Initialization
55      */

56     void init(Log log, boolean create, Properties JavaDoc props) throws IOException JavaDoc;
57     
58     /**
59      * Make it so.
60      */

61     void sync() throws IOException JavaDoc;
62
63     /**
64      * Checkpoint.
65      */

66     void checkpoint() throws IOException JavaDoc;
67
68     /**
69      * Dismissed.
70      */

71     void close() throws IOException JavaDoc;
72
73     /**
74      * Reset the entire log to be empty
75      */

76     void reset() throws IOException JavaDoc;
77
78     /**
79      * Return the id of the oldest active transaction
80      */

81     long getOldestTransaction();
82
83     /**
84      * Return the number of active transactions
85      */

86     int getActiveTransactionCount();
87
88     /**
89      * Return a map containing the active transaction ids as keys
90      */

91     LongMap getActiveTransactions();
92
93     /**
94      * Write a single op to the buffer.
95      */

96     void put(LogEntry op) throws IOException JavaDoc;
97
98     /**
99      * Set the 'redo' value for the most recently read LogEntry
100      */

101     void setRedoState(LogEntry op, int state) throws IOException JavaDoc;
102
103     /**
104      * Return the last op in the log for the specified transaction
105      */

106     LogEntry getLastOp(long t) throws IOException JavaDoc;
107
108     /**
109      * Return the preceding op (of the same transaction)
110      */

111     LogEntry getPrevOp(LogEntry op) throws IOException JavaDoc;
112
113     /**
114      * Return the first op in the log
115      */

116     LogEntry getFirstOp() throws IOException JavaDoc;
117
118     /**
119      * Return the next op
120      */

121     LogEntry getNextOp() throws IOException JavaDoc;
122
123     /**
124      * Return the position of the last checkpoint
125      */

126     int getCheckpoint();
127
128     /**
129      * Return the end position of the log buffer
130      */

131     int getEnd();
132 }
133
Popular Tags