com.sapportals.wcm.protocol.webdav

Class DavMultiStatus

java.lang.Object
  com.sapportals.wcm.protocol.webdav.DavMultiStatus

public class DavMultiStatus
extends Object

Maps IUriReferences to DavStatus objects.

Copyright (c) SAP AG 2002-2007

Constructor Summary

DavMultiStatus()
Builds empty map.

DavMultiStatus(Document doc)
Builds map from Document containing a WebDAV DAV:multistatus body.

Method Summary

int	addErrorElement(Document doc) Add a DAV:error element describing the first error in the map.
int	addMultiStatusBody(Document doc) Add a DAV:multistatus body element describing the error map.
boolean	containsKey(IUriReference uri) Check whether information for the given URI reference is present.
DavStatus	get(IUriReference uri) Get status information for the given URI reference.
boolean	isEmpty() Check whether the map is empty.
void	put(IUriReference uri, DavStatus status) A information about a specific URI reference to the map.
int	size() Return the size of the map.

Methods inherited from class java.lang.Object

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

Constructor Detail

DavMultiStatus

public DavMultiStatus()

Builds empty map.

DavMultiStatus

public DavMultiStatus(Document doc)

Builds map from Document containing a WebDAV DAV:multistatus body. Problems found in the document will be logged, but no exception will be reported (in the worst case, an empty object is created).

Parameters:

doc - Document with document element DAV:multistatus.

Method Detail

containsKey

public boolean containsKey(IUriReference uri)

Check whether information for the given URI reference is present.

Parameters:

uri - URI reference

Returns:

true when information present.

get

public DavStatus get(IUriReference uri)

Get status information for the given URI reference.

Parameters:

uri - URI reference

Returns:

DavStatus for this URI reference or null.

isEmpty

public boolean isEmpty()

Check whether the map is empty.

Returns:

true is the map is empty.

put

public void put(IUriReference uri,
                DavStatus status)

A information about a specific URI reference to the map.

Parameters:

uri - URI reference

status - status information

size

public int size()

Return the size of the map.

Returns:

the size

addMultiStatusBody

public int addMultiStatusBody(Document doc)

Add a DAV:multistatus body element describing the error map.

Parameters:

doc - the document to which the DAV:multistatus element will be added as document element (must be empty)

Returns:

HTTP status code 207

addErrorElement

public int addErrorElement(Document doc)

Add a DAV:error element describing the first error in the map.

Parameters:

doc - the document to which the DAV:error element will be added as document element (must be empty)

Returns:

HTTP status extracted from the error element

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM