use checkedprovider for repository injection

This commit is contained in:
Sebastian Sdorra
2011-12-11 17:12:09 +01:00
parent b8181916ff
commit ea085d395d
12 changed files with 116 additions and 31 deletions

View File

@@ -15,6 +15,8 @@
<name>scm-core</name> <name>scm-core</name>
<dependencies> <dependencies>
<!-- servlet api -->
<dependency> <dependency>
<groupId>javax.servlet</groupId> <groupId>javax.servlet</groupId>
@@ -22,12 +24,16 @@
<version>${servlet.version}</version> <version>${servlet.version}</version>
<scope>provided</scope> <scope>provided</scope>
</dependency> </dependency>
<!-- logging -->
<dependency> <dependency>
<artifactId>slf4j-api</artifactId> <artifactId>slf4j-api</artifactId>
<groupId>org.slf4j</groupId> <groupId>org.slf4j</groupId>
<version>${slf4j.version}</version> <version>${slf4j.version}</version>
</dependency> </dependency>
<!-- injection -->
<dependency> <dependency>
<groupId>com.google.inject</groupId> <groupId>com.google.inject</groupId>
@@ -46,6 +52,14 @@
<artifactId>guice-servlet</artifactId> <artifactId>guice-servlet</artifactId>
<version>${guice.version}</version> <version>${guice.version}</version>
</dependency> </dependency>
<dependency>
<groupId>com.google.inject.extensions</groupId>
<artifactId>guice-throwingproviders</artifactId>
<version>${guice.version}</version>
</dependency>
<!-- rest api -->
<dependency> <dependency>
<groupId>com.sun.jersey</groupId> <groupId>com.sun.jersey</groupId>

View File

@@ -0,0 +1,60 @@
/**
* Copyright (c) 2010, Sebastian Sdorra
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* 3. Neither the name of SCM-Manager; nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* http://bitbucket.org/sdorra/scm-manager
*
*/
package sonia.scm.repository;
//~--- non-JDK imports --------------------------------------------------------
import com.google.inject.throwingproviders.CheckedProvider;
import sonia.scm.security.ScmSecurityException;
/**
*
* @author Sebastian Sdorra
* @since 1.10
*/
public interface RepositoryProvider extends CheckedProvider<Repository>
{
/**
* Method description
*
*
* @return
*
* @throws ScmSecurityException
*/
@Override
public Repository get() throws ScmSecurityException;
}

View File

@@ -38,6 +38,7 @@ package sonia.scm.web.filter;
import com.google.inject.Provider; import com.google.inject.Provider;
import sonia.scm.repository.Repository; import sonia.scm.repository.Repository;
import sonia.scm.repository.RepositoryProvider;
import sonia.scm.web.security.WebSecurityContext; import sonia.scm.web.security.WebSecurityContext;
//~--- JDK imports ------------------------------------------------------------ //~--- JDK imports ------------------------------------------------------------
@@ -61,7 +62,7 @@ public abstract class ProviderPermissionFilter extends PermissionFilter
*/ */
public ProviderPermissionFilter( public ProviderPermissionFilter(
Provider<WebSecurityContext> securityContextProvider, Provider<WebSecurityContext> securityContextProvider,
Provider<Repository> repositoryProvider) RepositoryProvider repositoryProvider)
{ {
super(securityContextProvider); super(securityContextProvider);
this.repositoryProvider = repositoryProvider; this.repositoryProvider = repositoryProvider;
@@ -86,5 +87,5 @@ public abstract class ProviderPermissionFilter extends PermissionFilter
//~--- fields --------------------------------------------------------------- //~--- fields ---------------------------------------------------------------
/** Field description */ /** Field description */
private Provider<Repository> repositoryProvider; private RepositoryProvider repositoryProvider;
} }

View File

@@ -39,7 +39,7 @@ import com.google.inject.Inject;
import com.google.inject.Provider; import com.google.inject.Provider;
import com.google.inject.Singleton; import com.google.inject.Singleton;
import sonia.scm.repository.Repository; import sonia.scm.repository.RepositoryProvider;
import sonia.scm.web.filter.ProviderPermissionFilter; import sonia.scm.web.filter.ProviderPermissionFilter;
import sonia.scm.web.security.WebSecurityContext; import sonia.scm.web.security.WebSecurityContext;
@@ -80,7 +80,7 @@ public class GitPermissionFilter extends ProviderPermissionFilter
@Inject @Inject
public GitPermissionFilter( public GitPermissionFilter(
Provider<WebSecurityContext> securityContextProvider, Provider<WebSecurityContext> securityContextProvider,
Provider<Repository> repositoryProvider) RepositoryProvider repositoryProvider)
{ {
super(securityContextProvider, repositoryProvider); super(securityContextProvider, repositoryProvider);
} }

