net.fortuna.ical4j.connector.dav

Class AbstractDavObjectCollection<T>

java.lang.Object

net.fortuna.ical4j.connector.dav.AbstractDavObjectCollection<T>

Type Parameters:

T - the supported collection object type Created: [20/11/2008]

All Implemented Interfaces:

ObjectCollection<T>

Direct Known Subclasses:

CalDavCalendarCollection, CardDavCollection

public abstract class AbstractDavObjectCollection<T>
extends Object
implements ObjectCollection<T>

Author:

fortuna

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.jackrabbit.webdav.property.DavPropertySet	properties

Constructor Summary

Constructors

Constructor and Description
AbstractDavObjectCollection(AbstractDavObjectStore<?> store, String id)

Method Summary

Methods

Modifier and Type	Method and Description
protected static List<CalDavCalendarCollection>	collectionsFromResponse(CalDavCalendarStore store, org.apache.jackrabbit.webdav.MultiStatusResponse[] responses) Get the list of collections from a MultiStatus (HTTP 207 status code) response and populate the list of properties of each collection.
void	delete()
boolean	exists()
String	getId()
String	getOwnerHref() Href (link) to the owner of this collection
String	getOwnerName() Name of the owner of this collection.
String	getPath()
<P> P	getProperty(org.apache.jackrabbit.webdav.property.DavPropertyName propertyName, Class<P> type)
Long	getQuotaAvailableBytes() Indicates the maximum amount of additional storage available to be allocated to a resource.
Long	getQuotaUsedBytes() Contains the amount of storage counted against the quota on a resource.
ResourceType[]	getResourceTypes() Returns a list of the kinds of resource type for this collection.
AbstractDavObjectStore<?>	getStore()
MediaType[]	getSupportedMediaTypes() Returns a list of supported media types.
boolean	isReadOnly()
void	setReadOnly(boolean isReadOnly)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.fortuna.ical4j.connector.ObjectCollection

getComponents, getDescription, getDisplayName

Field Detail

properties

protected org.apache.jackrabbit.webdav.property.DavPropertySet properties

Constructor Detail

AbstractDavObjectCollection

public AbstractDavObjectCollection(AbstractDavObjectStore<?> store,
                           String id)

Parameters:

store - the container store for the collection

id - collection identifier

Method Detail

getStore

public final AbstractDavObjectStore<?> getStore()

Returns:

the store

getId

public final String getId()

Returns:

the id

getPath

public final String getPath()

Returns:

the absolute collection path

getResourceTypes

public ResourceType[] getResourceTypes()

Returns a list of the kinds of resource type for this collection. For example, for a collection that supports iCalendar object, "calendar" will be one of the resource types.

getSupportedMediaTypes

public MediaType[] getSupportedMediaTypes()

Returns a list of supported media types. For example, a CalDAV server will probably return 2.0 as the supported version and text/calendar as the content-type.

getQuotaAvailableBytes

public Long getQuotaAvailableBytes()

Indicates the maximum amount of additional storage available to be allocated to a resource.

getQuotaUsedBytes

public Long getQuotaUsedBytes()

Contains the amount of storage counted against the quota on a resource.

getOwnerHref

public String getOwnerHref()

Href (link) to the owner of this collection

getOwnerName

public String getOwnerName()

Name of the owner of this collection. Will be retrieved by the owner href

isReadOnly

public boolean isReadOnly()

setReadOnly

public void setReadOnly(boolean isReadOnly)

getProperty

public final <P> P getProperty(org.apache.jackrabbit.webdav.property.DavPropertyName propertyName,
                Class<P> type)
                    throws IOException,
                           ObjectStoreException,
                           org.apache.jackrabbit.webdav.DavException

Type Parameters:

P - the property type

Parameters:

propertyName - a property name

type - the class for the property type returned (HACK!!)

Returns:

the value for the specified property name

Throws:

IOException - if there is a communication error

ObjectStoreException - where an unexpected error occurs

org.apache.jackrabbit.webdav.DavException - where an error occurs calling the DAV method

delete

public final void delete()
                  throws org.apache.commons.httpclient.HttpException,
                         IOException,
                         ObjectStoreException

Throws:

org.apache.commons.httpclient.HttpException - where an error occurs calling the HTTP method

IOException - if there is a communication error

ObjectStoreException - where an unexpected error occurs

exists

public final boolean exists()
                     throws org.apache.commons.httpclient.HttpException,
                            IOException,
                            ObjectStoreException

Returns:

true if the collection exists, otherwise false

Throws:

org.apache.commons.httpclient.HttpException - where an error occurs calling the HTTP method

IOException - if there is a communication error

ObjectStoreException - where an unexpected error occurs

collectionsFromResponse

protected static List<CalDavCalendarCollection> collectionsFromResponse(CalDavCalendarStore store,
                                                     org.apache.jackrabbit.webdav.MultiStatusResponse[] responses)

Get the list of collections from a MultiStatus (HTTP 207 status code) response and populate the list of properties of each collection.