01: /* Copyright (C) 2004 - 2007 db4objects Inc. http://www.db4o.com
02:
03: This file is part of the db4o open source object database.
04:
05: db4o is free software; you can redistribute it and/or modify it under
06: the terms of version 2 of the GNU General Public License as published
07: by the Free Software Foundation and as clarified by db4objects' GPL
08: interpretation policy, available at
09: 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 path) throws IOException;
49:
50: /**
51: * returns the number of connected clients.
52: */
53: public int clientCount();
54:
55: /**
56: * returns the {@link Configuration} context for this ObjectServer.
57: * <br><br>
58: * Upon opening an ObjectServer with any of the factory methods in the
59: * {@link Db4o} class, the global {@link Configuration} context
60: * is copied into the ObjectServer. The {@link Configuration}
61: * can be modified individually for
62: * each ObjectServer without any effects on the global settings.<br><br>
63: * @return the Configuration context for this ObjectServer
64: * @see com.db4o.Db4o#configure
65: */
66: public Configuration configure();
67:
68: /**
69: * returns the ObjectContainer used by the server.
70: * <br><br>
71: * @return the ObjectContainer used by the server
72: */
73: public ObjectContainer objectContainer();
74:
75: /**
76: * removes client access permissions for the specified user.
77: * <br><br>
78: * @param userName the name of the user
79: */
80: public void revokeAccess(String userName);
81:
82: /**
83: * @return The local port this server uses, 0 if disconnected or in embedded mode
84: */
85: public int port();
86: }
|