View File

@@ -36,7 +36,6 @@ package sonia.scm.web;
//~--- non-JDK imports -------------------------------------------------------- //~--- non-JDK imports --------------------------------------------------------
import com.google.inject.Inject; import com.google.inject.Inject;
import com.google.inject.Provider;
import com.google.inject.Singleton; import com.google.inject.Singleton;
import sonia.scm.config.ScmConfiguration; import sonia.scm.config.ScmConfiguration;
@@ -44,7 +43,7 @@ import sonia.scm.repository.HgConfig;
import sonia.scm.repository.HgHookManager; import sonia.scm.repository.HgHookManager;
import sonia.scm.repository.HgRepositoryHandler; import sonia.scm.repository.HgRepositoryHandler;
import sonia.scm.repository.Repository; import sonia.scm.repository.Repository;
import sonia.scm.repository.RepositoryManager; import sonia.scm.repository.RepositoryProvider;
import sonia.scm.util.AssertUtil; import sonia.scm.util.AssertUtil;
import sonia.scm.web.cgi.CGIExecutor; import sonia.scm.web.cgi.CGIExecutor;
import sonia.scm.web.cgi.CGIExecutorFactory; import sonia.scm.web.cgi.CGIExecutorFactory;
@@ -109,7 +108,7 @@ public class HgCGIServlet extends HttpServlet
@Inject @Inject
public HgCGIServlet(CGIExecutorFactory cgiExecutorFactory, public HgCGIServlet(CGIExecutorFactory cgiExecutorFactory,
ScmConfiguration configuration, ScmConfiguration configuration,
Provider<Repository> repositoryProvider, RepositoryProvider repositoryProvider,
HgRepositoryHandler handler, HgHookManager hookManager) HgRepositoryHandler handler, HgHookManager hookManager)
{ {
this.cgiExecutorFactory = cgiExecutorFactory; this.cgiExecutorFactory = cgiExecutorFactory;
@@ -262,5 +261,5 @@ public class HgCGIServlet extends HttpServlet
private HgHookManager hookManager; private HgHookManager hookManager;
/** Field description */ /** Field description */
private Provider<Repository> repositoryProvider; private RepositoryProvider repositoryProvider;
} }

View File

@@ -39,7 +39,7 @@ import com.google.inject.Inject;
import com.google.inject.Provider; import com.google.inject.Provider;
import com.google.inject.Singleton; import com.google.inject.Singleton;
import sonia.scm.repository.Repository; import sonia.scm.repository.RepositoryProvider;
import sonia.scm.web.filter.ProviderPermissionFilter; import sonia.scm.web.filter.ProviderPermissionFilter;
import sonia.scm.web.security.WebSecurityContext; import sonia.scm.web.security.WebSecurityContext;
@@ -65,7 +65,7 @@ public class HgPermissionFilter extends ProviderPermissionFilter
@Inject @Inject
public HgPermissionFilter( public HgPermissionFilter(
Provider<WebSecurityContext> securityContextProvider, Provider<WebSecurityContext> securityContextProvider,
Provider<Repository> repositoryProvider) RepositoryProvider repositoryProvider)
{ {
super(securityContextProvider, repositoryProvider); super(securityContextProvider, repositoryProvider);
} }

View File

@@ -35,12 +35,11 @@ package sonia.scm.web;
//~--- non-JDK imports -------------------------------------------------------- //~--- non-JDK imports --------------------------------------------------------
import com.google.inject.Provider;
import org.tmatesoft.svn.core.internal.server.dav.DAVConfig; import org.tmatesoft.svn.core.internal.server.dav.DAVConfig;
import org.tmatesoft.svn.core.internal.server.dav.SVNPathBasedAccess; import org.tmatesoft.svn.core.internal.server.dav.SVNPathBasedAccess;
import sonia.scm.repository.Repository; import sonia.scm.repository.Repository;
import sonia.scm.repository.RepositoryProvider;
import sonia.scm.repository.SvnRepositoryHandler; import sonia.scm.repository.SvnRepositoryHandler;
//~--- JDK imports ------------------------------------------------------------ //~--- JDK imports ------------------------------------------------------------
@@ -63,7 +62,7 @@ public class SvnDAVConfig extends DAVConfig
* @param repositoryProvider * @param repositoryProvider
*/ */
public SvnDAVConfig(DAVConfig davConfig, SvnRepositoryHandler handler, public SvnDAVConfig(DAVConfig davConfig, SvnRepositoryHandler handler,
Provider<Repository> repositoryProvider) RepositoryProvider repositoryProvider)
{ {
this.davConfig = davConfig; this.davConfig = davConfig;
this.handler = handler; this.handler = handler;
@@ -292,5 +291,5 @@ public class SvnDAVConfig extends DAVConfig
private SvnRepositoryHandler handler; private SvnRepositoryHandler handler;
/** Field description */ /** Field description */
private Provider<Repository> repositoryProvider; private RepositoryProvider repositoryProvider;
} }

