org.bedework.webdav.servlet.shared

Class WebdavNsIntf

java.lang.Object

org.bedework.webdav.servlet.shared.WebdavNsIntf

All Implemented Interfaces:

Serializable, org.bedework.util.logging.Logged

public abstract class WebdavNsIntf
extends Object
implements org.bedework.util.logging.Logged, Serializable

This acts as an interface to the underlying namespace for which this servlet is acting as a gateway. This could be a file system, a set of dynamically created objects or some sort of CMS for example. A namespace consists of a number of nodes which may be containers for other nodes or leaf nodes. All nodes are considered identical in their capabilities, that is, a non-terminal node might contain content. Some nodes are aliases of other nodes (e.g. symlinks in a unix file system). By default these aliases will be followed.

Author:

Mike Douglass

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebdavNsIntf.AclInfo Object class passed around as we parse access.
static class	WebdavNsIntf.Content
static class	WebdavNsIntf.PutContentResult Result for putContent
protected static class	WebdavNsIntf.SessCt

Field Summary

Fields

Modifier and Type	Field and Description
protected String	account
protected boolean	anonymous
protected boolean	dumpContent
static int	existanceDoesExist We know it exists.
static int	existanceMay May exist
static int	existanceMust Must exist.
static int	existanceNot Must not exist
protected HashMap<String,MethodBase.MethodInfo>	methods Table of methods - set by servlet
static int	nodeTypeCollection Must be collection
static int	nodeTypeEntity Must be entity.
static int	nodeTypePrincipal Must be a principal.
static int	nodeTypeUnknown Unknown.
protected WebdavServlet	servlet
protected static WebdavNsIntf.SessCt	session Mostly to distinguish trace entries
protected int	sessNum
protected org.bedework.util.xml.XmlEmit	xml

Constructor Summary

Constructors

Constructor and Description
WebdavNsIntf()

Method Summary

