org.bimserver.plugins.web

Class AbstractWebModulePlugin

java.lang.Object

org.bimserver.plugins.web.AbstractWebModulePlugin

All Implemented Interfaces:

Plugin, WebModulePlugin

Direct Known Subclasses:

JsonWebModule

public abstract class AbstractWebModulePlugin
extends Object
implements WebModulePlugin

Field Summary

Fields

Modifier and Type	Field and Description
static String	FAR_FUTURE_EXPIRE_DATE

Constructor Summary

Constructors

Constructor and Description
AbstractWebModulePlugin()

Method Summary

Modifier and Type	Method and Description
static DateFormat	expiresDateFormat()
abstract String	getDefaultContextPath()
abstract String	getIdentifier()
abstract String	getInternalPath()
PluginContext	getPluginContext()
ObjectDefinition	getSystemSettingsDefinition()
ObjectDefinition	getUserSettingsDefinition()
void	init(PluginContext pluginContext, PluginConfiguration systemSettings)
boolean	service(String requestUri, javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse response) Handles the individual requests, just like a servlet

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bimserver.plugins.web.WebModulePlugin

getPluginType

Field Detail

FAR_FUTURE_EXPIRE_DATE

public static final String FAR_FUTURE_EXPIRE_DATE

Constructor Detail

AbstractWebModulePlugin

public AbstractWebModulePlugin()

Method Detail

expiresDateFormat

public static DateFormat expiresDateFormat()

init

public void init(PluginContext pluginContext,
                 PluginConfiguration systemSettings)
          throws PluginException

Specified by:

init in interface Plugin

Throws:

PluginException

service

public boolean service(String requestUri,
                       javax.servlet.http.HttpServletRequest httpServletRequest,
                       javax.servlet.http.HttpServletResponse response)

Description copied from interface: WebModulePlugin

Handles the individual requests, just like a servlet

Specified by:

service in interface WebModulePlugin

Parameters:

requestUri - Request URL

response - The HTTP response

getIdentifier

public abstract String getIdentifier()

Returns:

An identifier for this specific WebModule that will be used in the version-string that can be used for caching purposes

getInternalPath

public abstract String getInternalPath()

Returns:

getDefaultContextPath

public abstract String getDefaultContextPath()

Returns:

The context path on which to serve this webmodule

getUserSettingsDefinition

public ObjectDefinition getUserSettingsDefinition()

Specified by:

getUserSettingsDefinition in interface Plugin

getSystemSettingsDefinition

public ObjectDefinition getSystemSettingsDefinition()

Specified by:

getSystemSettingsDefinition in interface Plugin

getPluginContext

public PluginContext getPluginContext()