dhanji | 52ce321 | 2008-12-15 09:42:36 +0000 | [diff] [blame] | 1 | /** |
| 2 | * Copyright (C) 2008 Google Inc. |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package com.google.inject.servlet; |
| 17 | |
dhanji | 52ce321 | 2008-12-15 09:42:36 +0000 | [diff] [blame] | 18 | import com.google.inject.AbstractModule; |
| 19 | import com.google.inject.Key; |
sberlin | d9c913a | 2011-06-26 21:02:54 +0000 | [diff] [blame^] | 20 | import com.google.common.collect.Lists; |
| 21 | import com.google.common.collect.Sets; |
limpbizkit | 50581d1 | 2009-04-24 18:19:41 +0000 | [diff] [blame] | 22 | import com.google.inject.internal.UniqueAnnotations; |
dhanji | 52ce321 | 2008-12-15 09:42:36 +0000 | [diff] [blame] | 23 | import java.util.HashMap; |
| 24 | import java.util.List; |
| 25 | import java.util.Map; |
dhanji | 87dfe5b | 2009-01-07 06:49:07 +0000 | [diff] [blame] | 26 | import java.util.Set; |
dhanji | 52ce321 | 2008-12-15 09:42:36 +0000 | [diff] [blame] | 27 | import javax.servlet.http.HttpServlet; |
| 28 | |
| 29 | /** |
dhanji | 6634fe1 | 2008-12-21 11:31:25 +0000 | [diff] [blame] | 30 | * Builds the guice module that binds configured servlets, with their |
| 31 | * wrapper ServletDefinitions. Is part of the binding EDSL. Very similar to |
| 32 | * {@link com.google.inject.servlet.FiltersModuleBuilder}. |
dhanji | 52ce321 | 2008-12-15 09:42:36 +0000 | [diff] [blame] | 33 | * |
| 34 | * @author Dhanji R. Prasanna (dhanji@gmail.com) |
dhanji | 52ce321 | 2008-12-15 09:42:36 +0000 | [diff] [blame] | 35 | */ |
dhanji | 6634fe1 | 2008-12-21 11:31:25 +0000 | [diff] [blame] | 36 | class ServletsModuleBuilder extends AbstractModule { |
| 37 | private final List<ServletDefinition> servletDefinitions = Lists.newArrayList(); |
dhanji | e477c78 | 2009-10-30 13:19:19 +0000 | [diff] [blame] | 38 | private final List<ServletInstanceBindingEntry> servletInstanceEntries = Lists.newArrayList(); |
dhanji | 52ce321 | 2008-12-15 09:42:36 +0000 | [diff] [blame] | 39 | |
| 40 | //invoked on injector config |
dhanji | 6634fe1 | 2008-12-21 11:31:25 +0000 | [diff] [blame] | 41 | @Override |
dhanji | 52ce321 | 2008-12-15 09:42:36 +0000 | [diff] [blame] | 42 | protected void configure() { |
dhanji | e477c78 | 2009-10-30 13:19:19 +0000 | [diff] [blame] | 43 | // Create bindings for servlet instances |
| 44 | for (ServletInstanceBindingEntry entry : servletInstanceEntries) { |
| 45 | bind(entry.key).toInstance(entry.servlet); |
| 46 | } |
dhanji | 87dfe5b | 2009-01-07 06:49:07 +0000 | [diff] [blame] | 47 | |
| 48 | // Ensure that servlets are not bound twice to the same pattern. |
| 49 | Set<String> servletUris = Sets.newHashSet(); |
| 50 | for (ServletDefinition servletDefinition : servletDefinitions) { |
| 51 | if (servletUris.contains(servletDefinition.getPattern())) { |
| 52 | addError("More than one servlet was mapped to the same URI pattern: " |
| 53 | + servletDefinition.getPattern()); |
| 54 | } |
| 55 | else { |
sberlin | b4b7f72 | 2010-08-22 18:48:23 +0000 | [diff] [blame] | 56 | bind(Key.get(ServletDefinition.class, UniqueAnnotations.create())).toProvider(servletDefinition); |
dhanji | 87dfe5b | 2009-01-07 06:49:07 +0000 | [diff] [blame] | 57 | servletUris.add(servletDefinition.getPattern()); |
| 58 | } |
| 59 | } |
dhanji | 52ce321 | 2008-12-15 09:42:36 +0000 | [diff] [blame] | 60 | } |
| 61 | |
| 62 | //the first level of the EDSL-- |
dhanji | ae3de7d | 2008-12-24 06:39:43 +0000 | [diff] [blame] | 63 | public ServletModule.ServletKeyBindingBuilder serve(List<String> urlPatterns) { |
| 64 | return new ServletKeyBindingBuilderImpl(urlPatterns, UriPatternType.SERVLET); |
dhanji | 52ce321 | 2008-12-15 09:42:36 +0000 | [diff] [blame] | 65 | } |
| 66 | |
dhanji | ae3de7d | 2008-12-24 06:39:43 +0000 | [diff] [blame] | 67 | public ServletModule.ServletKeyBindingBuilder serveRegex(List<String> regexes) { |
| 68 | return new ServletKeyBindingBuilderImpl(regexes, UriPatternType.REGEX); |
dhanji | 52ce321 | 2008-12-15 09:42:36 +0000 | [diff] [blame] | 69 | } |
| 70 | |
dhanji | e477c78 | 2009-10-30 13:19:19 +0000 | [diff] [blame] | 71 | private static class ServletInstanceBindingEntry { |
| 72 | final Key<HttpServlet> key; |
| 73 | final HttpServlet servlet; |
| 74 | |
| 75 | ServletInstanceBindingEntry(Key<HttpServlet> key, HttpServlet servlet) { |
| 76 | this.key = key; |
| 77 | this.servlet = servlet; |
| 78 | } |
| 79 | } |
| 80 | |
dhanji | 52ce321 | 2008-12-15 09:42:36 +0000 | [diff] [blame] | 81 | //non-static inner class so it can access state of enclosing module class |
dhanji | 6634fe1 | 2008-12-21 11:31:25 +0000 | [diff] [blame] | 82 | class ServletKeyBindingBuilderImpl implements ServletModule.ServletKeyBindingBuilder { |
dhanji | ae3de7d | 2008-12-24 06:39:43 +0000 | [diff] [blame] | 83 | private final List<String> uriPatterns; |
dhanji | 52ce321 | 2008-12-15 09:42:36 +0000 | [diff] [blame] | 84 | private final UriPatternType uriPatternType; |
| 85 | |
dhanji | ae3de7d | 2008-12-24 06:39:43 +0000 | [diff] [blame] | 86 | private ServletKeyBindingBuilderImpl(List<String> uriPatterns, UriPatternType uriPatternType) { |
| 87 | this.uriPatterns = uriPatterns; |
dhanji | 52ce321 | 2008-12-15 09:42:36 +0000 | [diff] [blame] | 88 | this.uriPatternType = uriPatternType; |
| 89 | } |
| 90 | |
dhanji | 6634fe1 | 2008-12-21 11:31:25 +0000 | [diff] [blame] | 91 | public void with(Class<? extends HttpServlet> servletKey) { |
| 92 | with(Key.get(servletKey)); |
dhanji | 52ce321 | 2008-12-15 09:42:36 +0000 | [diff] [blame] | 93 | } |
| 94 | |
dhanji | 6634fe1 | 2008-12-21 11:31:25 +0000 | [diff] [blame] | 95 | public void with(Key<? extends HttpServlet> servletKey) { |
| 96 | with(servletKey, new HashMap<String, String>()); |
dhanji | 52ce321 | 2008-12-15 09:42:36 +0000 | [diff] [blame] | 97 | } |
| 98 | |
dhanji | e477c78 | 2009-10-30 13:19:19 +0000 | [diff] [blame] | 99 | public void with(HttpServlet servlet) { |
| 100 | with(servlet, new HashMap<String, String>()); |
| 101 | } |
| 102 | |
dhanji | 6634fe1 | 2008-12-21 11:31:25 +0000 | [diff] [blame] | 103 | public void with(Class<? extends HttpServlet> servletKey, |
sberlin | 99ca2d6 | 2010-08-22 23:08:21 +0000 | [diff] [blame] | 104 | Map<String, String> initParams) { |
| 105 | with(Key.get(servletKey), initParams); |
dhanji | 52ce321 | 2008-12-15 09:42:36 +0000 | [diff] [blame] | 106 | } |
| 107 | |
dhanji | 6634fe1 | 2008-12-21 11:31:25 +0000 | [diff] [blame] | 108 | public void with(Key<? extends HttpServlet> servletKey, |
sberlin | 99ca2d6 | 2010-08-22 23:08:21 +0000 | [diff] [blame] | 109 | Map<String, String> initParams) { |
| 110 | with(servletKey, initParams, null); |
sberlin | b4b7f72 | 2010-08-22 18:48:23 +0000 | [diff] [blame] | 111 | } |
| 112 | |
| 113 | private void with(Key<? extends HttpServlet> servletKey, |
sberlin | 99ca2d6 | 2010-08-22 23:08:21 +0000 | [diff] [blame] | 114 | Map<String, String> initParams, |
sberlin | b4b7f72 | 2010-08-22 18:48:23 +0000 | [diff] [blame] | 115 | HttpServlet servletInstance) { |
dhanji | ae3de7d | 2008-12-24 06:39:43 +0000 | [diff] [blame] | 116 | for (String pattern : uriPatterns) { |
| 117 | servletDefinitions.add( |
dhanji | b7ed1bb | 2008-12-30 06:32:41 +0000 | [diff] [blame] | 118 | new ServletDefinition(pattern, servletKey, UriPatternType.get(uriPatternType, pattern), |
sberlin | 99ca2d6 | 2010-08-22 23:08:21 +0000 | [diff] [blame] | 119 | initParams, servletInstance)); |
dhanji | ae3de7d | 2008-12-24 06:39:43 +0000 | [diff] [blame] | 120 | } |
dhanji | 52ce321 | 2008-12-15 09:42:36 +0000 | [diff] [blame] | 121 | } |
dhanji | e477c78 | 2009-10-30 13:19:19 +0000 | [diff] [blame] | 122 | |
| 123 | public void with(HttpServlet servlet, |
sberlin | 99ca2d6 | 2010-08-22 23:08:21 +0000 | [diff] [blame] | 124 | Map<String, String> initParams) { |
dhanji | e477c78 | 2009-10-30 13:19:19 +0000 | [diff] [blame] | 125 | Key<HttpServlet> servletKey = Key.get(HttpServlet.class, UniqueAnnotations.create()); |
| 126 | servletInstanceEntries.add(new ServletInstanceBindingEntry(servletKey, servlet)); |
sberlin | 99ca2d6 | 2010-08-22 23:08:21 +0000 | [diff] [blame] | 127 | with(servletKey, initParams, servlet); |
dhanji | e477c78 | 2009-10-30 13:19:19 +0000 | [diff] [blame] | 128 | } |
dhanji | 52ce321 | 2008-12-15 09:42:36 +0000 | [diff] [blame] | 129 | } |
sberlin | b4b7f72 | 2010-08-22 18:48:23 +0000 | [diff] [blame] | 130 | } |