org.crazyyak.dev.jerseyspring

Class YakJerseyWebAppInitializer

java.lang.Object

org.crazyyak.dev.jerseyspring.YakJerseyWebAppInitializer

All Implemented Interfaces:

org.springframework.web.WebApplicationInitializer

public abstract class YakJerseyWebAppInitializer
extends java.lang.Object
implements org.springframework.web.WebApplicationInitializer

Constructor Summary

Constructors

Constructor and Description
YakJerseyWebAppInitializer()

Method Summary

Modifier and Type	Method and Description
protected void	addFilters(javax.servlet.ServletContext servletContext, org.springframework.web.context.WebApplicationContext appContext)
protected void	addJerseyFilter(javax.servlet.ServletContext servletContext, org.springframework.web.context.WebApplicationContext appContext) Configures the Jersey filter
protected void	addJspfServlet(javax.servlet.ServletContext servletContext, org.springframework.web.context.WebApplicationContext appContext) Includes jspf as servlet
protected void	addListeners(javax.servlet.ServletContext servletContext, org.springframework.web.context.WebApplicationContext appContext)
protected void	addServlets(javax.servlet.ServletContext servletContext, org.springframework.web.context.WebApplicationContext appContext)
protected void	addSpringSecurityFilter(javax.servlet.ServletContext servletContext, org.springframework.web.context.WebApplicationContext appContext) Configures the Spring Security filter
protected java.lang.String	buildStaticContentRegex()
protected org.springframework.web.context.WebApplicationContext	createWebApplicationContext(javax.servlet.ServletContext servletContext)
abstract java.lang.Class<? extends org.glassfish.jersey.server.ResourceConfig>	getApplicationClass(javax.servlet.ServletContext servletContext, org.springframework.web.context.WebApplicationContext appContext) Identifies the Jersey ResourceConfig for this app
abstract java.lang.String	getEnvironmentPropertyName(javax.servlet.ServletContext servletContext, org.springframework.web.context.WebApplicationContext appContext) Defines the name of the system property that is used to identify the application's current environment.
protected abstract java.lang.String	getProfilesPropertyName(javax.servlet.ServletContext servletContext, org.springframework.web.context.WebApplicationContext appContext) Defines the name of the system property that is used to override the list of spring profiles for this application.
protected abstract java.lang.Class<?>[]	getSpringConfigClasses(javax.servlet.ServletContext servletContext) Defines the spring config classes to use for initialization - return null if a Spring XML file is used
protected abstract java.lang.String	getSpringConfigLocation(javax.servlet.ServletContext servletContext) Defines the spring xml file to use for initialization - return null if Spring Config classes are used.
protected java.lang.String[]	getSpringProfiles(javax.servlet.ServletContext servletContext, org.springframework.web.context.WebApplicationContext appContext)
protected java.util.Collection<java.lang.String>	getStaticResourceUrlPatterns()
void	onStartup(javax.servlet.ServletContext servletContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

YakJerseyWebAppInitializer

public YakJerseyWebAppInitializer()

Method Detail

getApplicationClass

public abstract java.lang.Class<? extends org.glassfish.jersey.server.ResourceConfig> getApplicationClass(javax.servlet.ServletContext servletContext,
                                                                                                          org.springframework.web.context.WebApplicationContext appContext)

Identifies the Jersey ResourceConfig for this app

Parameters:

servletContext - the servlet context for this app

appContext - the application context for this app

Returns:

the ResourceConfig for this app

getEnvironmentPropertyName

public abstract java.lang.String getEnvironmentPropertyName(javax.servlet.ServletContext servletContext,
                                                            org.springframework.web.context.WebApplicationContext appContext)

Defines the name of the system property that is used to identify the application's current environment.

Parameters:

servletContext - the servlet context for this app

appContext - the application context for this app

Returns:

the property name

getProfilesPropertyName

protected abstract java.lang.String getProfilesPropertyName(javax.servlet.ServletContext servletContext,
                                                            org.springframework.web.context.WebApplicationContext appContext)

Defines the name of the system property that is used to override the list of spring profiles for this application.

Parameters:

servletContext - the servlet context for this app

appContext - the application context for this app

Returns:

the property name

getSpringConfigClasses

protected abstract java.lang.Class<?>[] getSpringConfigClasses(javax.servlet.ServletContext servletContext)

Defines the spring config classes to use for initialization - return null if a Spring XML file is used

Parameters:

servletContext - the servlet context for this app

Returns:

the Spring configuration class.

getSpringConfigLocation

protected abstract java.lang.String getSpringConfigLocation(javax.servlet.ServletContext servletContext)

Defines the spring xml file to use for initialization - return null if Spring Config classes are used.

Parameters:

servletContext - the servlet context for this app

Returns:

the location of the Spring configuration file.

onStartup

public void onStartup(javax.servlet.ServletContext servletContext)
               throws javax.servlet.ServletException

Specified by:

onStartup in interface org.springframework.web.WebApplicationInitializer

Throws:

javax.servlet.ServletException

addFilters

protected void addFilters(javax.servlet.ServletContext servletContext,
                          org.springframework.web.context.WebApplicationContext appContext)

addListeners

protected void addListeners(javax.servlet.ServletContext servletContext,
                            org.springframework.web.context.WebApplicationContext appContext)

createWebApplicationContext

protected org.springframework.web.context.WebApplicationContext createWebApplicationContext(javax.servlet.ServletContext servletContext)

addSpringSecurityFilter

protected void addSpringSecurityFilter(javax.servlet.ServletContext servletContext,
                                       org.springframework.web.context.WebApplicationContext appContext)

Configures the Spring Security filter

Parameters:

servletContext - the servlet context for this app

appContext - the application context for this app

addJerseyFilter

protected void addJerseyFilter(javax.servlet.ServletContext servletContext,
                               org.springframework.web.context.WebApplicationContext appContext)

Configures the Jersey filter

Parameters:

servletContext - the servlet context for this app

appContext - the application context for this app

buildStaticContentRegex

protected java.lang.String buildStaticContentRegex()

getStaticResourceUrlPatterns

protected java.util.Collection<java.lang.String> getStaticResourceUrlPatterns()

addServlets

protected void addServlets(javax.servlet.ServletContext servletContext,
                           org.springframework.web.context.WebApplicationContext appContext)

addJspfServlet

protected void addJspfServlet(javax.servlet.ServletContext servletContext,
                              org.springframework.web.context.WebApplicationContext appContext)

Includes jspf as servlet

Parameters:

servletContext - the servlet context for this app

appContext - the application context for this app

getSpringProfiles

protected java.lang.String[] getSpringProfiles(javax.servlet.ServletContext servletContext,
                                               org.springframework.web.context.WebApplicationContext appContext)