Modifier and Type	Method and Description
abstract void	acceptMkcolContent(javax.servlet.http.HttpServletRequest req) Throw an exception if we don't want the content for mkcol.
void	addNamespace(org.bedework.util.xml.XmlEmit xml) Add any namespaces for xml tag names in requests and responses.
void	addStatus(int status)
abstract boolean	canPut(WebdavNsNode node) Return true if we can PUT this resource/entity
abstract void	close() Called on the way out to allow resources to be freed.
void	closePropstat() Close a propstat response with an ok result.
void	closePropstat(int status) Close a propstat response with given result.
abstract void	copyMove(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, WebdavNsNode from, WebdavNsNode to, boolean copy, boolean overwrite, int depth) Copy or move a resource at the given location to another location.
abstract void	create(WebdavNsNode node) Create a new node.
abstract void	createAlias(WebdavNsNode alias) Creates an alias to another node.
abstract void	delete(WebdavNsNode node) Deletes a node from the namespace.
abstract void	emitAcl(WebdavNsNode node)
void	emitError(QName errorTag, String extra, org.bedework.util.xml.XmlEmit xml) Emit some failed precondition tag
void	emitSupportedReportSet(WebdavNsNode node)
static String	fixPath(String path) Return a path, beginning with a "/", after "." and ".." are removed.
protected String	generateHtml(javax.servlet.http.HttpServletRequest req, WebdavNsNode node) Return a String giving an HTML representation of the directory.
boolean	generatePropValue(WebdavNsNode node, WebdavProperty pr, boolean allProp) Generate a response for a single webdav property.
abstract String	getAcceptContentType(javax.servlet.http.HttpServletRequest req)
abstract boolean	getAccessControl() Returns true if the namespace supports access control
abstract AccessUtil	getAccessUtil() Get an object suitable for use in parsing acls and generating access.
String	getAccount()
abstract Collection<String>	getAclPrincipalInfo(WebdavNsNode node) Return all the hrefs found in the access for th egiven node.
abstract String	getAddMemberSuffix()
boolean	getAnonymous()
abstract WebdavNsIntf.Content	getBinaryContent(WebdavNsNode node) Returns a Content object for the binary content.
Element[]	getChildren(Node nd) Get all the children if any
abstract Collection<WebdavNsNode>	getChildren(WebdavNsNode node, java.util.function.Supplier<Object> filterGetter) Returns the immediate children of a node.
abstract WebdavNsIntf.Content	getContent(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, String contentType, WebdavNsNode node) Returns a Content object for the content.
String	getDavHeader(WebdavNsNode node) Return DAV header
abstract boolean	getDirectoryBrowsingDisallowed() Return true if the system disallows directory browsing.
String	getElementContent(Element el)
abstract Collection<WebdavNsNode>	getGroups(String resourceUri, String principalUrl) Given a PrincipalMatchReport returns a Collection of matching nodes.
String	getLocation(WebdavNsNode node) Return the complete URL describing the location of the object represented by the node
org.bedework.util.logging.BwLogger	getLogger()
MethodBase	getMethod(String name) Return the named initialised method or null if no such method or the method requires authentication and we are anonymous
Collection<String>	getMethodNames()
abstract WebdavNsNode	getNode(String uri, int existence, int nodeType, boolean addMember) Retrieves a node by uri, following any links.
Element	getOnlyChild(Node nd) We expect a single child
abstract WebdavNsNode	getParent(WebdavNsNode node) Returns the parent of a node.
abstract Collection<String>	getPrincipalCollectionSet(String resourceUri) Given a uri returns a Collection of uris that allow search operations on principals for that resource.
abstract Collection<? extends WebdavNsNode>	getPrincipals(String resourceUri, PrincipalPropertySearch pps) Given a PrincipalPropertySearch returns a Collection of matching nodes.
Reader	getReader(javax.servlet.http.HttpServletRequest req)
javax.servlet.http.HttpServletRequest	getRequest()
String	getResourceUri(javax.servlet.http.HttpServletRequest req) Get the decoded and fixed resource URI.
boolean	getReturnMultistatusOk()
ServerInfo	getServerInfo()
WebdavServlet	getServlet()
abstract String	getSupportedLocks() Returns the supported locks for the supportedlock property.
abstract WdSynchReport	getSynchReport(String path, String token, int limit, boolean recurse)
abstract String	getSyncToken(String path) Used to match tokens in If header
String	getUri(String href) Return the part of the href referring to the actual entity, e.g.
org.bedework.util.xml.XmlEmit	getXmlEmit()
void	init(WebdavServlet servlet, javax.servlet.http.HttpServletRequest req, HashMap<String,MethodBase.MethodInfo> methods, boolean dumpContent) Called before any other method is called to allow initialisation to take place at the first or subsequent requests
boolean	knownProperty(WebdavNsNode node, WebdavProperty pr) Return true if a call to generatePropValue will return a value.
abstract void	makeCollection(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, WebdavNsNode node) Create an empty collection at the given location.
String	makeName(String val) Turn val into something which can be used as a name for an entity.
WebdavProperty	makeProp(Element propnode) Override this to create namespace specific property objects.
String	makeServerInfoUrl(javax.servlet.http.HttpServletRequest req) TODO - make the url value configurable
abstract String	makeUserHref(String id)
String	normalizeUri(String uri)
void	openPropstat() Open a propstat response.
List<WebdavProperty>	parseProp(Node nd) Parse a DAV:prop list of property names in any namespace.
boolean	prefetch(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, WebdavNsNode node) Called before fetching in GET processing.
abstract WebdavNsIntf.PutContentResult	putBinaryContent(javax.servlet.http.HttpServletRequest req, WebdavNsNode node, String[] contentTypePars, InputStream contentStream, Headers.IfHeaders ifHeaders) Set the content from a Stream
abstract WebdavNsIntf.PutContentResult	putContent(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, WebdavNsNode node, String[] contentTypePars, Reader contentRdr, Headers.IfHeaders ifHeaders) Set the content from a Reader
WebdavNsIntf.PutContentResult	putContent(javax.servlet.http.HttpServletRequest req, String resourceUri, javax.servlet.http.HttpServletResponse resp, boolean fromPost, Headers.IfHeaders ifHeaders) Put content for the PUT or POST methods
abstract void	putNode(WebdavNsNode node) Stores/updates an object.
abstract void	rollback() Called on the way out before close if there was an error.
abstract boolean	specialUri(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, String resourceUri) Handle a special resource uri for GET.
void	streamContent(InputStream in, OutputStream out)
boolean	syncTokenMatch(Headers.IfHeader ih)
abstract void	updateAccess(WebdavNsIntf.AclInfo ainfo)
void	writeContent(Reader in, Writer out)

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

