net.officefloor.plugin.woof.servlet

Class WoofServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

net.officefloor.plugin.servlet.OfficeFloorServlet

net.officefloor.plugin.woof.servlet.WoofServlet

All Implemented Interfaces:

Serializable, EventListener, javax.servlet.Filter, javax.servlet.Servlet, javax.servlet.ServletConfig, javax.servlet.ServletContextListener

Direct Known Subclasses:

ExampleServlet

public class WoofServlet
extends OfficeFloorServlet

WoOF (Web on OfficeFloor) Servlet.

This Servlet enables embedding WoOF functionality within a JEE Servlet Application. To enable handling the appropriate HttpServletRequest instances this should be configured as a ServletContextListener.

Author:

Daniel Sagenschneider

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_OBJECTS_CONFIGURATION_LOCATION Default Objects configuration location.
static String	DEFAULT_TEAMS_CONFIGURATION_LOCATION Default Teams configuration location.
static String	DEFAULT_WOOF_CONFIGUARTION_LOCATION Default WoOF configuration location.
static String	PROPERTY_OBJECTS_CONFIGURATION_LOCATION Property for the location of the Objects configuration.
static String	PROPERTY_TEAMS_CONFIGURATION_LOCATION Property for the location of the Teams configuration.
static String	PROPERTY_WOOF_CONFIGURATION_LOCATION Property for the location of the WoOF configuration.
static String	SERVLET_NAME Name that this WoofServlet should be registered.

Constructor Summary

Constructors

Constructor and Description
WoofServlet()

Method Summary

Modifier and Type	Method and Description
boolean	configure(WebAutoWireApplication application, javax.servlet.ServletContext servletContext) Provides configuration of the WebAutoWireApplication for this OfficeFloorServlet.
String	getServletName() Obtains the name to register this Servlet.
String	getTemplateUriSuffix() Obtains the HttpTemplate URI suffix.

Methods inherited from class net.officefloor.plugin.servlet.OfficeFloorServlet

contextDestroyed, contextInitialized, destroy, doFilter, getInitParameter, getServletInfo, init, init, service

Methods inherited from class javax.servlet.http.HttpServlet

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

Methods inherited from class javax.servlet.GenericServlet

getInitParameterNames, getServletConfig, getServletContext, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

SERVLET_NAME

public static final String SERVLET_NAME

Name that this WoofServlet should be registered.

This enables web-fragment functionality to determine if an implementation of the WoofServlet has been configured or whether one should be automatically configured.

See Also:

Constant Field Values

DEFAULT_WOOF_CONFIGUARTION_LOCATION

public static final String DEFAULT_WOOF_CONFIGUARTION_LOCATION

Default WoOF configuration location.

See Also:

Constant Field Values

PROPERTY_WOOF_CONFIGURATION_LOCATION

public static final String PROPERTY_WOOF_CONFIGURATION_LOCATION

Property for the location of the WoOF configuration.

See Also:

Constant Field Values

DEFAULT_OBJECTS_CONFIGURATION_LOCATION

public static final String DEFAULT_OBJECTS_CONFIGURATION_LOCATION

Default Objects configuration location.

See Also:

Constant Field Values

PROPERTY_OBJECTS_CONFIGURATION_LOCATION

public static final String PROPERTY_OBJECTS_CONFIGURATION_LOCATION

Property for the location of the Objects configuration.

See Also:

Constant Field Values

DEFAULT_TEAMS_CONFIGURATION_LOCATION

public static final String DEFAULT_TEAMS_CONFIGURATION_LOCATION

Default Teams configuration location.

See Also:

Constant Field Values

PROPERTY_TEAMS_CONFIGURATION_LOCATION

public static final String PROPERTY_TEAMS_CONFIGURATION_LOCATION

Property for the location of the Teams configuration.

See Also:

Constant Field Values

Constructor Detail

WoofServlet

public WoofServlet()

Method Detail

getServletName

public String getServletName()

Description copied from class: OfficeFloorServlet

Obtains the name to register this Servlet.

Specified by:

getServletName in interface javax.servlet.ServletConfig

Specified by:

getServletName in class OfficeFloorServlet

Returns:

Name to register this Servlet.

getTemplateUriSuffix

public String getTemplateUriSuffix()

Description copied from class: OfficeFloorServlet

Obtains the HttpTemplate URI suffix.

Must provide a URI suffix to enable Servlet mapping for link URL continuations.

Specified by:

getTemplateUriSuffix in class OfficeFloorServlet

Returns:

HttpTemplate URI suffix.

configure

public boolean configure(WebAutoWireApplication application,
                         javax.servlet.ServletContext servletContext)
                  throws Exception

Description copied from class: OfficeFloorServlet

Provides configuration of the WebAutoWireApplication for this OfficeFloorServlet.

Specified by:

configure in class OfficeFloorServlet

Parameters:

application - WebAutoWireApplication.

servletContext - ServletContext.

Returns:

true to load the OfficeFloorServlet. false does not configure it.

Throws:

Exception - If fails to configure.