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.web.jcr.rest.spi; 025 026 import java.util.Set; 027 import javax.jcr.RepositoryException; 028 import javax.jcr.Session; 029 import javax.servlet.ServletContext; 030 import javax.servlet.http.HttpServletRequest; 031 032 /** 033 * Interface for any class that provides access to one or more local JCR repositories. 034 * <p> 035 * Repository providers must provide a public, no-argument constructor and be thread-safe. 036 * </p> 037 */ 038 public interface RepositoryProvider { 039 040 /** 041 * Returns an active session for the given workspace name in the named repository. 042 * <p> 043 * JCR implementations that do not support multiple repositories on the same server can ignore the repositoryName parameter. 044 * </p> 045 * 046 * @param request the servlet request; may not be null or unauthenticated 047 * @param repositoryName the name of the repository in which the session is created 048 * @param workspaceName the name of the workspace to which the session should be connected 049 * @return an active session with the given workspace in the named repository 050 * @throws RepositoryException if any other error occurs 051 */ 052 public Session getSession( HttpServletRequest request, 053 String repositoryName, 054 String workspaceName ) throws RepositoryException; 055 056 /** 057 * Returns the available repository names 058 * <p> 059 * JCR implementations that do not support multiple repositories on the same server should provide a singleton set containing 060 * some default repository name. 061 * </p> 062 * 063 * @return the available repository names; may not be null or empty 064 */ 065 Set<String> getJcrRepositoryNames(); 066 067 /** 068 * Signals the repository provider that it should initialize itself based on the provided {@link ServletContext servlet 069 * context} and begin accepting connections. 070 * 071 * @param context the servlet context for the REST servlet 072 */ 073 void startup( ServletContext context ); 074 075 /** 076 * Signals the repository provider that it should complete any pending transactions, shutdown, and release any external 077 * resource held. 078 */ 079 void shutdown(); 080 081 }