KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > db4o > ext > ExtObjectServer


1 /* Copyright (C) 2004 - 2006 db4objects Inc. http://www.db4o.com
2
3 This file is part of the db4o open source object database.
4
5 db4o is free software; you can redistribute it and/or modify it under
6 the terms of version 2 of the GNU General Public License as published
7 by the Free Software Foundation and as clarified by db4objects' GPL
8 interpretation policy, available at
9 http://www.db4o.com/about/company/legalpolicies/gplinterpretation/
10 Alternatively you can write to db4objects, Inc., 1900 S Norfolk Street,
11 Suite 350, San Mateo, CA 94403, USA.
12
13 db4o is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 for more details.
17
18 You should have received a copy of the GNU General Public License along
19 with this program; if not, write to the Free Software Foundation, Inc.,
20 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */

21 package com.db4o.ext;
22
23 import java.io.*;
24
25 import com.db4o.*;
26 import com.db4o.config.*;
27
28 /**
29  * extended functionality for the ObjectServer interface.
30  * <br><br>Every ObjectServer also always is an ExtObjectServer
31  * so a cast is possible.<br><br>
32  * {@link com.db4o.ObjectServer#ext}
33  * is a convenient method to perform the cast.<br><br>
34  * The functionality is split to two interfaces to allow newcomers to
35  * focus on the essential methods.
36  */

37 public interface ExtObjectServer extends ObjectServer{
38     
39     /**
40      * backs up the database file used by the ObjectServer.
41      * <br><br>While the backup is running, the ObjectServer can continue to be
42      * used. Changes that are made while the backup is in progress, will be applied to
43      * the open ObjectServer and to the backup.<br><br>
44      * While the backup is running, the ObjectContainer should not be closed.<br><br>
45      * If a file already exists at the specified path, it will be overwritten.<br><br>
46      * @param path a fully qualified path
47      */

48     public void backup(String JavaDoc path) throws IOException;
49
50     
51      /**
52      * returns the {@link Configuration} context for this ObjectServer.
53      * <br><br>
54      * Upon opening an ObjectServer with any of the factory methods in the
55      * {@link Db4o} class, the global {@link Configuration} context
56      * is copied into the ObjectServer. The {@link Configuration}
57      * can be modified individually for
58      * each ObjectServer without any effects on the global settings.<br><br>
59      * @return the Configuration context for this ObjectServer
60      * @see com.db4o.Db4o#configure
61      */

62     public Configuration configure();
63     
64     /**
65      * returns the ObjectContainer used by the server.
66      * <br><br>
67      * @return the ObjectContainer used by the server
68      */

69     public ObjectContainer objectContainer();
70     
71     /**
72      * removes client access permissions for the specified user.
73      * <br><br>
74      * @param userName the name of the user
75      */

76     public void revokeAccess(String JavaDoc userName);
77 }
78
Popular Tags