org.eurekaclinical.common.config

Class AbstractServletModule

java.lang.Object

com.google.inject.AbstractModule

com.google.inject.servlet.ServletModule

org.eurekaclinical.common.config.AbstractServletModule

All Implemented Interfaces:

com.google.inject.Module

Direct Known Subclasses:

ApiGatewayServletModule

public abstract class AbstractServletModule
extends com.google.inject.servlet.ServletModule

Extend to setup Eureka web applications. This abstract class sets up Guice and binds the authentication and authorization filters that every Eureka web application should have.

Author:

hrathod

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

Modifier	Constructor and Description
protected	AbstractServletModule(org.eurekaclinical.standardapis.props.CasEurekaClinicalProperties inProperties)

Method Summary

Modifier and Type	Method and Description
protected void	configureServlets()
protected String	getCasProxyCallbackPath() Returns the path part of the proxy callback URL.
protected String	getCasProxyCallbackUrl() Returns the proxy callback URL.
protected Map<String,String>	getCasValidationFilterInitParams() Constructs an init parameter map for the Cas20ProxyReceivingTicketValidationFilter filter.
protected String	getProtectedPath() Gets the Tomcat protected path (that triggers CAS authentication).
protected void	serveDestroySession() Serves /destroy-session.
protected void	serveGetSession() Serves /protected/get-session.
protected void	serveGetSessionProperties() Serves /protected/get-session-properties.
protected void	serveLogin() Serves /protected/login.
protected void	serveLogout() Serves /logout.
protected void	serveProxyResource() Serves /proxy-resource/*.
protected void	setupFilters() Override to setup additional filters.
protected abstract void	setupServlets() Implement this method with calls to ServletModule.serve(java.lang.String, java.lang.String...) to add servlets to the webapp.

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

configure, filter, filterRegex, getServletContext, serve, serveRegex

Methods inherited from class com.google.inject.AbstractModule

addError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, 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

AbstractServletModule

protected AbstractServletModule(org.eurekaclinical.standardapis.props.CasEurekaClinicalProperties inProperties)

Method Detail

getCasProxyCallbackPath

protected String getCasProxyCallbackPath()

Returns the path part of the proxy callback URL. The proxy callback URL is called by CAS to deliver the proxy ticket.

Returns:

the path part of the proxy callback URL.

getCasProxyCallbackUrl

protected String getCasProxyCallbackUrl()

Returns the proxy callback URL. It is called by CAS to deliver the proxy ticket

Returns:

the proxy callback URL.

setupServlets

protected abstract void setupServlets()

Implement this method with calls to ServletModule.serve(java.lang.String, java.lang.String...) to add servlets to the webapp.

setupFilters

protected void setupFilters()

Override to setup additional filters. The default implementation sets up default filters and must be called.

configureServlets

protected final void configureServlets()

Overrides:

configureServlets in class com.google.inject.servlet.ServletModule

getProtectedPath

protected String getProtectedPath()

Gets the Tomcat protected path (that triggers CAS authentication).

Returns:

the protected path string.

serveLogin

protected void serveLogin()

Serves /protected/login.

serveGetSession

protected void serveGetSession()

Serves /protected/get-session.

serveProxyResource

protected void serveProxyResource()

Serves /proxy-resource/*.

serveDestroySession

protected void serveDestroySession()

Serves /destroy-session.

serveLogout

protected void serveLogout()

Serves /logout.

serveGetSessionProperties

protected void serveGetSessionProperties()

Serves /protected/get-session-properties.

getCasValidationFilterInitParams

protected Map<String,String> getCasValidationFilterInitParams()

Constructs an init parameter map for the Cas20ProxyReceivingTicketValidationFilter filter.

Returns:

the init parameter map.