All Classes and Interfaces

Class
Description
5.4.1.
 
Marks a method as one which returns the Access Control List for a user on a given resource
This is event is fired on any type of method, after authorisation but before any method specific processing Set the returnRedirectUrl from a listener to cause a redirect
 
 
Resource implemting this interface will be able to repond to CardDAV addressbook-query
Interface for collections which can be used as address books for CARDDAV Must implement CalendarCollection as there is a cross-over of property support
Marks a method as one which returns address book object.
Represents an address resource.
Supports both IPv4 and IPv6 addresses
Fired just after the resource is moved.
Holds authentication information for a request There are two sets of information: - that which is present in the request - that which is determined as part of performing authentication Note that even if authentication fails, this object will still be available in the request - DO NOT USE THE PRESENCE OF THIS OBJECT TO CHECK FOR A VALID LOGIN!!! Instead use the tag property.
Common HTTP authentication schemes, and some non-http specified but common ones
Marks a method as one which can be used to authenticate a user.
 
 
 
Annotation type to identify properties to be accessible by BeanPropertySource
Annotation type to identify classes to be accessible by BeanPropertyResource
Specialisation of GetableResource which allows more precise control over whether or not content is buffered
An output stream which will buffer data, initially using memory up to maxMemorySize, and then overflowing to a temporary file.
 
 
Marks the method which gets/sets the color for the given calendar object
Marks a method as one which performs a query of events in a calendar for a given date range
Marks a method as one which finds calendar event invitations for a user
Marks a controller method as one which returns a ctag representing the current state of the invitations for a user
Marks the method which gets/sets the order property for the given calendar object
 
 
Marks a method as one which returns calendar objects.
Marks the method which gets/sets the type of calendar user this principal represents.
 
Marks a method as one which locates a child of a parent with a given name.
Marks a method as one which locates children for the given parent.
 
 
 
 
Represents a missing class
A type of Resource which can have children, ie it can act as a directory.
Marks the method which returns contact data formatted as VCard data
Marks the method which returns the content content length (ie number of bytes) of this resource.
Marks the method which returns the content type of the resource
 
 
Basic context functionality.
This interface represents those classes which contain context
 
Marks a method as one which copies the given resource to another name or another parent, or both
webDAV COPY
Marks the method which returns the date the resource was created
Marks the method which returns a CTag for the resource
Unused
A utility class for parsing and formatting HTTP dates as used in cookies and other headers.
 
A common webdav group
Used to represent aggregated principals defined by the ACL spec Eg D:all, D:authenticated, D:unauthenticated
 
 
 
 
This implementation of ContentTypeService just uses a map of file extension to mime types.
Unused
An extension to DeletableResource and CollectionResource, this interface adds a method to support efficient detection of child locks.
Implement this to allow your resource to be deleted by webdav clients.
Marks a method as one which deletes the given resource
 
Interface to support digest HTTP authentication.
Supports CardDAV Directory Gateway Extension https://github.com/miltonio/milton2/issues/25 https://tools.ietf.org/html/draft-daboo-carddav-directory-gateway-02#page-4 Implement this for each address book class to return whether it is or is not to be used as a directory gateway MUST return Boolean !! Default bean property is "directoryGateway" Example annotated method:
Implement this to add support for https://tools.ietf.org/html/draft-daboo-carddav-directory-gateway-02#page-4
Indicates a principle which is identifiable by a URL, like a user or an application defined group
Marks the method which returns the display name for a resource
Implement for resources that want to be able to update their display names Note that most webdav clients do not use displayname, but it is used for calendars and addressbooks
Marks the method which sets the display name for a resource
 
 
 
Marks the method as one which returns the email address for a type of object.
 
 
 
 
 
 
 
 
 
An inputstream to read a file, and to delete the file when this stream is closed This is useful for situations where you are using a local file to buffer the contents of remote data, and want to ensure that the temporary local file is deleted when it is no longer being used
Represents an item which has been uploaded in a form POST
Extends all interfaces required for typical document behavior.
 
Extends all interfaces required for typical folder behavior.
Handy functions exposes to rendering logic for formatting.
Marks a method as one which performs a free busy query
Marks a method as one which generates content for the given resource
webDAV GET and HEAD
 
 
Marks the method which returns event data formatted as ICal data
Represents a resource which can return an ical textual representation
Represents a string object that contains an extra information of language.
Value object holding the result of some operation in a generic form which is suitable for outputting as JSON.
Represents an entry in an address book.
 
webDAV LOCK You should also implement LockingCollectionResource on your collections for full locking support
 
 
 
 
A collection which allows locking "unmapped resources".
 
(from the spec)
7.4 Write Locks and Null Resources
 
 
 
 
 
 
Marks a method as one which creates calendars.
 
Marks a method as one which creates a collection within the resource given
Represents a collection (ie a folder or directory which allows sub collections to be created
Marks the method which returns the maximum age in seconds to allow the resource to be cached by clients and proxies
 
Marks the method which returns the date the resource was modified
Marks a method as one which moves a resource to a new parent, or that renames it, or both
webDAV MOVE
Fired just before the resource is moved.
A resource interface similar to CustomPropertyResource, except that it doesnt use accessor objects, and it supports multiple namespaces.
 
Marks the method which returns the name for a resource.
 
 
 
 
 
 
 
This contains the information about the authenticated profile
Immutable
 
Marks a method as one which handles POST requests for a given resource
 
Fired on a POST event.
Identifies a controller method parameter as being the current user
Marker interface to identify those classes which can act as a Principal.
A principleId represents a unique identifier for a principle.
 
 
 
 
 
 
Defines a source of properties.
 
 
Exception from setting a field
 
 
 
Marks a method as one which creates a child resource containing the given content, or replaces an existing child's content with new data

 
Resource interface to support quota's This must be implemented by Collection (ie Folder) resources if you want to support quotas Resources which implement this can have their quota availability reported to client applications via the RFC4331 HTTP extensions See: http://www.faqs.org/rfcs/rfc4331.html Note that these properties may or may not be used in quota checking on PUT.
A positionable file output stream.
 
 
 
Marks the method which returns the realm to be used for authentication
 
 
 
Marker interface for removed Resource to support sync-collection report.
Indicates a resource which can have its content replaced by a PUT method
Just a marker interface to indicate that the resource is permitted to support REPORT requests.
 
 
 
 
 
 
 
 
Implementations should implement compareTo as an alphabetic comparison on the name property
Marks a class as being a controller
 
Implementations of ResourceFactory translate URLs to instances of Resource
 
 
 
 
 
 
 
Fired after response is complete
 
Marks a method as one which locates the root resource for a given host
 
 
 
Represents some service which can be controlled (ie started and stopped)
 
 
 
 
 
 
 
Return the types of calendar objects supported for this user
CollectionResource which supports sync-token.
Marks the method which returns a unique identifier for this resource.
Marks a method as one which returns user objects.
 
Abstraction of a view.
 
Should return an SOA record and NS records in getRecords()...