summaryrefslogtreecommitdiff
path: root/java/src/Freeze/Util.java
blob: 71ab41c00ac4c5e75596db9317c40bd5608a7f63 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
// **********************************************************************
//
// Copyright (c) 2003-2013 ZeroC, Inc. All rights reserved.
//
// This copy of Ice is licensed to you under the terms described in the
// ICE_LICENSE file included in this distribution.
//
// **********************************************************************

package Freeze;

public class Util
{
    /**
     * Returns a new background save evictor. The Berkeley DB database with the
     * name given in <code>filename</code> is opened if it already exists.
     * If the database does not exist yet and <code>createDb</code>
     * is true, the database is created automatically; otherwise,
     * <code>DatabaseException</code> is raised.
     *
     * @param adapter The object adapter to associate with this evictor.
     * @param envName The name of the Berkeley DB database environment. The
     *   environment must already exist.
     * @param filename The name of the Berkeley DB database file.
     * @param initializer An object that is used to initialize a servant after its
     *   state is restored from the database, or <code>null</code> if no initializer
     *   is necessary.
     * @param indices An array of Freeze indices, or <code>null</code if no indices
     *   are defined.
     * @param createDb True if the Berkeley DB database should be created if it does
     *   not exist, false otherwise.
     * @return A new background save evictor.
     * @throws Freeze.DatabaseException If an error occurs during database operations.
     */
    public static BackgroundSaveEvictor
    createBackgroundSaveEvictor(Ice.ObjectAdapter adapter, String envName, String filename,
                                ServantInitializer initializer, Index[] indices, boolean createDb)
    {
        return new BackgroundSaveEvictorI(adapter, envName, filename, initializer, indices, createDb);
    }

    /**
     * Returns a new background save evictor. The Berkeley DB database with the
     * name given in <code>filename</code> is opened if it already exists.
     * If the database does not exist yet and <code>createDb</code>
     * is true, the database is created automatically; otherwise,
     * <code>DatabaseException</code> is raised.
     *
     * @param adapter The object adapter to associate with this evictor.
     * @param envName The name of the Berkeley DB database environment. The
     *   environment must already exist.
     * @param dbEnv The database environment in which to open the database.
     * @param filename The name of the Berkeley DB database file.
     * @param initializer An object that is used to initialize a servant after its
     *   state is restored from the database, or <code>null</code> if no initializer
     *   is necessary.
     * @param indices An array of Freeze indices, or <code>null</code if no indices
     *   are defined.
     * @param createDb True if the Berkeley DB database should be created if it does
     *   not exist, false otherwise.
     * @return A new background save evictor.
     * @throws Freeze.DatabaseException If an error occurs during database operations.
     */
    public static BackgroundSaveEvictor
    createBackgroundSaveEvictor(Ice.ObjectAdapter adapter, String envName, com.sleepycat.db.Environment dbEnv,
                                String filename, ServantInitializer initializer, Index[] indices, boolean createDb)
    {
        return new BackgroundSaveEvictorI(adapter, envName, dbEnv, filename, initializer, indices, createDb);
    }

    /**
     * Returns a new transactional evictor. The Berkeley DB database with the
     * name given in <code>filename</code> is opened if it already exists.
     * If the database does not exist yet and <code>createDb</code>
     * is true, the database is created automatically; otherwise,
     * <code>DatabaseException</code> is raised.
     *
     * @param adapter The object adapter to associate with this evictor.
     * @param envName The name of the Berkeley DB database environment. The
     *   environment must already exist.
     * @param filename The name of the Berkeley DB database file.
     * @param facetTypes A map of facet name to Slice type id, or <code>null</code if
     *   no map is necessary.
     * @param initializer An object that is used to initialize a servant after its
     *   state is restored from the database, or <code>null</code> if no initializer
     *   is necessary.
     * @param indices An array of Freeze indices, or <code>null</code if no indices
     *   are defined.
     * @param createDb True if the Berkeley DB database should be created if it does
     *   not exist, false otherwise.
     * @return A new transactional evictor.
     * @throws Freeze.DatabaseException If an error occurs during database operations.
     */
    public static TransactionalEvictor
    createTransactionalEvictor(Ice.ObjectAdapter adapter, String envName, String filename,
                               java.util.Map<String, String> facetTypes, ServantInitializer initializer,
                               Index[] indices, boolean createDb)
    {
        return new TransactionalEvictorI(adapter, envName, filename, facetTypes, initializer, indices, createDb);
    }