session

protected static volatile WebdavNsIntf.SessCt session

Mostly to distinguish trace entries

sessNum

protected int sessNum

servlet

protected WebdavServlet servlet

account

protected String account

anonymous

protected boolean anonymous

dumpContent

protected boolean dumpContent

xml

protected org.bedework.util.xml.XmlEmit xml

methods

protected HashMap<String,MethodBase.MethodInfo> methods

Table of methods - set by servlet

existanceNot

public static final int existanceNot

Must not exist

See Also:

Constant Field Values

existanceMust

public static final int existanceMust

Must exist.

See Also:

Constant Field Values

existanceDoesExist

public static final int existanceDoesExist

We know it exists.

See Also:

Constant Field Values

existanceMay

public static final int existanceMay

May exist

See Also:

Constant Field Values

nodeTypeCollection

public static final int nodeTypeCollection

Must be collection

See Also:

Constant Field Values

nodeTypeEntity

public static final int nodeTypeEntity

Must be entity.

See Also:

Constant Field Values

nodeTypePrincipal

public static final int nodeTypePrincipal

Must be a principal.

See Also:

Constant Field Values

nodeTypeUnknown

public static final int nodeTypeUnknown

Unknown.

See Also:

Constant Field Values

Constructor Detail

WebdavNsIntf

public WebdavNsIntf()

Method Detail

init

public void init(WebdavServlet servlet,
                 javax.servlet.http.HttpServletRequest req,
                 HashMap<String,MethodBase.MethodInfo> methods,
                 boolean dumpContent)
          throws WebdavException

Called before any other method is called to allow initialisation to take place at the first or subsequent requests

Parameters:

servlet -

req -

methods - HashMap table of method info

dumpContent -

Throws:

WebdavException - on error

getAccount

public String getAccount()

Returns:

String

getXmlEmit

public org.bedework.util.xml.XmlEmit getXmlEmit()

Returns:

XmlEmit xmlemitter

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

Returns:

HttpServletRequest

getDavHeader

public String getDavHeader(WebdavNsNode node)
                    throws WebdavException

Return DAV header

Parameters:

node - may be null for *

Returns:

String

Throws:

WebdavException - on error

getServerInfo

public ServerInfo getServerInfo()

Returns:

server info populated for basic webdav

syncTokenMatch

public boolean syncTokenMatch(Headers.IfHeader ih)
                       throws WebdavException

Parameters:

ih -

Returns:

false for a mismatch

Throws:

WebdavException - for invalid if header

emitError

public void emitError(QName errorTag,
                      String extra,
                      org.bedework.util.xml.XmlEmit xml)
               throws Throwable

Emit some failed precondition tag

Parameters:

errorTag -

extra -

xml -

Throws:

Throwable

getAccessUtil

public abstract AccessUtil getAccessUtil()
                                  throws WebdavException

Get an object suitable for use in parsing acls and generating access.

Returns:

AccessUtil implementation.

Throws:

WebdavException - on error

canPut

public abstract boolean canPut(WebdavNsNode node)
                        throws WebdavException

Return true if we can PUT this resource/entity

Parameters:

node -

Returns:

boolean

Throws:

WebdavException - on error

getAddMemberSuffix

public abstract String getAddMemberSuffix()
                                   throws WebdavException

Returns:

- null if DAV:add-member not supported

Throws:

WebdavException - on error

getMethodNames

