001 /* 002 * JBoss DNA (http://www.jboss.org/dna) 003 * See the COPYRIGHT.txt file distributed with this work for information 004 * regarding copyright ownership. Some portions may be licensed 005 * to Red Hat, Inc. under one or more contributor license agreements. 006 * See the AUTHORS.txt file in the distribution for a full listing of 007 * individual contributors. 008 * 009 * JBoss DNA is free software. Unless otherwise indicated, all code in JBoss DNA 010 * is licensed to you under the terms of the GNU Lesser General Public License as 011 * published by the Free Software Foundation; either version 2.1 of 012 * the License, or (at your option) any later version. 013 * 014 * JBoss DNA is distributed in the hope that it will be useful, 015 * but WITHOUT ANY WARRANTY; without even the implied warranty of 016 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 017 * Lesser General Public License for more details. 018 * 019 * You should have received a copy of the GNU Lesser General Public 020 * License along with this software; if not, write to the Free 021 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 022 * 02110-1301 USA, or see the FSF site: http://www.fsf.org. 023 */ 024 package org.jboss.dna.graph.connector; 025 026 import org.jboss.dna.graph.ExecutionContext; 027 import org.jboss.dna.graph.Subgraph; 028 import org.jboss.dna.graph.observe.Observer; 029 030 /** 031 * The context for a repository. This interface need not be implemented by a {@link RepositorySource}, as it is normally provided 032 * to the source when {@link RepositorySource#initialize(RepositoryContext) initialized}. 033 * 034 * @author Randall Hauch 035 */ 036 public interface RepositoryContext { 037 038 /** 039 * Get the execution context, which can be used to create other contexts with specific JAAS security contexts. 040 * 041 * @return the execution context; never null 042 */ 043 ExecutionContext getExecutionContext(); 044 045 /** 046 * Get the factory for {@link RepositoryConnection connections} to other sources. 047 * 048 * @return the connection factory 049 */ 050 RepositoryConnectionFactory getRepositoryConnectionFactory(); 051 052 /** 053 * Get the observer that the connector may use to publish changes. 054 * 055 * @return the observer, or null if the are no listeners and publishing is not required/requested 056 */ 057 Observer getObserver(); 058 059 /** 060 * Get a snapshot of the current configuration for the {@link RepositorySource}. The root of the subgraph will be the node in 061 * the configuration that represents the RepositorySource. 062 * 063 * @param depth the max depth of the configuration subgraph 064 * @return the configuration snapshot as a subgraph, or null if there is no configuration 065 */ 066 Subgraph getConfiguration( int depth ); 067 }