com.github.bordertech.wcomponents.lde

Class TestServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.github.bordertech.wcomponents.servlet.WServlet

com.github.bordertech.wcomponents.lde.TestServlet

All Implemented Interfaces:

LdeLauncher, Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

Direct Known Subclasses:

PlainLauncher

public abstract class TestServlet
extends WServlet
implements LdeLauncher

Enables WComponents to be run in a LDE environment.

Since:

1.0.0

Author:

James Gifford

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.github.bordertech.wcomponents.servlet.WServlet

WServlet.WServletEnvironment, WServlet.WServletHelper

Field Summary

Fields inherited from class com.github.bordertech.wcomponents.servlet.WServlet

AJAX_TRIGGER_PARAM_NAME, DATA_LIST_PARAM_NAME, STATIC_RESOURCE_PARAM_NAME, TARGET_ID_PARAM_NAME

Constructor Summary

Constructors

Constructor and Description
TestServlet()

Method Summary

Methods

Modifier and Type	Method and Description
void	addIndirectJar(String jarname)
protected org.eclipse.jetty.webapp.WebAppContext	createWebApp(org.eclipse.jetty.server.Server srv) Creates the Web app context to use in the LDE.
protected String[]	getResourceDir()
protected String[]	getThemeWebdocs()
String	getUrl()
protected String[]	getWebdocsDir()
boolean	isRunning()
protected boolean	isShutdownEnabled() Indicates whether remote LDE shutdown is enabled.
protected void	registerServlets(org.eclipse.jetty.webapp.WebAppContext webapp) Subclasses may override this to register additional servlets with the server.
void	run() Runs the server.
protected void	service(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Override service in order to support persistant sessions.
void	service(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res)
protected void	shutDown() Attempts to shutdown an existing TestServlet, possibly in another VM.
void	stop() Stops the server.

Methods inherited from class com.github.bordertech.wcomponents.servlet.WServlet

addGenericHeaders, createInterceptorChain, createServletHelper, getUI, handleError, init, serviceInt

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

TestServlet

public TestServlet()

Method Detail

run

public void run()
         throws Exception

Runs the server.

Specified by:

run in interface LdeLauncher

Throws:

Exception - if the LDE fails to start.

service

public void service(javax.servlet.ServletRequest req,
           javax.servlet.ServletResponse res)
             throws javax.servlet.ServletException,
                    IOException

Specified by:

service in interface javax.servlet.Servlet

Overrides:

service in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

shutDown

protected void shutDown()

Attempts to shutdown an existing TestServlet, possibly in another VM.

createWebApp

protected org.eclipse.jetty.webapp.WebAppContext createWebApp(org.eclipse.jetty.server.Server srv)
                                                       throws Exception

Creates the Web app context to use in the LDE. The context will be registered with the given server.

Parameters:

srv - the Jetty server.

Returns:

the newly created Web app context.

Throws:

Exception - an exception

stop

public void stop()
          throws InterruptedException

Stops the server.

Specified by:

stop in interface LdeLauncher

Throws:

InterruptedException - an interrupted exception

isRunning

public boolean isRunning()

Specified by:

isRunning in interface LdeLauncher

Returns:

true if the server is running, else false.

getUrl

public String getUrl()

Specified by:

getUrl in interface LdeLauncher

Returns:

the URL where this servlet can be accessed from.

addIndirectJar

public void addIndirectJar(String jarname)

Parameters:

jarname - the jar name to add

getWebdocsDir

protected String[] getWebdocsDir()

Returns:

the webdocs directory, or null if not defined.

getThemeWebdocs

protected String[] getThemeWebdocs()

Returns:

the theme webdocs directory, or null if not defined.

getResourceDir

protected String[] getResourceDir()

Returns:

the resource directory, or null if not defined.

service

protected void service(javax.servlet.http.HttpServletRequest request,
           javax.servlet.http.HttpServletResponse response)
                throws javax.servlet.ServletException,
                       IOException

Override service in order to support persistant sessions.

Overrides:

service in class WServlet

Parameters:

request - the request being processed

response - the response

Throws:

javax.servlet.ServletException - a servlet exception

IOException - an IO exception

registerServlets

protected void registerServlets(org.eclipse.jetty.webapp.WebAppContext webapp)

Subclasses may override this to register additional servlets with the server.

Parameters:

webapp - the webapp to register the servlets with.

isShutdownEnabled

protected boolean isShutdownEnabled()

Indicates whether remote LDE shutdown is enabled.

Returns:

true if shutdown is enabled, false otherwise.