/
Database.java
177 lines (144 loc) · 4.19 KB
/
Database.java
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
/*
* eXist Open Source Native XML Database
* Copyright (C) 2010 The eXist Project
* http://exist-db.org
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*
* $Id$
*/
package org.exist;
import java.io.File;
import java.util.Collection;
import java.util.Observer;
import org.exist.collections.CollectionConfigurationManager;
import org.exist.collections.triggers.CollectionTrigger;
import org.exist.collections.triggers.DocumentTrigger;
import org.exist.debuggee.Debuggee;
import org.exist.dom.SymbolTable;
import org.exist.indexing.IndexManager;
import org.exist.numbering.NodeIdFactory;
import org.exist.plugin.PluginsManager;
import org.exist.scheduler.Scheduler;
import org.exist.security.AuthenticationException;
import org.exist.security.SecurityManager;
import org.exist.security.Subject;
import org.exist.storage.CacheManager;
import org.exist.storage.DBBroker;
import org.exist.storage.NotificationService;
import org.exist.storage.ProcessMonitor;
import org.exist.storage.txn.TransactionManager;
import org.exist.util.Configuration;
import org.exist.xquery.PerformanceStats;
/**
* Database controller, all operation synchronized by this instance. (singleton)
*
* @author <a href="mailto:shabanovd@gmail.com">Dmitriy Shabanov</a>
*
*/
public interface Database {
//TODO: javadocs
public String getId();
/**
*
* @return SecurityManager
*/
public SecurityManager getSecurityManager();
/**
*
* @return IndexManager
*/
public IndexManager getIndexManager();
/**
*
* @return TransactionManager
*/
public TransactionManager getTransactionManager();
/**
*
* @return CacheManager
*/
public CacheManager getCacheManager();
/**
*
* @return Scheduler
*/
public Scheduler getScheduler();
/**
*
*/
public void shutdown();
/**
*
* @return Subject
*/
public Subject getSubject();
/**
*
* @param subject
*/
public boolean setSubject(Subject subject);
public DBBroker getBroker() throws EXistException; //TODO: remove 'throws EXistException'?
public DBBroker authenticate(String username, Object credentials) throws AuthenticationException;
/*
* @Deprecated ?
* try {
* broker = database.authenticate(account, credentials);
*
* broker1 = database.get();
* broker2 = database.get();
* ...
* brokerN = database.get();
*
* } finally {
* database.release(broker);
* }
*/
public DBBroker get(Subject subject) throws EXistException;
public DBBroker getActiveBroker(); //throws EXistException;
public void release(DBBroker broker);
/**
* Returns the number of brokers currently serving requests for the database instance.
*
* @return The brokers count
*/
public int countActiveBrokers();
/**
*
* @return Debuggee
*/
public Debuggee getDebuggee();
public PerformanceStats getPerformanceStats();
//old configuration
public Configuration getConfiguration();
public NodeIdFactory getNodeFactory();
public File getStoragePlace();
public CollectionConfigurationManager getConfigurationManager();
/**
* Master document triggers.
*/
public Collection<DocumentTrigger> getDocumentTriggers();
public DocumentTrigger getDocumentTrigger();
/**
* Master Collection triggers.
*/
public Collection<CollectionTrigger> getCollectionTriggers();
public CollectionTrigger getCollectionTrigger();
public ProcessMonitor getProcessMonitor();
public boolean isReadOnly();
public NotificationService getNotificationService();
public PluginsManager getPluginsManager();
public SymbolTable getSymbols();
}