View File

@@ -36,17 +36,16 @@ package sonia.scm.web;
//~--- non-JDK imports -------------------------------------------------------- //~--- non-JDK imports --------------------------------------------------------
import com.google.inject.Inject; import com.google.inject.Inject;
import com.google.inject.Provider;
import com.google.inject.Singleton; import com.google.inject.Singleton;
import org.tmatesoft.svn.core.internal.server.dav.DAVConfig; import org.tmatesoft.svn.core.internal.server.dav.DAVConfig;
import org.tmatesoft.svn.core.internal.server.dav.DAVServlet; import org.tmatesoft.svn.core.internal.server.dav.DAVServlet;
import sonia.scm.repository.Repository; import sonia.scm.repository.Repository;
import sonia.scm.repository.RepositoryProvider;
import sonia.scm.repository.SvnRepositoryHandler; import sonia.scm.repository.SvnRepositoryHandler;
import sonia.scm.util.AssertUtil; import sonia.scm.util.AssertUtil;
import sonia.scm.util.HttpUtil; import sonia.scm.util.HttpUtil;
import sonia.scm.util.IOUtil;
//~--- JDK imports ------------------------------------------------------------ //~--- JDK imports ------------------------------------------------------------
@@ -79,7 +78,7 @@ public class SvnDAVServlet extends DAVServlet
*/ */
@Inject @Inject
public SvnDAVServlet(SvnRepositoryHandler handler, public SvnDAVServlet(SvnRepositoryHandler handler,
Provider<Repository> repositoryProvider) RepositoryProvider repositoryProvider)
{ {
this.handler = handler; this.handler = handler;
this.repositoryProvider = repositoryProvider; this.repositoryProvider = repositoryProvider;
@@ -140,7 +139,7 @@ public class SvnDAVServlet extends DAVServlet
* @param repositoryProvider * @param repositoryProvider
*/ */
public SvnHttpServletRequestWrapper(HttpServletRequest request, public SvnHttpServletRequestWrapper(HttpServletRequest request,
Provider<Repository> repositoryProvider) RepositoryProvider repositoryProvider)
{ {
super(request); super(request);
this.repositoryProvider = repositoryProvider; this.repositoryProvider = repositoryProvider;
@@ -204,7 +203,7 @@ public class SvnDAVServlet extends DAVServlet
//~--- fields ------------------------------------------------------------- //~--- fields -------------------------------------------------------------
/** Field description */ /** Field description */
private Provider<Repository> repositoryProvider; private RepositoryProvider repositoryProvider;
} }
@@ -214,5 +213,5 @@ public class SvnDAVServlet extends DAVServlet
private SvnRepositoryHandler handler; private SvnRepositoryHandler handler;
/** Field description */ /** Field description */
private Provider<Repository> repositoryProvider; private RepositoryProvider repositoryProvider;
} }

View File

@@ -39,7 +39,7 @@ import com.google.inject.Inject;
import com.google.inject.Provider; import com.google.inject.Provider;
import com.google.inject.Singleton; import com.google.inject.Singleton;
import sonia.scm.repository.Repository; import sonia.scm.repository.RepositoryProvider;
import sonia.scm.web.filter.ProviderPermissionFilter; import sonia.scm.web.filter.ProviderPermissionFilter;
import sonia.scm.web.security.WebSecurityContext; import sonia.scm.web.security.WebSecurityContext;
@@ -78,7 +78,7 @@ public class SvnPermissionFilter extends ProviderPermissionFilter
@Inject @Inject
public SvnPermissionFilter( public SvnPermissionFilter(
Provider<WebSecurityContext> securityContextProvider, Provider<WebSecurityContext> securityContextProvider,
Provider<Repository> repository) RepositoryProvider repository)
{ {
super(securityContextProvider, repository); super(securityContextProvider, repository);
} }

View File

