com.google.api.server.spi.guice

Class EndpointsModule

java.lang.Object

com.google.inject.AbstractModule

com.google.inject.servlet.ServletModule

com.google.api.server.spi.guice.EndpointsModule

All Implemented Interfaces:

com.google.inject.Module

public class EndpointsModule
extends com.google.inject.servlet.ServletModule

A base Guice module which provides helpers for configuring Endpoints. Consumers should extend this class and call one of the helpers in ServletModule.configureServlets().

Nested Class Summary

Nested classes/interfaces inherited from class com.google.inject.servlet.ServletModule

com.google.inject.servlet.ServletModule.FilterKeyBindingBuilder, com.google.inject.servlet.ServletModule.ServletKeyBindingBuilder

Constructor Summary

Constructors

Constructor and Description
EndpointsModule()

Method Summary

Modifier and Type	Method and Description
protected void	configureEndpoints(java.lang.String urlPattern, java.lang.Iterable<? extends java.lang.Class<?>> serviceClasses) Configure Endpoints given a list of service classes using GuiceEndpointsServlet.
protected void	configureEndpoints(java.lang.String urlPattern, java.lang.Iterable<? extends java.lang.Class<?>> serviceClasses, boolean useLegacyServlet) Deprecated. the legacy servlet is no longer available.
protected void	configureEndpoints(java.lang.String urlPattern, com.google.api.server.spi.ServletInitializationParameters initParameters) Configure Endpoints given ServletInitializationParameters using GuiceEndpointsServlet.
protected void	configureEndpoints(java.lang.String urlPattern, com.google.api.server.spi.ServletInitializationParameters initParameters, boolean useLegacyServlet) Configure Endpoints given ServletInitializationParameters.

Methods inherited from class com.google.inject.servlet.ServletModule

configure, configureServlets, filter, filterRegex, getServletContext, serve, serveRegex

Methods inherited from class com.google.inject.AbstractModule

addError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindListener, bindScope, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBinding

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EndpointsModule

public EndpointsModule()

Method Detail

configureEndpoints

protected void configureEndpoints(java.lang.String urlPattern,
                                  java.lang.Iterable<? extends java.lang.Class<?>> serviceClasses)

Configure Endpoints given a list of service classes using GuiceEndpointsServlet.

Parameters:

urlPattern - the URL pattern to configure the servlet on. For the legacy servlet, use "/_ah/spi/*". For the new servlet, use "/_ah/api/*" if backwards compatibility is desired, or any other pattern if compatibility is not an issue.

serviceClasses - the list of backend classes to be included

configureEndpoints

@Deprecated
protected void configureEndpoints(java.lang.String urlPattern,
                                              java.lang.Iterable<? extends java.lang.Class<?>> serviceClasses,
                                              boolean useLegacyServlet)

Deprecated. the legacy servlet is no longer available.

Configure Endpoints given a list of service classes.

Parameters:

urlPattern - the URL pattern to configure the servlet on. For the legacy servlet, use "/_ah/spi/*". For the new servlet, use "/_ah/api/*" if backwards compatibility is desired, or any other pattern if compatibility is not an issue.

serviceClasses - the list of backend classes to be included

useLegacyServlet - whether or not to use the old style servlet

configureEndpoints

protected void configureEndpoints(java.lang.String urlPattern,
                                  com.google.api.server.spi.ServletInitializationParameters initParameters)

Configure Endpoints given ServletInitializationParameters using GuiceEndpointsServlet.

Parameters:

urlPattern - the URL pattern to configure the servlet on. For the legacy servlet, use "/_ah/spi/*". For the new servlet, use "/_ah/api/*" if backwards compatibility is desired, or any other pattern if compatibility is not an issue

initParameters - the initialization parameters. Must include service classes to be useful

configureEndpoints

protected void configureEndpoints(java.lang.String urlPattern,
                                  com.google.api.server.spi.ServletInitializationParameters initParameters,
                                  boolean useLegacyServlet)

Configure Endpoints given ServletInitializationParameters.

Parameters:

urlPattern - the URL pattern to configure the servlet on. For the legacy servlet, use "/_ah/spi/*". For the new servlet, use "/_ah/api/*" if backwards compatibility is desired, or any other pattern if compatibility is not an issue

initParameters - the initialization parameters. Must include service classes to be useful

useLegacyServlet - whether or not to use the old style servlet