com.github.bordertech.wcomponents.lde

Class PlainLauncher

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.github.bordertech.wcomponents.servlet.WServlet

com.github.bordertech.wcomponents.lde.TestServlet

com.github.bordertech.wcomponents.lde.PlainLauncher

All Implemented Interfaces:

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

Direct Known Subclasses:

StandaloneLauncher.MyLauncher

public class PlainLauncher
extends TestServlet

This class enables easy running of a shared WComponent instance in a Jetty servlet container for development and testing purposes.

You need to set the class name of the WComponent you want to run. Do this by setting the parameter "bordertech.wcomponents.lde.component.to.launch" in your "local_app.properties" file. E.g.

 ui.web.component.to.launch = com.github.bordertech.wcomponents.examples.picker.ExamplePicker
 

Since:

1.0.0

Author:

Martin Shevchenko

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

Modifier and Type	Field and Description
static String	COMPONENT_TO_LAUNCH_PARAM_KEY The configuration property key for which component to launch.
protected static String	SHOW_MEMORY_PROFILE_PARAM_KEY The configuration property key for whether to display the memory profile.

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
PlainLauncher()

Method Summary

Methods

Modifier and Type	Method and Description
InterceptorComponent	createInterceptorChain(Object request)
protected WComponent	createUI() Creates the UI which the launcher displays.
protected String	getComponentToLaunchClassName()
WComponent	getUI(Object httpServletRequest) This method has been overridden to load a WComponent from parameters.
static void	main(String[] args) The entry point when the launcher is run as a java application.
protected void	service(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Override service in order to support persistant sessions.

Methods inherited from class com.github.bordertech.wcomponents.lde.TestServlet

addIndirectJar, createWebApp, getResourceDir, getThemeWebdocs, getUrl, getWebdocsDir, isRunning, isShutdownEnabled, registerServlets, run, service, shutDown, stop

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

addGenericHeaders, createServletHelper, 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

Field Detail

COMPONENT_TO_LAUNCH_PARAM_KEY

public static final String COMPONENT_TO_LAUNCH_PARAM_KEY

The configuration property key for which component to launch.

See Also:

Constant Field Values

SHOW_MEMORY_PROFILE_PARAM_KEY

protected static final String SHOW_MEMORY_PROFILE_PARAM_KEY

The configuration property key for whether to display the memory profile.

See Also:

Constant Field Values

Constructor Detail

PlainLauncher

public PlainLauncher()

Method Detail

getUI

public WComponent getUI(Object httpServletRequest)

This method has been overridden to load a WComponent from parameters.

Overrides:

getUI in class WServlet

Parameters:

httpServletRequest - the servlet request being handled.

Returns:

the top-level WComponent for this servlet.

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 TestServlet

Parameters:

request - the request being processed

response - the response

Throws:

javax.servlet.ServletException - a servlet exception

IOException - an IO exception

createInterceptorChain

public InterceptorComponent createInterceptorChain(Object request)

Overrides:

createInterceptorChain in class WServlet

createUI

protected WComponent createUI()

Creates the UI which the launcher displays. If there is misconfiguration or error, a UI containing an error message is returned.

Returns:

the UI which the launcher displays.

getComponentToLaunchClassName

protected String getComponentToLaunchClassName()

Returns:

the class name of the component to launch.

main

public static void main(String[] args)
                 throws Exception

The entry point when the launcher is run as a java application.

Parameters:

args - command-line arguments, ignored.

Throws:

Exception - on error