@@ -36,7 +36,9 @@ package sonia.scm;
//~--- non-JDK imports -------------------------------------------------------- //~--- non-JDK imports --------------------------------------------------------
import com.google.inject.name.Names; import com.google.inject.name.Names;
import com.google.inject.servlet.RequestScoped;
import com.google.inject.servlet.ServletModule; import com.google.inject.servlet.ServletModule;
import com.google.inject.throwingproviders.ThrowingProviderBinder;
import org.slf4j.Logger; import org.slf4j.Logger;
import org.slf4j.LoggerFactory; import org.slf4j.LoggerFactory;
@@ -61,6 +63,7 @@ import sonia.scm.plugin.PluginLoader;
import sonia.scm.plugin.PluginManager; import sonia.scm.plugin.PluginManager;
import sonia.scm.plugin.ScriptResourceServlet; import sonia.scm.plugin.ScriptResourceServlet;
import sonia.scm.repository.ChangesetViewerUtil; import sonia.scm.repository.ChangesetViewerUtil;
import sonia.scm.repository.DefaultRepositoryProvider;
import sonia.scm.repository.Repository; import sonia.scm.repository.Repository;
import sonia.scm.repository.RepositoryBrowserUtil; import sonia.scm.repository.RepositoryBrowserUtil;
import sonia.scm.repository.RepositoryManager; import sonia.scm.repository.RepositoryManager;
@@ -198,6 +201,8 @@ public class ScmServletModule extends ServletModule
@Override @Override
protected void configureServlets() protected void configureServlets()
{ {
install(ThrowingProviderBinder.forModule(this));
SCMContextProvider context = SCMContext.getContext(); SCMContextProvider context = SCMContext.getContext();
bind(SCMContextProvider.class).toInstance(context); bind(SCMContextProvider.class).toInstance(context);
@@ -205,7 +210,12 @@ public class ScmServletModule extends ServletModule
ScmConfiguration config = getScmConfiguration(context); ScmConfiguration config = getScmConfiguration(context);
CipherUtil cu = CipherUtil.getInstance(); CipherUtil cu = CipherUtil.getInstance();
bind(Repository.class).toProvider(RepositoryProvider.class); // bind repository provider
ThrowingProviderBinder.create(binder()).bind(
RepositoryProvider.class, Repository.class).to(
DefaultRepositoryProvider.class).in(RequestScoped.class);
// bind core
bind(StoreFactory.class).to(JAXBStoreFactory.class); bind(StoreFactory.class).to(JAXBStoreFactory.class);
bind(ScmConfiguration.class).toInstance(config); bind(ScmConfiguration.class).toInstance(config);
bind(PluginLoader.class).toInstance(pluginLoader); bind(PluginLoader.class).toInstance(pluginLoader);

View File

@@ -39,6 +39,8 @@ import com.google.inject.Inject;
import com.google.inject.Provider; import com.google.inject.Provider;
import com.google.inject.servlet.RequestScoped; import com.google.inject.servlet.RequestScoped;
import sonia.scm.security.ScmSecurityException;
//~--- JDK imports ------------------------------------------------------------ //~--- JDK imports ------------------------------------------------------------
import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletRequest;
@@ -48,7 +50,7 @@ import javax.servlet.http.HttpServletRequest;
* @author Sebastian Sdorra * @author Sebastian Sdorra
*/ */
@RequestScoped @RequestScoped
public class RepositoryProvider implements Provider<Repository> public class DefaultRepositoryProvider implements RepositoryProvider
{ {
/** Field description */ /** Field description */
@@ -64,8 +66,9 @@ public class RepositoryProvider implements Provider<Repository>
* @param manager * @param manager
*/ */
@Inject @Inject
public RepositoryProvider(Provider<HttpServletRequest> requestProvider, public DefaultRepositoryProvider(
RepositoryManager manager) Provider<HttpServletRequest> requestProvider,
RepositoryManager manager)
{ {
this.requestProvider = requestProvider; this.requestProvider = requestProvider;
this.manager = manager; this.manager = manager;
@@ -78,9 +81,11 @@ public class RepositoryProvider implements Provider<Repository>
* *
* *
* @return * @return
*
* @throws ScmSecurityException
*/ */
@Override @Override
public Repository get() public Repository get() throws ScmSecurityException
{ {
Repository repository = null; Repository repository = null;
HttpServletRequest request = requestProvider.get(); HttpServletRequest request = requestProvider.get();

View File

@@ -669,10 +669,8 @@ public class XmlRepositoryManager extends AbstractRepositoryManager
{ {
if (type.equals(r.getType()) && isNameMatching(r, uri)) if (type.equals(r.getType()) && isNameMatching(r, uri))
{ {
if (isReader(r)) assertIsReader(r);
{ repository = r.clone();
repository = r.clone();
}
break; break;
} }