Merge pull request #850 from GoogleCloudPlatform/endpoints-guice

[Endpoints] Update Endpoints + Guice sample
GoogleCloudPlatform · Sep 12, 2017 · e0ffe50 · e0ffe50
2 parents 86c64d7 + 52bb096
commit e0ffe50
Show file tree

Hide file tree

Showing 7 changed files with 56 additions and 75 deletions.
diff --git a/appengine-java8/endpoints-v2-guice/README.md b/appengine-java8/endpoints-v2-guice/README.md
@@ -17,7 +17,8 @@ To add the project ID:
 0. For `<endpoints.project.id>`, replace the value `YOUR_PROJECT_ID` with
 your project ID.
 
-0. Edit the file `src/main/java/com/example/echo/Echo.java`.
+0. Edit the file `src/main/java/com/example/echo/Echo.java` and
+   `src/main/java/com/example/echo/EchoEndpointModule.java`.
 
 0. Replace the value `YOUR-PROJECT-ID` with your project ID.
 
@@ -82,7 +83,8 @@ You will get a 200 response with the following data:
 0. For `def projectId = 'YOUR_PROJECT_ID'`, replace the value `YOUR_PROJECT_ID`
 with your project ID.
 
-0. Edit the file `src/main/java/com/example/echo/Echo.java
+0. Edit the file `src/main/java/com/example/echo/Echo.java` and
+   `src/main/java/com/example/echo/EchoEndpointModule.java`.
 
 0. Replace the value `YOUR-PROJECT-ID` with your project ID.
 

diff --git a/appengine-java8/endpoints-v2-guice/src/main/java/com/example/echo/EchoEndpointModule.java b/appengine-java8/endpoints-v2-guice/src/main/java/com/example/echo/EchoEndpointModule.java
@@ -16,13 +16,32 @@
 
 package com.example.echo;
 
+import com.google.api.control.ServiceManagementConfigFilter;
+import com.google.api.control.extensions.appengine.GoogleAppEngineControlFilter;
+import com.google.api.server.spi.EndpointsServlet;
 import com.google.api.server.spi.guice.EndpointsModule;
 import com.google.common.collect.ImmutableList;
+import com.google.inject.servlet.GuiceFilter;
+import java.util.HashMap;
+import java.util.Map;
+import javax.inject.Singleton;
 
 // [START endpoints_module]
 public class EchoEndpointModule extends EndpointsModule {
   @Override
   public void configureServlets() {
+    super.configureServlets();
+
+    bind(ServiceManagementConfigFilter.class).in(Singleton.class);
+    filter("/_ah/api/*").through(ServiceManagementConfigFilter.class);
+
+    Map<String, String> apiController = new HashMap<String, String>();
+    apiController.put("endpoints.projectId", "YOUR-PROJECT-ID");
+    apiController.put("endpoints.serviceName", "YOUR-PROJECT-ID.appspot.com");
+
+    bind(GoogleAppEngineControlFilter.class).in(Singleton.class);
+    filter("/_ah/api/*").through(GoogleAppEngineControlFilter.class, apiController);
+
     bind(Echo.class).toInstance(new Echo());
     configureEndpoints("/_ah/api/*", ImmutableList.of(Echo.class));
   }

diff --git a/appengine-java8/endpoints-v2-guice/src/main/webapp/WEB-INF/web.xml b/appengine-java8/endpoints-v2-guice/src/main/webapp/WEB-INF/web.xml
@@ -22,6 +22,11 @@
         <filter-class>com.google.inject.servlet.GuiceFilter</filter-class>
     </filter>
 
+    <!--
+      URL Pattern /_ah/api/* instead of /* because a legacy v1 servlet uses
+      the route /_ah/api/ and using /* will erronously use the legacy v1
+      servlet instead of routing to your API.
+    -->
     <filter-mapping>
         <filter-name>guiceFilter</filter-name>
         <url-pattern>/_ah/api/*</url-pattern>
@@ -35,33 +40,4 @@
         <welcome-file>index.html</welcome-file>
     </welcome-file-list>
 
-    <!-- Add a filter that fetches the service config from service management. -->
-    <filter>
-        <filter-name>endpoints-api-configuration</filter-name>
-        <filter-class>com.google.api.control.ServiceManagementConfigFilter</filter-class>
-    </filter>
-
-    <!-- Add a filter that performs Endpoints logging and monitoring. -->
-    <filter>
-        <filter-name>endpoints-api-controller</filter-name>
-        <filter-class>com.google.api.control.extensions.appengine.GoogleAppEngineControlFilter</filter-class>
-        <init-param>
-            <param-name>endpoints.projectId</param-name>
-            <param-value>${endpoints.project.id}</param-value>
-        </init-param>
-        <init-param>
-            <param-name>endpoints.serviceName</param-name>
-            <param-value>${endpoints.project.id}.appspot.com</param-value>
-        </init-param>
-    </filter>
-
-    <filter-mapping>
-        <filter-name>endpoints-api-configuration</filter-name>
-        <servlet-name>EndpointsServlet</servlet-name>
-    </filter-mapping>
-
-    <filter-mapping>
-        <filter-name>endpoints-api-controller</filter-name>
-        <servlet-name>EndpointsServlet</servlet-name>
-    </filter-mapping>
 </web-app>
diff --git a/appengine/endpoints-frameworks-v2/guice-example/README.md b/appengine/endpoints-frameworks-v2/guice-example/README.md
@@ -17,7 +17,8 @@ To add the project ID:
 0. For `<endpoints.project.id>`, replace the value `YOUR_PROJECT_ID` with
 your project ID.
 
-0. Edit the file `src/main/java/com/example/echo/Echo.java`.
+0. Edit the file `src/main/java/com/example/echo/Echo.java` and
+   `src/main/java/com/example/echo/EchoEndpointModule.java`.
 
 0. Replace the value `YOUR-PROJECT-ID` with your project ID.
 
@@ -82,7 +83,8 @@ You will get a 200 response with the following data:
 0. For `def projectId = 'YOUR_PROJECT_ID'`, replace the value `YOUR_PROJECT_ID`
 with your project ID.
 
-0. Edit the file `src/main/java/com/example/echo/Echo.java
+0. Edit the file `src/main/java/com/example/echo/Echo.java` and
+   `src/main/java/com/example/echo/EchoEndpointModule.java`
 
 0. Replace the value `YOUR-PROJECT-ID` with your project ID.
 