    /**
     * Returns a new transactional evictor. The Berkeley DB database with the
     * name given in <code>filename</code> is opened if it already exists.
     * If the database does not exist yet and <code>createDb</code>
     * is true, the database is created automatically; otherwise,
     * <code>DatabaseException</code> is raised.
     *
     * @param adapter The object adapter to associate with this evictor.
     * @param envName The name of the Berkeley DB database environment. The
     *   environment must already exist.
     * @param dbEnv The database environment in which to open the database.
     * @param filename The name of the Berkeley DB database file.
     * @param facetTypes A map of facet name to Slice type id, or <code>null</code if
     *   no map is necessary.
     * @param initializer An object that is used to initialize a servant after its
     *   state is restored from the database, or <code>null</code> if no initializer
     *   is necessary.
     * @param indices An array of Freeze indices, or <code>null</code if no indices
     *   are defined.
     * @param createDb True if the Berkeley DB database should be created if it does
     *   not exist, false otherwise.
     * @return A new transactional evictor.
     * @throws Freeze.DatabaseException If an error occurs during database operations.
     */
    public static TransactionalEvictor
    createTransactionalEvictor(Ice.ObjectAdapter adapter, String envName, com.sleepycat.db.Environment dbEnv,
                               String filename, java.util.Map<String, String> facetTypes,
                               ServantInitializer initializer, Index[] indices, boolean createDb)
    {
        return new TransactionalEvictorI(adapter, envName, dbEnv, filename, facetTypes, initializer, indices, createDb);
    }

    /**
     * Creates a new Freeze connection using the given communicator and database
     * environment.
     *
     * @param communicator The communicator associated with this connection.
     * @param envName The name of the Berkeley DB database environment.
     * @return A new Freeze connection.
     * @throws Freeze.DatabaseException If an error occurs during database operations.
     */
    public static Connection
    createConnection(Ice.Communicator communicator, String envName)
    {
        return new ConnectionI(communicator, envName, null);
    }

    /**
     * Creates a new Freeze connection using the given communicator and database
     * environment.
     *
     * @param communicator The communicator associated with this connection.
     * @param envName The name of the Berkeley DB database environment.
     * @param dbEnv The database environment associated with this connection.
     * @return A new Freeze connection.
     * @throws Freeze.DatabaseException If an error occurs during database operations.
     */
    public static Connection
    createConnection(Ice.Communicator communicator, String envName, com.sleepycat.db.Environment dbEnv)
    {
        return new ConnectionI(communicator, envName, dbEnv);
    }

    /**
     * Returns the database file name of the Freeze catalog.
     *
     * @return The database file name.
     */
    public static String
    catalogName()
    {
        return _catalogName;
    }

    /**
     * Returns the database file name of the Freeze catalog index list.
     *
     * @return The database file name.
     */
    public static String
    catalogIndexListName()
    {
        return _catalogIndexListName;
    }

    /**
     * Returns the Berkeley DB transaction object associated with a Freeze transaction.
     *
     * @param tx The Freeze transaction.
     * @return The Berkeley DB transaction.
     */
    public static com.sleepycat.db.Transaction
    getTxn(Transaction tx)
    {
        try
        {
            return ((TransactionI)tx).dbTxn();
        }
        catch(ClassCastException e)
        {
            return null;
        }
    }

    /**
     * Registers a handler for fatal errors encountered by the background save evictor.
     *
     * @param cb The error callback.
     */
    public static synchronized FatalErrorCallback
    registerFatalErrorCallback(FatalErrorCallback cb)
    {
        FatalErrorCallback result = _fatalErrorCallback;
        _fatalErrorCallback = cb;
        return result;
    }

    static synchronized void
    handleFatalError(BackgroundSaveEvictor evictor, Ice.Communicator communicator, RuntimeException ex)
    {
        if(_fatalErrorCallback != null)
        {
            _fatalErrorCallback.handleError(evictor, communicator, ex);
        }
        else
        {
            communicator.getLogger().error("*** Halting JVM ***");
            Runtime.getRuntime().halt(1);
        }
    }

    private static String _catalogName = "__catalog";
    private static String _catalogIndexListName = "__catalogIndexList";
    private static FatalErrorCallback _fatalErrorCallback = null;
}