io.milton.resource

Interface AddressBookResource

All Superinterfaces:

CalendarCollection, CollectionResource, PropFindableResource, Resource

All Known Subinterfaces:

AddressBookDirectoryResource

public interface AddressBookResource
extends CalendarCollection, PropFindableResource

Interface for collections which can be used as address books for CARDDAV Must implement CalendarCollection as there is a cross-over of property support

Method Summary

Modifier and Type	Method and Description
InternationalizedString	getDescription() This property contains a description of the address book collection that is suitable for presentation to a user.
Long	getMaxResourceSize() This property is used to specify a numeric value that represents the maximum size in octets that the server is willing to accept when an address object resource is stored in an address book collection.
List<io.milton.http.values.Pair<String,String>>	getSupportedAddressData() property is used to specify the media type supported for the address object resources contained in a given address book collection (e.g., vCard version 3.0).
void	setDescription(InternationalizedString description) This property contains a description of the address book collection that is suitable for presentation to a user.

Methods inherited from interface io.milton.resource.CalendarCollection

getCTag

Methods inherited from interface io.milton.resource.CollectionResource

child, getChildren

Methods inherited from interface io.milton.resource.Resource

authenticate, authorise, checkRedirect, getModifiedDate, getName, getRealm, getUniqueId

Methods inherited from interface io.milton.resource.PropFindableResource

getCreateDate

Method Detail

getDescription

InternationalizedString getDescription()

This property contains a description of the address book collection that is suitable for presentation to a user. The xml:lang attribute can be used to add a language tag for the value of this property.

Returns:

Provides a human-readable description of the address book collection.

setDescription

void setDescription(InternationalizedString description)

This property contains a description of the address book collection that is suitable for presentation to a user. The xml:lang attribute can be used to add a language tag for the value of this property.

Parameters:

description - is a human-readable description of the address book collection.

getSupportedAddressData

List<io.milton.http.values.Pair<String,String>> getSupportedAddressData()

property is used to specify the media type supported for the address object resources contained in a given address book collection (e.g., vCard version 3.0). Any attempt by the client to store address object resources with a media type not listed in this property MUST result in an error, with the CARDDAV:supported-address-data precondition (Section 6.3.2.1) being violated. In the absence of this property, the server MUST only accept data with the media type "text/vcard" and vCard version 3.0, and clients can assume that is all the server will accept.

Returns:

getMaxResourceSize

Long getMaxResourceSize()

This property is used to specify a numeric value that represents the maximum size in octets that the server is willing to accept when an address object resource is stored in an address book collection. Any attempt to store an address book object resource exceeding this size MUST result in an error, with the CARDDAV:max-resource-size precondition (Section 6.3.2.1) being violated. In the absence of this property, the client can assume that the server will allow storing a resource of any reasonable size.

Returns: