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;
22:
23: import com.db4o.config.Configuration;
24: import com.db4o.ext.*;
25:
26: /**
27: * the db4o server interface.
28: * <br><br>- db4o servers can be opened with {@link Db4o#openServer(String, int)}.<br>
29: * - Direct in-memory connections to servers can be made with {@link #openClient()} <br>
30: * - TCP connections are available through {@link Db4o#openClient(String, int, String, String)}.
31: * <br><br>Before connecting clients over TCP, you have to
32: * {@link #grantAccess(String, String)} to the username and password combination
33: * that you want to use.
34: * @see Db4o#openServer(java.lang.String, int) Db4o.openServer
35: * @see ExtObjectServer ExtObjectServer for extended functionality
36: */
37: public interface ObjectServer {
38:
39: /**
40: * closes the {@link ObjectServer } and writes all cached data.
41: * <br><br>
42: * @return true - denotes that the last instance connected to the
43: * used database file was closed.
44: */
45: public boolean close();
46:
47: /**
48: * returns an {@link ObjectServer } with extended functionality.
49: * <br><br>Use this method as a convenient accessor to extended methods.
50: * Every {@link ObjectServer } can be casted to an {@link com.db4o.ext.ExtObjectServer}.
51: * <br><br>The functionality is split to two interfaces to allow newcomers to
52: * focus on the essential methods.
53: */
54: public ExtObjectServer ext();
55:
56: /**
57: * grants client access to the specified user with the specified password.
58: * <br><br>If the user already exists, the password is changed to
59: * the specified password.<br><br>
60: * @param userName the name of the user
61: * @param password the password to be used
62: */
63: public void grantAccess(String userName, String password);
64:
65: /**
66: * opens a client against this server.
67: *
68: * <br><br>A client opened with this method operates within the same VM
69: * as the server. Since an embedded client can use direct communication, without
70: * an in-between socket connection, performance will be better than a client
71: * opened with
72: * {@link Db4o#openClient(java.lang.String, int, java.lang.String, java.lang.String)}
73: *
74: * <br><br>Every client has it's own transaction and uses it's own cache
75: * for it's own version of all peristent objects.
76: *
77: */
78: public ObjectContainer openClient();
79:
80: /**
81: * See {@link #openClient()}
82: *
83: * @param config a custom {@link Configuration Configuration} instance to be obtained via {@link Db4o#newConfiguration()}
84: * @return an open {@link ObjectContainer ObjectContainer}
85: */
86: public ObjectContainer openClient(Configuration config);
87:
88: }
|