public Collection<String> getMethodNames()

Returns:

Collection of method names.

getMethod

public MethodBase getMethod(String name)
                     throws WebdavException

Return the named initialised method or null if no such method or the method requires authentication and we are anonymous

Parameters:

name - name

Returns:

MethodBase object or null

Throws:

WebdavException - on error

getAnonymous

public boolean getAnonymous()

Returns:

boolean true for anon access

getUri

public String getUri(String href)
              throws WebdavException

Return the part of the href referring to the actual entity, e.g.
for http://localhost/ucaldav/user/caluser/calendar/2656-uwcal-demouwcalendar@mysite.edu.ics
user/caluser/calendar/2656-uwcal-demouwcalendar@mysite.edu.ics

Parameters:

href -

Returns:

String

Throws:

WebdavException - on error

makeName

public String makeName(String val)

Turn val into something which can be used as a name for an entity. This involves removing path delimiters such as "/".

Parameters:

val -

Returns:

modified name

getServlet

public WebdavServlet getServlet()

Returns:

WebdavServlet

getReturnMultistatusOk

public boolean getReturnMultistatusOk()

Returns:

boolean

addNamespace

public void addNamespace(org.bedework.util.xml.XmlEmit xml)
                  throws WebdavException

Add any namespaces for xml tag names in requests and responses. An abbreviation will be supplied by the servlet. The name should be globally unique in a global sense so don't return something like "RPI:"

Something more like "http://ahost.rpi.edu/webdav/"

Parameters:

xml -

Throws:

WebdavException - on error

getDirectoryBrowsingDisallowed

public abstract boolean getDirectoryBrowsingDisallowed()
                                                throws WebdavException

Return true if the system disallows directory browsing.

Returns:

boolean

Throws:

WebdavException - on error

rollback

public abstract void rollback()

Called on the way out before close if there was an error.

close

public abstract void close()
                    throws WebdavException

Called on the way out to allow resources to be freed.

Throws:

WebdavException - on error

getSupportedLocks

public abstract String getSupportedLocks()

Returns the supported locks for the supportedlock property.

To ensure these will work always provide the full namespace "DAV:" for example, the result for supported exclusive and shared write locks would be the string "<DAV:lockentry>" + " <DAV:lockscope><DAV:exclusive/><DAV:/lockscope>" + " <DAV:locktype><DAV:write/><DAV:/locktype>" + "<DAV:/lockentry>" + "<DAV:lockentry>" + " <DAV:lockscope><DAV:shared/><DAV:/lockscope>" + "<DAV:/lockentry>"

Returns:

String response

getAccessControl

public abstract boolean getAccessControl()

Returns true if the namespace supports access control

Returns:

boolean

getNode

public abstract WebdavNsNode getNode(String uri,
                                     int existence,
                                     int nodeType,
                                     boolean addMember)
                              throws WebdavException

Retrieves a node by uri, following any links.

Parameters:

uri - String decoded uri of the node to retrieve

existence - Say's something about the state of existence

nodeType - Say's something about the type of node

addMember - Called from POST with addMember

Returns:

WebdavNsNode node specified by the URI or the node aliased by the node at the URI.

Throws:

WebdavException - on error

putNode

public abstract void putNode(WebdavNsNode node)
                      throws WebdavException

Stores/updates an object.

Parameters:

node - node in question

Throws:

WebdavException - on error

delete

public abstract void delete(WebdavNsNode node)
                     throws WebdavException

Deletes a node from the namespace.

Parameters:

node - node in question

Throws:

WebdavException - on error

getChildren

public abstract Collection<WebdavNsNode> getChildren(WebdavNsNode node,
                                                     java.util.function.Supplier<Object> filterGetter)
                                              throws WebdavException

Returns the immediate children of a node.

Parameters:

node - node in question

Returns:

Collection of WebdavNsNode children

Throws:

WebdavException - on error

getParent

public abstract WebdavNsNode getParent(WebdavNsNode node)
                                throws WebdavException

Returns the parent of a node.

Parameters:

