com.goldencode.p2j.web

Class HtmlResourceHandler

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.server.handler.AbstractHandler

com.goldencode.p2j.web.HtmlResourceHandler

All Implemented Interfaces:

org.eclipse.jetty.server.Handler, org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.Dumpable.DumpableContainer, org.eclipse.jetty.util.component.LifeCycle

Direct Known Subclasses:

OpenResourceHandler, TestKeysApplicationHandler, WebPageHandler

public abstract class HtmlResourceHandler
extends org.eclipse.jetty.server.handler.AbstractHandler

jetty Handler which delivers HTML resource files. This class provide a method to parse the HTML text and substitute placeholder's.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	HtmlResourceHandler.HtmlTemplateKeysProvider Holds a map of template keys with their value suppliers.

Nested classes/interfaces inherited from class org.eclipse.jetty.server.handler.AbstractHandler

org.eclipse.jetty.server.handler.AbstractHandler.ErrorDispatchHandler

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

org.eclipse.jetty.util.component.LifeCycle.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

org.eclipse.jetty.util.component.Dumpable.DumpableContainer

Field Summary

Fields

Modifier and Type	Field and Description
private static CentralLogger	LOG Logger.
private java.lang.String	skeletonPage The html skeleton page.
private java.lang.String	targetRoot The root portion of the target request name (part of the URL).

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Constructor Summary

Constructors

Constructor and Description
HtmlResourceHandler(java.lang.String targetRoot, java.lang.String skeletonPage) Constructor.

Method Summary

Modifier and Type	Method and Description
private void	generateMainPage(org.eclipse.jetty.server.Request base, javax.servlet.http.HttpServletResponse response) Use the skeleton main page to generate a response.
protected abstract java.util.Map<java.lang.String,java.util.function.Supplier<java.lang.String>>	getTemplateKeys(org.eclipse.jetty.server.Request base) Generates a map of template keys with their value suppliers in order to fill gaps in the html skeleton template page.
void	handle(java.lang.String target, org.eclipse.jetty.server.Request base, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Return the main page for AJAX clients.

Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandler

destroy, doError, doStart, doStop, getServer, setServer

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

addBean, addBean, addEventListener, addManaged, contains, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpObjects, dumpStdErr, dumpThis, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBean, updateBeans

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, start, stop, stop

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer

isDumpable

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dumpContainer, dumpIterable, dumpMapEntries, dumpObjects, dumpSelf, named

Field Detail

LOG

private static final CentralLogger LOG

Logger.

targetRoot

private java.lang.String targetRoot

The root portion of the target request name (part of the URL).

skeletonPage

private java.lang.String skeletonPage

The html skeleton page.

Constructor Detail

HtmlResourceHandler

public HtmlResourceHandler(java.lang.String targetRoot,
                           java.lang.String skeletonPage)

Constructor.

Parameters:

targetRoot - Prefix for all URLs relating to this page.

skeletonPage - Fully qualified resource name of the HTML file which should be used.

Method Detail

handle

public void handle(java.lang.String target,
                   org.eclipse.jetty.server.Request base,
                   javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws java.io.IOException,
                   javax.servlet.ServletException

Return the main page for AJAX clients.

Specified by:

handle in interface org.eclipse.jetty.server.Handler

Specified by:

handle in class org.eclipse.jetty.server.handler.AbstractHandler

Parameters:

target - The target of the request - either a URI or a name.

base - The base request.

request - The object or a wrapper of the request.

response - The object or a wrapper of the response.

Throws:

java.io.IOException

javax.servlet.ServletException

generateMainPage

private void generateMainPage(org.eclipse.jetty.server.Request base,
                              javax.servlet.http.HttpServletResponse response)
                       throws java.io.IOException,
                              javax.servlet.ServletException

Use the skeleton main page to generate a response.

Parameters:

base - The details and state the request.

response - The details and state of the response.

Throws:

java.io.IOException - ServletException If any error conditions occur.

javax.servlet.ServletException

getTemplateKeys

protected abstract java.util.Map<java.lang.String,java.util.function.Supplier<java.lang.String>> getTemplateKeys(org.eclipse.jetty.server.Request base)

Generates a map of template keys with their value suppliers in order to fill gaps in the html skeleton template page.

Parameters:

base - The request

Returns:

The target map of template keys with their value suppliers