org.onehippo.cms7.services

Class ServletContextRegistry

java.lang.Object

org.onehippo.cms7.services.ServletContextRegistry

public final class ServletContextRegistry
extends Object

The ServletContextRegistry provides a central registration of web applications their ServletContext using their contextPath as key and optionally a ServletContextRegistry.WebAppType which gets set as ServletContext attribute as follows: ServletContext#setAttribute(org.onehippo.cms7.services.ServletContextRegistry.WebAppType, WebAppType).

ServletContexts can/should be registered/unregistered via init/destroy methods of a Servlet or Filter, or a ServletContextListener its contextInitialized/contextDestroyed event methods.

Registered ServletContexts can be looked up by their contextPath or as an unmodifiable map by their context paths.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServletContextRegistry.WebAppType

Constructor Summary

Constructors

Constructor and Description
ServletContextRegistry()

Method Summary

Modifier and Type	Method and Description
static javax.servlet.ServletContext	getContext(String contextPath)
static Map<String,javax.servlet.ServletContext>	getContexts()
static Map<String,javax.servlet.ServletContext>	getContexts(ServletContextRegistry.WebAppType type)
static void	register(javax.servlet.ServletContext ctx, ServletContextRegistry.WebAppType type) Register a ServletContext
static void	unregister(javax.servlet.ServletContext ctx) Unregister a ServletContext

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletContextRegistry

public ServletContextRegistry()

Method Detail

register

public static void register(javax.servlet.ServletContext ctx,
                            ServletContextRegistry.WebAppType type)

Register a ServletContext

Parameters:

ctx - the servletContext to register

type - the WebAppType to which the ctx belongs. Not allowed to be null

Throws:

IllegalStateException - if the ServletContext already has been registered by its contextPath

unregister

public static void unregister(javax.servlet.ServletContext ctx)

Unregister a ServletContext

Parameters:

ctx - the servletContext to unregister

Throws:

IllegalStateException - if the ServletContext has not been registered by its contextPath

getContext

public static javax.servlet.ServletContext getContext(String contextPath)

Parameters:

contextPath - The contextPath for which to lookup the ServletContext

Returns:

the ServletContext registered under the parameter contextPath

getContexts

public static Map<String,javax.servlet.ServletContext> getContexts()

Returns:

unmodifiable map of all currently registered ServletContexts mapped by their contextPath

getContexts

public static Map<String,javax.servlet.ServletContext> getContexts(ServletContextRegistry.WebAppType type)

Returns:

unmodifiable map of all currently registered ServletContexts of WebAppType type mapped by their contextPath