Top Description Inners Fields Constructors Methods

org.glassfish.grizzly.http.server

public Class HttpHandlerChain

Class Inheritance

extends HttpHandler
implements JmxEventListener

java.lang.Object
org.glassfish.grizzly.http.server.HttpHandler
org.glassfish.grizzly.http.server.HttpHandlerChain

All Implemented Interfaces

org.glassfish.grizzly.http.server.jmxbase.JmxEventListener

Imports

java.io.CharConversionException, .IOException, java.util.HashMap, .Map, java.util.concurrent.ConcurrentHashMap, .ConcurrentMap, java.util.concurrent.locks.ReentrantReadWriteLock, java.util.logging.Level, .Logger, org.glassfish.grizzly.Grizzly, org.glassfish.grizzly.http.HttpRequestPacket, org.glassfish.grizzly.http.server.jmxbase.JmxEventListener, .Monitorable, org.glassfish.grizzly.http.server.util.DispatcherHelper, .Mapper, .MappingData, org.glassfish.grizzly.http.util.DataChunk, .HttpStatus, .RequestURIRef, org.glassfish.grizzly.localization.LogMessages

The HttpHandlerChain class allows the invocation of multiple HttpHandlers every time a new HTTP request is ready to be handled. Requests are mapped to their associated HttpHandler at runtime using the mapping information configured when invoking the (org.glassfish.grizzly.http.server.HttpHandler, java.lang.String[])

Author: Jeanfrancois Arcand

Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	HttpHandlerChain.DispatchHelperImpl
private static class	HttpHandlerChain.EmptyPathUpdater
private static class	HttpHandlerChain.FullUrlPathResolver
private static interface	HttpHandlerChain.PathUpdater
private static class	HttpHandlerChain.RootHttpHandler
private static class	HttpHandlerChain.SlashPathUpdater
private static class	HttpHandlerChain.SlashStarPathUpdater

Field Summary

Modifier and Type	Field and Description
private final DispatcherHelper	dispatchHelper DispatchHelper, which maps path or name to the Mapper entry
private final HttpHandlerChain.FullUrlPathResolver	fullUrlPathResolver
private final ConcurrentMap<HttpHandler, HttpHandlerRegistration[]>	handlers The list of `HttpHandler` instance.
private final ConcurrentMap<String, HttpHandler>	handlersByName The name -> `HttpHandler` map.
private int	handlersCount Number of registered HttpHandlers
private final HttpServer	httpServer
private boolean	isRootConfigured Is the root context configured?
private static final String	LOCAL_HOST The default host.
private static final Logger	LOGGER Hides org.glassfish.grizzly.http.server.HttpHandler.LOGGER.
private final Mapper	mapper Internal `Mapper` used to Map request to their associated `HttpHandler`
private final ReentrantReadWriteLock	mapperUpdateLock
private final ConcurrentMap<HttpHandler, Object>	monitors
private static final Map<HttpHandlerRegistration, HttpHandlerChain.PathUpdater>	ROOT_URLS
private volatile HttpHandlerChain.RootHttpHandler	rootHttpHandler The root `HttpHandler`, used in cases when HttpHandlerChain has only one `HttpHandler` registered and this `HttpHandler` is registered as root resource.
private boolean	started Flag indicating this HttpHandler has been started.

Constructor Summary

Access	Constructor and Description
public	HttpHandlerChain(final HttpServer httpServer)

Method Summary

Modifier and Type	Method and Description
public void	addHandler(final HttpHandler `HttpHandler` instance httpHandler, final String[] an array of mapping. mappings) Add a `HttpHandler` and its associated array of mapping.
public void	addHandler(final HttpHandler `HttpHandler` instance httpHandler, final HttpHandlerRegistration[] an array of mapping. mappings) Add a `HttpHandler` and its associated array of mapping.
private void	deregisterJmxForHandler(final HttpHandler httpHandler)
public synchronized void	destroy() Overrides org.glassfish.grizzly.http.server.HttpHandler.destroy. Invoked when the `HttpServer` and may be overridden by custom implementations to perform implementation specific resource reclaimation tasks.
pack-priv boolean	doHandle(final Request request, final Response response) Overrides org.glassfish.grizzly.http.server.HttpHandler.doHandle. Pre-processes `HttpHandler` `Request` and `Response`, checks the HTTP acknowledgment and decodes URL if required.
public void	jmxDisabled() Implements org.glassfish.grizzly.http.server.jmxbase.JmxEventListener.jmxDisabled. Invoked when JMX has been disabled.
public void	jmxEnabled() Implements org.glassfish.grizzly.http.server.jmxbase.JmxEventListener.jmxEnabled. Invoked when JMX has been enabled.
private void	registerJmxForHandler(final HttpHandler httpHandler)
public void	removeAllHttpHandlers()
public boolean	Returns: `true` if removed removeHttpHandler(final HttpHandler `HttpHandler` to remove httpHandler) Remove a `HttpHandler`
public void	service(final Request The `Request` request, final Response The `Response` response) Implements abstract org.glassfish.grizzly.http.server.HttpHandler.service. Map the `Request` to the proper `HttpHandler`
public synchronized void	start() Overrides org.glassfish.grizzly.http.server.HttpHandler.start. Called when the `HttpHandler`'s container is started by invoking `HttpServer#start`.

Inherited from org.glassfish.grizzly.http.server.HttpHandler:: getErrorPageGenerator getName getRequestExecutorProvider getRequestURIEncoding getSessionCookieName getSessionManager isAllowCustomStatusMessage isAllowEncodedSlash sendAcknowledgment setAllowCustomStatusMessage setAllowEncodedSlash setDecodeUrl setDispatcherHelper setRequestURIEncoding setRequestURIEncoding updatePaths

Field Detail

dispatchHelper	back to summary
private final DispatcherHelper dispatchHelper DispatchHelper, which maps path or name to the Mapper entry

fullUrlPathResolver	back to summary
private final HttpHandlerChain.FullUrlPathResolver fullUrlPathResolver

handlers	back to summary
private final ConcurrentMap<HttpHandler, HttpHandlerRegistration[]> handlers The list of `HttpHandler` instance.

handlersByName	back to summary
private final ConcurrentMap<String, HttpHandler> handlersByName The name -> `HttpHandler` map.

handlersCount	back to summary
private int handlersCount Number of registered HttpHandlers

httpServer	back to summary
private final HttpServer httpServer

isRootConfigured	back to summary
private boolean isRootConfigured Is the root context configured?

LOCAL_HOST	back to summary
private static final String LOCAL_HOST The default host.

LOGGER	back to summary
private static final Logger LOGGER Hides org.glassfish.grizzly.http.server.HttpHandler.LOGGER.

mapper	back to summary
private final Mapper mapper Internal `Mapper` used to Map request to their associated `HttpHandler`

mapperUpdateLock	back to summary
private final ReentrantReadWriteLock mapperUpdateLock

monitors	back to summary
private final ConcurrentMap<HttpHandler, Object> monitors

ROOT_URLS	back to summary
private static final Map<HttpHandlerRegistration, HttpHandlerChain.PathUpdater> ROOT_URLS

rootHttpHandler	back to summary
private volatile HttpHandlerChain.RootHttpHandler rootHttpHandler The root `HttpHandler`, used in cases when HttpHandlerChain has only one `HttpHandler` registered and this `HttpHandler` is registered as root resource.

started	back to summary
private boolean started Flag indicating this HttpHandler has been started. Any subsequent HttpHandler instances added to this chain after is has been started will have their start() method invoked.

Constructor Detail

HttpHandlerChain	back to summary
public HttpHandlerChain(final HttpServer httpServer)

Method Detail

addHandler back to summary

addHandler	back to summary
public void addHandler(final HttpHandler httpHandler, final String[] mappings) Add a `HttpHandler` and its associated array of mapping. The mapping data will be used to map incoming request to its associated `HttpHandler`. Parameters httpHandler:HttpHandler `HttpHandler` instance mappings:String[] an array of mapping.

public void addHandler(final HttpHandler httpHandler, final String[] mappings)

Add a HttpHandler and its associated array of mapping. The mapping data will be used to map incoming request to its associated HttpHandler.

Parameters

httpHandler:HttpHandler: HttpHandler instance
mappings:String[]: an array of mapping.

addHandler back to summary

addHandler	back to summary
public void addHandler(final HttpHandler httpHandler, final HttpHandlerRegistration[] mappings) Add a `HttpHandler` and its associated array of mapping. The mapping data will be used to map incoming request to its associated `HttpHandler`. Parameters httpHandler:HttpHandler `HttpHandler` instance mappings:HttpHandlerRegistration[] an array of mapping.

public void addHandler(final HttpHandler httpHandler, final HttpHandlerRegistration[] mappings)

Add a HttpHandler and its associated array of mapping. The mapping data will be used to map incoming request to its associated HttpHandler.

Parameters

httpHandler:HttpHandler: HttpHandler instance
mappings:HttpHandlerRegistration[]: an array of mapping.

deregisterJmxForHandler	back to summary
private void deregisterJmxForHandler(final HttpHandler httpHandler)

destroy back to summary

destroy	back to summary
public synchronized void destroy() Overrides org.glassfish.grizzly.http.server.HttpHandler.destroy. Doc from org.glassfish.grizzly.http.server.HttpHandler.destroy. Invoked when the `HttpServer` and may be overridden by custom implementations to perform implementation specific resource reclaimation tasks. By default, this method does nothing. Annotations @Override

public synchronized void destroy()

Overrides org.glassfish.grizzly.http.server.HttpHandler.destroy.

Doc from org.glassfish.grizzly.http.server.HttpHandler.destroy.

Invoked when the HttpServer and may be overridden by custom implementations to perform implementation specific resource reclaimation tasks. By default, this method does nothing.

Annotations

@Override

doHandle back to summary

doHandle	back to summary
pack-priv boolean doHandle(final Request request, final Response response) throws Exception Overrides org.glassfish.grizzly.http.server.HttpHandler.doHandle. Doc from org.glassfish.grizzly.http.server.HttpHandler.doHandle. Pre-processes `HttpHandler` `Request` and `Response`, checks the HTTP acknowledgment and decodes URL if required. Then passes control to `service(Request, Response)`. Annotations @Override Exceptions Exception: if an error occurs serving a static resource or from the invocation of `service(Request, Response)`

pack-priv boolean doHandle(final Request request, final Response response) throws Exception

Overrides org.glassfish.grizzly.http.server.HttpHandler.doHandle.

Doc from org.glassfish.grizzly.http.server.HttpHandler.doHandle.

Pre-processes HttpHandler Request and Response, checks the HTTP acknowledgment and decodes URL if required. Then passes control to service(Request, Response).

Annotations

@Override

Exceptions

Exception:: if an error occurs serving a static resource or from the invocation of service(Request, Response)

jmxDisabled	back to summary
public void jmxDisabled() Implements org.glassfish.grizzly.http.server.jmxbase.JmxEventListener.jmxDisabled. Doc from org.glassfish.grizzly.http.server.jmxbase.JmxEventListener.jmxDisabled. Invoked when JMX has been disabled. Annotations @Override

jmxDisabled

back to summary

public void jmxDisabled()

Implements org.glassfish.grizzly.http.server.jmxbase.JmxEventListener.jmxDisabled.

Doc from org.glassfish.grizzly.http.server.jmxbase.JmxEventListener.jmxDisabled.

Invoked when JMX has been disabled.

Annotations

@Override

jmxEnabled	back to summary
public void jmxEnabled() Implements org.glassfish.grizzly.http.server.jmxbase.JmxEventListener.jmxEnabled. Doc from org.glassfish.grizzly.http.server.jmxbase.JmxEventListener.jmxEnabled. Invoked when JMX has been enabled. Annotations @Override

jmxEnabled

back to summary

public void jmxEnabled()

Implements org.glassfish.grizzly.http.server.jmxbase.JmxEventListener.jmxEnabled.

Doc from org.glassfish.grizzly.http.server.jmxbase.JmxEventListener.jmxEnabled.

Invoked when JMX has been enabled.

Annotations

@Override

registerJmxForHandler	back to summary
private void registerJmxForHandler(final HttpHandler httpHandler)

removeAllHttpHandlers	back to summary
public void removeAllHttpHandlers()

removeHttpHandler back to summary

removeHttpHandler	back to summary
public boolean removeHttpHandler(final HttpHandler httpHandler) Remove a `HttpHandler` Parameters httpHandler:HttpHandler `HttpHandler` to remove Returns:boolean `true` if removed

public boolean removeHttpHandler(final HttpHandler httpHandler)

Remove a HttpHandler

Parameters

httpHandler:HttpHandler: HttpHandler to remove

Returns:boolean

true if removed

service back to summary

service	back to summary
public void service(final Request request, final Response response) throws Exception Implements abstract org.glassfish.grizzly.http.server.HttpHandler.service. Map the `Request` to the proper `HttpHandler` Parameters request:Request The `Request` response:Response The `Response` Annotations @Override

public void service(final Request request, final Response response) throws Exception

Implements abstract org.glassfish.grizzly.http.server.HttpHandler.service.

Map the Request to the proper HttpHandler

Parameters

request:Request: The Request
response:Response: The Response

Annotations

@Override

start back to summary

start	back to summary
public synchronized void start() Overrides org.glassfish.grizzly.http.server.HttpHandler.start. Doc from org.glassfish.grizzly.http.server.HttpHandler.start. Called when the `HttpHandler`'s container is started by invoking `HttpServer#start`. By default, it does nothing. Annotations @Override

public synchronized void start()

Overrides org.glassfish.grizzly.http.server.HttpHandler.start.

Doc from org.glassfish.grizzly.http.server.HttpHandler.start.

Called when the HttpHandler's container is started by invoking HttpServer#start. By default, it does nothing.

Annotations

@Override

org.glassfish.grizzly.http.server back to summary

private final Class HttpHandlerChain.DispatchHelperImpl

Class Inheritance

extends Object
implements DispatcherHelper

java.lang.Object
org.glassfish.grizzly.http.server.HttpHandlerChain.DispatchHelperImpl

All Implemented Interfaces

org.glassfish.grizzly.http.server.util.DispatcherHelper

Constructor Summary

Access	Constructor and Description
private	DispatchHelperImpl()

Method Summary

Modifier and Type	Method and Description
public void	mapName(final DataChunk name, final MappingData mappingData) Implements org.glassfish.grizzly.http.server.util.DispatcherHelper.mapName.
public void	mapPath(final HttpRequestPacket requestPacket, final DataChunk path, final MappingData mappingData) Implements org.glassfish.grizzly.http.server.util.DispatcherHelper.mapPath.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

DispatchHelperImpl	back to summary
private DispatchHelperImpl()

Method Detail

mapName	back to summary
public void mapName(final DataChunk name, final MappingData mappingData) Implements org.glassfish.grizzly.http.server.util.DispatcherHelper.mapName. Annotations @Override

mapName

back to summary

public void mapName(final DataChunk name, final MappingData mappingData)

Implements org.glassfish.grizzly.http.server.util.DispatcherHelper.mapName.

Annotations

@Override

mapPath	back to summary
public void mapPath(final HttpRequestPacket requestPacket, final DataChunk path, final MappingData mappingData) throws Exception Implements org.glassfish.grizzly.http.server.util.DispatcherHelper.mapPath. Annotations @Override

mapPath

back to summary

public void mapPath(final HttpRequestPacket requestPacket, final DataChunk path, final MappingData mappingData) throws Exception

Implements org.glassfish.grizzly.http.server.util.DispatcherHelper.mapPath.

Annotations

@Override

org.glassfish.grizzly.http.server back to summary

private Class HttpHandlerChain.EmptyPathUpdater

Class Inheritance

extends Object
implements PathUpdater

java.lang.Object
org.glassfish.grizzly.http.server.HttpHandlerChain.EmptyPathUpdater

All Implemented Interfaces

org.glassfish.grizzly.http.server.HttpHandlerChain.PathUpdater

Constructor Summary

Access	Constructor and Description
private	EmptyPathUpdater()

Method Summary

Modifier and Type	Method and Description
public void	update(final HttpHandlerChain handlerChain, final HttpHandler httpHandler, final Request request) Implements org.glassfish.grizzly.http.server.HttpHandlerChain.PathUpdater.update.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

EmptyPathUpdater	back to summary
private EmptyPathUpdater()

Method Detail

update	back to summary
public void update(final HttpHandlerChain handlerChain, final HttpHandler httpHandler, final Request request) Implements org.glassfish.grizzly.http.server.HttpHandlerChain.PathUpdater.update. Annotations @Override

update

back to summary

public void update(final HttpHandlerChain handlerChain, final HttpHandler httpHandler, final Request request)

Implements org.glassfish.grizzly.http.server.HttpHandlerChain.PathUpdater.update.

Annotations

@Override

org.glassfish.grizzly.http.server back to summary

private Class HttpHandlerChain.FullUrlPathResolver

Class Inheritance

extends Object
implements PathResolver

java.lang.Object
org.glassfish.grizzly.http.server.HttpHandlerChain.FullUrlPathResolver

All Implemented Interfaces

org.glassfish.grizzly.http.server.Request.PathResolver

Field Summary

Modifier and Type	Field and Description
private final HttpHandler	httpHandler

Constructor Summary

Access	Constructor and Description
public	FullUrlPathResolver(HttpHandler httpHandler)

Method Summary

Modifier and Type	Method and Description
public String	resolve(final Request request) Implements org.glassfish.grizzly.http.server.Request.PathResolver.resolve.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

httpHandler	back to summary
private final HttpHandler httpHandler

Constructor Detail

FullUrlPathResolver	back to summary
public FullUrlPathResolver(HttpHandler httpHandler)

Method Detail

resolve	back to summary
public String resolve(final Request request) Implements org.glassfish.grizzly.http.server.Request.PathResolver.resolve. Annotations @Override

resolve

back to summary

public String resolve(final Request request)

Implements org.glassfish.grizzly.http.server.Request.PathResolver.resolve.

Annotations

@Override

org.glassfish.grizzly.http.server back to summary

private Interface HttpHandlerChain.PathUpdater

Known Direct Implementers: org.glassfish.grizzly.http.server.HttpHandlerChain.SlashPathUpdater, org.glassfish.grizzly.http.server.HttpHandlerChain.SlashStarPathUpdater, org.glassfish.grizzly.http.server.HttpHandlerChain.EmptyPathUpdater

Method Summary

Modifier and Type	Method and Description
public void	update(HttpHandlerChain handlerChain, HttpHandler httpHandler, Request request)

Method Detail

update	back to summary
public void update(HttpHandlerChain handlerChain, HttpHandler httpHandler, Request request)

org.glassfish.grizzly.http.server back to summary

private final Class HttpHandlerChain.RootHttpHandler

Class Inheritance

extends Object

java.lang.Object
org.glassfish.grizzly.http.server.HttpHandlerChain.RootHttpHandler

Field Summary

Modifier and Type	Field and Description
private final HttpHandler	httpHandler
private final HttpHandlerChain.PathUpdater	pathUpdater

Constructor Summary

Access	Constructor and Description
public	RootHttpHandler(final HttpHandler httpHandler, final HttpHandlerChain.PathUpdater pathUpdater)

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

httpHandler	back to summary
private final HttpHandler httpHandler

pathUpdater	back to summary
private final HttpHandlerChain.PathUpdater pathUpdater

Constructor Detail

RootHttpHandler	back to summary
public RootHttpHandler(final HttpHandler httpHandler, final HttpHandlerChain.PathUpdater pathUpdater)

org.glassfish.grizzly.http.server back to summary

private Class HttpHandlerChain.SlashPathUpdater

Class Inheritance

extends Object
implements PathUpdater

java.lang.Object
org.glassfish.grizzly.http.server.HttpHandlerChain.SlashPathUpdater

All Implemented Interfaces

org.glassfish.grizzly.http.server.HttpHandlerChain.PathUpdater

Constructor Summary

Access	Constructor and Description
private	SlashPathUpdater()

Method Summary

Modifier and Type	Method and Description
public void	update(final HttpHandlerChain handlerChain, final HttpHandler httpHandler, final Request request) Implements org.glassfish.grizzly.http.server.HttpHandlerChain.PathUpdater.update.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

SlashPathUpdater	back to summary
private SlashPathUpdater()

Method Detail

update

back to summary

public void update(final HttpHandlerChain handlerChain, final HttpHandler httpHandler, final Request request)

Implements org.glassfish.grizzly.http.server.HttpHandlerChain.PathUpdater.update.

Annotations

@Override

org.glassfish.grizzly.http.server back to summary

private Class HttpHandlerChain.SlashStarPathUpdater

Class Inheritance

extends Object
implements PathUpdater

java.lang.Object
org.glassfish.grizzly.http.server.HttpHandlerChain.SlashStarPathUpdater

All Implemented Interfaces

org.glassfish.grizzly.http.server.HttpHandlerChain.PathUpdater

Constructor Summary

Access	Constructor and Description
private	SlashStarPathUpdater()

Method Summary

Modifier and Type	Method and Description
public void	update(final HttpHandlerChain handlerChain, final HttpHandler httpHandler, final Request request) Implements org.glassfish.grizzly.http.server.HttpHandlerChain.PathUpdater.update.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

SlashStarPathUpdater	back to summary
private SlashStarPathUpdater()

Method Detail

update

back to summary

public void update(final HttpHandlerChain handlerChain, final HttpHandler httpHandler, final Request request)

Implements org.glassfish.grizzly.http.server.HttpHandlerChain.PathUpdater.update.

Annotations

@Override