1 /*
2 * ModeShape (http://www.modeshape.org)
3 * See the COPYRIGHT.txt file distributed with this work for information
4 * regarding copyright ownership. Some portions may be licensed
5 * to Red Hat, Inc. under one or more contributor license agreements.
6 * See the AUTHORS.txt file in the distribution for a full listing of
7 * individual contributors.
8 *
9 * ModeShape is free software. Unless otherwise indicated, all code in ModeShape
10 * is licensed to you under the terms of the GNU Lesser General Public License as
11 * published by the Free Software Foundation; either version 2.1 of
12 * the License, or (at your option) any later version.
13 *
14 * ModeShape is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
18 *
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this software; if not, write to the Free
21 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
23 */
24 package org.modeshape.graph.connector;
25
26 import net.jcip.annotations.ThreadSafe;
27 import org.modeshape.graph.ExecutionContext;
28 import org.modeshape.graph.Subgraph;
29 import org.modeshape.graph.observe.Observer;
30
31 /**
32 * The context for a repository. This interface need not be implemented by a {@link RepositorySource}, as it is normally provided
33 * to the source when {@link RepositorySource#initialize(RepositoryContext) initialized}.
34 */
35 @ThreadSafe
36 public interface RepositoryContext {
37
38 /**
39 * Get the execution context, which can be used to create other contexts with specific JAAS security contexts.
40 *
41 * @return the execution context; never null
42 */
43 ExecutionContext getExecutionContext();
44
45 /**
46 * Get the factory for {@link RepositoryConnection connections} to other sources.
47 *
48 * @return the connection factory
49 */
50 RepositoryConnectionFactory getRepositoryConnectionFactory();
51
52 /**
53 * Get the observer that the connector may use to publish changes.
54 *
55 * @return the observer, or null if the are no listeners and publishing is not required/requested
56 */
57 Observer getObserver();
58
59 /**
60 * Get a snapshot of the current configuration for the {@link RepositorySource}. The root of the subgraph will be the node in
61 * the configuration that represents the RepositorySource.
62 *
63 * @param depth the max depth of the configuration subgraph
64 * @return the configuration snapshot as a subgraph, or null if there is no configuration
65 */
66 Subgraph getConfiguration( int depth );
67 }