node - node in question

Returns:

WebdavNsNode node's parent, or null if the specified node is the root

Throws:

WebdavException - on error

prefetch

public boolean prefetch(javax.servlet.http.HttpServletRequest req,
                        javax.servlet.http.HttpServletResponse resp,
                        WebdavNsNode node)
                 throws WebdavException

Called before fetching in GET processing. ALlows implementations to add some pre-processing, for instance the schedule-tag processing in CalDAV.

This method handles etag processing.

Parameters:

req -

resp -

node - - the node

Returns:

true - just proceed otherwise status is set

Throws:

WebdavException - on error

getContent

public abstract WebdavNsIntf.Content getContent(javax.servlet.http.HttpServletRequest req,
                                                javax.servlet.http.HttpServletResponse resp,
                                                String contentType,
                                                WebdavNsNode node)
                                         throws WebdavException

Returns a Content object for the content.

Parameters:

req -

resp -

contentType - if non-null specifies the content we want

node - node in question

Returns:

content.

Throws:

WebdavException - on error

getBinaryContent

public abstract WebdavNsIntf.Content getBinaryContent(WebdavNsNode node)
                                               throws WebdavException

Returns a Content object for the binary content.

Parameters:

node - node in question

Returns:

content.

Throws:

WebdavException - on error

getAcceptContentType

public abstract String getAcceptContentType(javax.servlet.http.HttpServletRequest req)
                                     throws WebdavException

Returns:

a valid content type string

Throws:

WebdavException

putContent

public WebdavNsIntf.PutContentResult putContent(javax.servlet.http.HttpServletRequest req,
                                                String resourceUri,
                                                javax.servlet.http.HttpServletResponse resp,
                                                boolean fromPost,
                                                Headers.IfHeaders ifHeaders)
                                         throws WebdavException

Put content for the PUT or POST methods

Parameters:

req - the request

resourceUri - if not null use this otherwise obtain from request

resp - the response

fromPost - POST style - create

ifHeaders - info from headers

Returns:

PutContentResult result of creating

Throws:

WebdavException - on error

writeContent

public void writeContent(Reader in,
                         Writer out)
                  throws WebdavException

Parameters:

in -

out -

Throws:

WebdavException - on error

streamContent

public void streamContent(InputStream in,
                          OutputStream out)
                   throws WebdavException

Parameters:

in -

out -

Throws:

WebdavException - on error

normalizeUri

public String normalizeUri(String uri)
                    throws WebdavException

Parameters:

uri - to check

Returns:

normalized form

Throws:

WebdavException - on error

putContent

public abstract WebdavNsIntf.PutContentResult putContent(javax.servlet.http.HttpServletRequest req,
                                                         javax.servlet.http.HttpServletResponse resp,
                                                         WebdavNsNode node,
                                                         String[] contentTypePars,
                                                         Reader contentRdr,
                                                         Headers.IfHeaders ifHeaders)
                                                  throws WebdavException

Set the content from a Reader

Parameters:

req -

resp - For any additional headers

node - node in question.

contentTypePars - null or values from content-type header

contentRdr - Reader for content

ifHeaders - info from headers

Returns:

PutContentResult result of creating

Throws:

WebdavException - on error

putBinaryContent

public abstract WebdavNsIntf.PutContentResult putBinaryContent(javax.servlet.http.HttpServletRequest req,
                                                               WebdavNsNode node,
                                                               String[] contentTypePars,
                                                               InputStream contentStream,
                                                               Headers.IfHeaders ifHeaders)
                                                        throws WebdavException

Set the content from a Stream

Parameters:

req -

node - node in question.

contentTypePars - null or values from content-type header

contentStream - Stream for content

ifHeaders - info from headers

Returns:

PutContentResult result of creating

Throws:

WebdavException - on error

create

public abstract void create(WebdavNsNode node)
                     throws WebdavException

Create a new node.

Parameters:

node - node to create with new uri set

Throws:

WebdavException - on error

createAlias

public abstract void createAlias(WebdavNsNode alias)
                          throws WebdavException

