01: /*
02: * Copyright 2004 Outerthought bvba and Schaubroeck nv
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: */
16: package org.outerj.daisy.repository;
17:
18: /**
19: * A RepositoryManager is the place to get {@link Repository} instances from.
20: *
21: * <p>A RepositoryManager represents one 'physical' repository (one database).
22: * All Repository instances retrieved from one RepositoryManager thus represent
23: * the same repository, the difference between the instances is they are
24: * authenticated for different users.
25: *
26: * <p>To communicate remotely with the repository (in other words, to use the remote
27: * repository API implementation), simply instantiate a "RemoteRepositoryManager", as follows:
28: *
29: * <pre>
30: * import org.outerj.daisy.repository.clientimpl.RemoteRepositoryManager;
31: * ...
32: * RepositoryManager repositoryManager = new RemoteRepositoryManager(
33: * "http://localhost:9263", new Credentials("guest", "guest"));
34: * </pre>
35: *
36: * <p>More extensive getting-started documentation on this is included in the Daisy
37: * documentation.
38: */
39: public interface RepositoryManager {
40: /**
41: *
42: * @throws AuthenticationFailedException if login failed because of incorrect credentials
43: */
44: Repository getRepository(Credentials credentials)
45: throws RepositoryException;
46:
47: String getRepositoryServerVersion();
48: }
|