org.bedework.synch.web

Class MethodBase

java.lang.Object

org.bedework.synch.web.MethodBase

All Implemented Interfaces:

org.bedework.util.logging.Logged

Direct Known Subclasses:

PostMethod

public abstract class MethodBase
extends Object
implements org.bedework.util.logging.Logged

Base class for all webdav servlet methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MethodBase.MethodInfo Allow servlet to create method.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	dumpContent
protected SynchEngine	syncher

Constructor Summary

Constructors

Constructor and Description
MethodBase()

Method Summary

Modifier and Type	Method and Description
protected void	addHeaders(javax.servlet.http.HttpServletResponse resp)
abstract void	doMethod(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
static List<String>	fixPath(String path) Return a path, broken into its elements, after "." and ".." are removed.
protected String	formatHTTPDate(Timestamp val)
org.bedework.util.logging.BwLogger	getLogger()
List<String>	getResourceUri(javax.servlet.http.HttpServletRequest req) Get the decoded and fixed resource URI.
SynchEngine	getSyncher() Get syncher
abstract void	init() Called at each request
void	init(SynchEngine syncher, boolean dumpContent) Called at each request
protected Document	parseContent(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) Parse the request body, and return the DOM representation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bedework.util.logging.Logged

audit, debug, debug, enableAuditLogger, enableErrorLogger, enableMetricsLogger, error, error, error, info, isAuditLoggerEnabled, isErrorLoggerEnabled, isMetricsDebugEnabled, isMetricsLoggerEnabled, metrics, setLoggerClass, setLoggerClass, trace, trace, warn

Field Detail

dumpContent

protected boolean dumpContent

syncher

protected SynchEngine syncher

Constructor Detail

MethodBase

public MethodBase()

Method Detail

init

public abstract void init()
                   throws SynchException

Called at each request

Throws:

SynchException - on fatal error

doMethod

public abstract void doMethod(javax.servlet.http.HttpServletRequest req,
                              javax.servlet.http.HttpServletResponse resp)
                       throws SynchException

Parameters:

req - http request

resp - http response

Throws:

SynchException - on fatal error

init

public void init(SynchEngine syncher,
                 boolean dumpContent)
          throws SynchException

Called at each request

Parameters:

syncher - the synch engine

dumpContent - true for debug dums of content

Throws:

SynchException - on init failure

getSyncher

public SynchEngine getSyncher()

Get syncher

Returns:

ExchangeSynch

getResourceUri

public List<String> getResourceUri(javax.servlet.http.HttpServletRequest req)

Get the decoded and fixed resource URI. This calls getServletPath() to obtain the path information. The description of that method is a little obscure in it's meaning. In a request of this form:

"GET /ucaldav/user/douglm/calendar/1302064354993-g.ics HTTP/1.1[\r][\n]"

getServletPath() will return

/user/douglm/calendar/1302064354993-g.ics

that is the context has been removed. In addition this method will URL decode the path. getRequestUrl() does neither.

Parameters:

req - Servlet request object

Returns:

List Path elements of fixed up uri

fixPath

public static List<String> fixPath(String path)

Return a path, broken into its elements, after "." and ".." are removed. If the parameter path attempts to go above the root we return null. Other than the backslash thing why not use URI?

Parameters:

path - String path to be fixed

Returns:

fixed path broken into elements or null for bad or missing path

addHeaders

protected void addHeaders(javax.servlet.http.HttpServletResponse resp)
                   throws SynchException

Throws:

SynchException

parseContent

protected Document parseContent(javax.servlet.http.HttpServletRequest req,
                                javax.servlet.http.HttpServletResponse resp)
                         throws SynchException

Parse the request body, and return the DOM representation.

Parameters:

req - Servlet request object

resp - Servlet response object for bad status

Returns:

Document Parsed body or null for no body

Throws:

SynchException - Some error occurred.

formatHTTPDate

protected String formatHTTPDate(Timestamp val)

getLogger

public org.bedework.util.logging.BwLogger getLogger()

Specified by:

getLogger in interface org.bedework.util.logging.Logged