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.map;
25
26 import org.modeshape.graph.cache.CachePolicy;
27 import org.modeshape.graph.connector.RepositoryContext;
28 import org.modeshape.graph.connector.RepositorySource;
29
30 /**
31 * An extension of the {@link RepositorySource} class that provides a {@link CachePolicy cache policy} and a
32 * {@link RepositoryContext repository context}.
33 */
34 public interface MapRepositorySource extends RepositorySource {
35
36 /**
37 * Get whether this source allows updates.
38 *
39 * @return true if this source allows updates by clients, or false if no updates are allowed
40 * @see #setUpdatesAllowed(boolean)
41 */
42 boolean areUpdatesAllowed();
43
44 /**
45 * Set whether this source allows updates to data within workspaces
46 *
47 * @param updatesAllowed true if this source allows updates to data within workspaces clients, or false if updates are not
48 * allowed.
49 * @see #areUpdatesAllowed()
50 */
51 void setUpdatesAllowed( boolean updatesAllowed );
52
53 /**
54 * Returns the {@link CachePolicy cache policy} for the repository source
55 *
56 * @return the {@link CachePolicy cache policy} for the repository source
57 */
58 CachePolicy getDefaultCachePolicy();
59
60 /**
61 * Returns the {@link RepositoryContext repository context} for the repository source
62 *
63 * @return the {@link RepositoryContext repository context} for the repository source
64 */
65 RepositoryContext getRepositoryContext();
66
67 }