Creates an alias to another node.

Parameters:

alias - alias node that should be created with uri and targetUri set

Throws:

WebdavException - on error

acceptMkcolContent

public abstract void acceptMkcolContent(javax.servlet.http.HttpServletRequest req)
                                 throws WebdavException

Throw an exception if we don't want the content for mkcol.

Parameters:

req - HttpServletRequest

Throws:

WebdavException - on error

makeCollection

public abstract void makeCollection(javax.servlet.http.HttpServletRequest req,
                                    javax.servlet.http.HttpServletResponse resp,
                                    WebdavNsNode node)
                             throws WebdavException

Create an empty collection at the given location. Status is set on return

Parameters:

req - HttpServletRequest

resp - HttpServletResponse

node - node to create

Throws:

WebdavException - on error

copyMove

public abstract void copyMove(javax.servlet.http.HttpServletRequest req,
                              javax.servlet.http.HttpServletResponse resp,
                              WebdavNsNode from,
                              WebdavNsNode to,
                              boolean copy,
                              boolean overwrite,
                              int depth)
                       throws WebdavException

Copy or move a resource at the given location to another location. Status is set on return

Parameters:

req - HttpServletRequest

resp - HttpServletResponse

from - Source

to - Destination

copy - true for copying

overwrite - true to overwrite destination

depth - 0 for entity, infinity for collection.

Throws:

WebdavException - on error

specialUri

public abstract boolean specialUri(javax.servlet.http.HttpServletRequest req,
                                   javax.servlet.http.HttpServletResponse resp,
                                   String resourceUri)
                            throws WebdavException

Handle a special resource uri for GET. Status is set on return

Parameters:

req - HttpServletRequest

resp - HttpServletResponse

resourceUri -

Returns:

boolean true if it was a special uri and is processed

Throws:

WebdavException - on error

getSynchReport

public abstract WdSynchReport getSynchReport(String path,
                                             String token,
                                             int limit,
                                             boolean recurse)
                                      throws WebdavException

Parameters:

path -

token -

limit - - negative for no limit on result set size

recurse -

Returns:

report

Throws:

WebdavException - on error

getSyncToken

public abstract String getSyncToken(String path)
                             throws WebdavException

Used to match tokens in If header

Parameters:

path -

Returns:

sync token or null

Throws:

WebdavException - on error

getGroups

public abstract Collection<WebdavNsNode> getGroups(String resourceUri,
                                                   String principalUrl)
                                            throws WebdavException

Given a PrincipalMatchReport returns a Collection of matching nodes.

Parameters:

resourceUri - - url to base search on.

principalUrl - - url of principal or null for current user

Returns:

Collection of WebdavNsNode

Throws:

WebdavException - on error

getPrincipalCollectionSet

public abstract Collection<String> getPrincipalCollectionSet(String resourceUri)
                                                      throws WebdavException

Given a uri returns a Collection of uris that allow search operations on principals for that resource.

Parameters:

resourceUri -

Returns:

Collection of String

Throws:

WebdavException - on error

getPrincipals

public abstract Collection<? extends WebdavNsNode> getPrincipals(String resourceUri,
                                                                 PrincipalPropertySearch pps)
                                                          throws WebdavException

Given a PrincipalPropertySearch returns a Collection of matching nodes.

Parameters:

resourceUri -

pps - Collection of PrincipalPropertySearch

Returns:

Collection of WebdavNsNode

Throws:

WebdavException - on error

makeUserHref

public abstract String makeUserHref(String id)
                             throws WebdavException

Parameters:

id -

Returns:

String href

Throws:

WebdavException - on error

makeServerInfoUrl

public String makeServerInfoUrl(javax.servlet.http.HttpServletRequest req)
                         throws WebdavException

TODO - make the url value configurable

Parameters:

req -

Returns:

Throws:

WebdavException - on error

updateAccess

public abstract void updateAccess(WebdavNsIntf.AclInfo ainfo)
                           throws WebdavException

Parameters:

ainfo -