diff --git a/...points-frameworks-v2/guice-example/src/main/java/com/example/echo/EchoEndpointModule.java b/...points-frameworks-v2/guice-example/src/main/java/com/example/echo/EchoEndpointModule.java
@@ -16,16 +16,34 @@
 
 package com.example.echo;
 
+import com.google.api.control.ServiceManagementConfigFilter;
+import com.google.api.control.extensions.appengine.GoogleAppEngineControlFilter;
+import com.google.api.server.spi.EndpointsServlet;
 import com.google.api.server.spi.guice.EndpointsModule;
 import com.google.common.collect.ImmutableList;
+import com.google.inject.servlet.GuiceFilter;
+import java.util.HashMap;
+import java.util.Map;
+import javax.inject.Singleton;
 
 // [START endpoints_module]
 public class EchoEndpointModule extends EndpointsModule {
   @Override
   public void configureServlets() {
+    super.configureServlets();
+
+    bind(ServiceManagementConfigFilter.class).in(Singleton.class);
+    filter("/_ah/api/*").through(ServiceManagementConfigFilter.class);
+
+    Map<String, String> apiController = new HashMap<String, String>();
+    apiController.put("endpoints.projectId", "YOUR-PROJECT-ID");
+    apiController.put("endpoints.serviceName", "YOUR-PROJECT-ID.appspot.com");
+
+    bind(GoogleAppEngineControlFilter.class).in(Singleton.class);
+    filter("/_ah/api/*").through(GoogleAppEngineControlFilter.class, apiController);
+
     bind(Echo.class).toInstance(new Echo());
     configureEndpoints("/_ah/api/*", ImmutableList.of(Echo.class));
-    super.configureServlets();
   }
 }
 // [END endpoints_module]
diff --git a/appengine/endpoints-frameworks-v2/guice-example/src/main/main74.iml b/appengine/endpoints-frameworks-v2/guice-example/src/main/main74.iml
diff --git a/appengine/endpoints-frameworks-v2/guice-example/src/main/webapp/WEB-INF/web.xml b/appengine/endpoints-frameworks-v2/guice-example/src/main/webapp/WEB-INF/web.xml
@@ -22,6 +22,11 @@
         <filter-class>com.google.inject.servlet.GuiceFilter</filter-class>
     </filter>
 
+    <!--
+      URL Pattern /_ah/api/* instead of /* because a legacy v1 servlet uses
+      the route /_ah/api/ and using /* will erronously use the legacy v1
+      servlet instead of routing to your API.
+    -->
     <filter-mapping>
         <filter-name>guiceFilter</filter-name>
         <url-pattern>/_ah/api/*</url-pattern>
@@ -35,33 +40,4 @@
         <welcome-file>index.html</welcome-file>
     </welcome-file-list>
 
-    <!-- Add a filter that fetches the service config from service management. -->
-    <filter>
-        <filter-name>endpoints-api-configuration</filter-name>
-        <filter-class>com.google.api.control.ServiceManagementConfigFilter</filter-class>
-    </filter>
-
-    <!-- Add a filter that performs Endpoints logging and monitoring. -->
-    <filter>
-        <filter-name>endpoints-api-controller</filter-name>
-        <filter-class>com.google.api.control.extensions.appengine.GoogleAppEngineControlFilter</filter-class>
-        <init-param>
-            <param-name>endpoints.projectId</param-name>
-            <param-value>${endpoints.project.id}</param-value>
-        </init-param>
-        <init-param>
-            <param-name>endpoints.serviceName</param-name>
-            <param-value>${endpoints.project.id}.appspot.com</param-value>
-        </init-param>
-    </filter>
-
-    <filter-mapping>
-        <filter-name>endpoints-api-configuration</filter-name>
-        <servlet-name>EndpointsServlet</servlet-name>
-    </filter-mapping>
-
-    <filter-mapping>
-        <filter-name>endpoints-api-controller</filter-name>
-        <servlet-name>EndpointsServlet</servlet-name>
-    </filter-mapping>
 </web-app>