Throws:

WebdavException - on error

emitAcl

public abstract void emitAcl(WebdavNsNode node)
                      throws WebdavException

Parameters:

node -

Throws:

WebdavException - on error

getAclPrincipalInfo

public abstract Collection<String> getAclPrincipalInfo(WebdavNsNode node)
                                                throws WebdavException

Return all the hrefs found in the access for th egiven node.

Parameters:

node -

Returns:

Collection of hrefs.

Throws:

WebdavException - on error

emitSupportedReportSet

public void emitSupportedReportSet(WebdavNsNode node)
                            throws WebdavException

Parameters:

node -

Throws:

WebdavException - on error

openPropstat

public void openPropstat()
                  throws WebdavException

Open a propstat response.

Throws:

WebdavException - on error

closePropstat

public void closePropstat(int status)
                   throws WebdavException

Close a propstat response with given result.

Parameters:

status -

Throws:

WebdavException - on error

closePropstat

public void closePropstat()
                   throws WebdavException

Close a propstat response with an ok result.

Throws:

WebdavException - on error

parseProp

public List<WebdavProperty> parseProp(Node nd)
                               throws WebdavException

Parse a DAV:prop list of property names in any namespace.

Parameters:

nd - the props node

Returns:

Collection

Throws:

WebdavException - on error

makeProp

public WebdavProperty makeProp(Element propnode)
                        throws WebdavException

Override this to create namespace specific property objects.

Parameters:

propnode -

Returns:

WebdavProperty

Throws:

WebdavException - on error

knownProperty

public boolean knownProperty(WebdavNsNode node,
                             WebdavProperty pr)

Return true if a call to generatePropValue will return a value.

Parameters:

node -

pr -

Returns:

boolean

generatePropValue

public boolean generatePropValue(WebdavNsNode node,
                                 WebdavProperty pr,
                                 boolean allProp)
                          throws WebdavException

Generate a response for a single webdav property. This should be overrriden to handle other namespaces.

Parameters:

node -

pr -

allProp - true if we're doing allprop

Returns:

boolean false for unknown (or unset)

Throws:

WebdavException - on error

getLocation

public String getLocation(WebdavNsNode node)
                   throws WebdavException

Return the complete URL describing the location of the object represented by the node

Parameters:

node - node in question

Returns:

String url

Throws:

WebdavException - on error

addStatus

public void addStatus(int status)
               throws WebdavException

Parameters:

status -

Throws:

WebdavException - on error

getResourceUri

public String getResourceUri(javax.servlet.http.HttpServletRequest req)
                      throws WebdavException

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:

String fixed up uri

Throws:

WebdavException - on error

fixPath

public static String fixPath(String path)
                      throws WebdavException

Return a path, beginning with a "/", 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:

String fixed path

Throws:

WebdavException - on error

getReader

public Reader getReader(javax.servlet.http.HttpServletRequest req)
                 throws Throwable

Parameters:

req -

Returns:

possibly wrapped reader

Throws:

Throwable

getChildren

public Element[] getChildren(Node nd)
                      throws WebdavException

Get all the children if any

Parameters:

nd -

Returns:

array of Element

Throws:

WebdavException - on error

getOnlyChild

public Element getOnlyChild(Node nd)
                     throws WebdavException

We expect a single child

Parameters:

nd -

Returns:

Element

Throws:

WebdavException - on error

getElementContent

public String getElementContent(Element el)
                         throws WebdavException

Parameters:

el -

Returns:

String

Throws:

WebdavException - on error

generateHtml

protected String generateHtml(javax.servlet.http.HttpServletRequest req,
                              WebdavNsNode node)
                       throws WebdavException

Return a String giving an HTML representation of the directory. TODO

Use some form of template to generate an internationalized form of the listing. We don't need a great deal to start with. It will also allow us to provide stylesheets, images etc. Probably place it in the resources directory.

Parameters:

req -

node - WebdavNsNode

Returns:

Reader

Throws:

WebdavException - on error

getLogger

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

Specified by:

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