SchedulingOutboxResource (milton-server-ce 3.1.0.301 API)

java.lang.Object
- io.milton.http.annotated.scheduling.BaseSchedulingResource
- - io.milton.http.annotated.scheduling.SchedulingOutboxResource

All Implemented Interfaces:

CollectionResource, DigestResource, GetableResource, PostableResource, PropFindableResource, ReportableResource, Resource
```
public class SchedulingOutboxResource
extends BaseSchedulingResource
implements PostableResource, PropFindableResource
```
The following WebDAV properties specified in CalDAV "calendar-access" [RFC4791] MAY also be defined on scheduling Outbox collections: CALDAV:supported-calendar-component-set - when present this indicates the allowed calendar component types for scheduling messages submitted to the scheduling Outbox collection with the POST method. CALDAV:supported-calendar-data - when present this indicates the allowed media types for scheduling messages submitted to the scheduling Outbox collection with the POST method. CALDAV:max-resource-size - when present this indicates the maximum size of a resource in octets that the server is willing to accept for scheduling messages submitted to the scheduling Outbox Daboo & Desruisseaux Expires April 28, 2011 [Page 12] Internet-Draft CalDAV Scheduling Extensions October 2010 collection with the POST method. CALDAV:min-date-time - when present this indicates the earliest date and time (in UTC) that the server is willing to accept for any DATE or DATE-TIME value in scheduling messages submitted to the scheduling Outbox collection with the POST method. CALDAV:max-date-time - when present this indicates the latest date and time (in UTC) that the server is willing to accept for any DATE or DATE-TIME value in scheduling messages submitted to the scheduling Outbox collection with the POST method. CALDAV:max-instances - when present this indicates the maximum number of recurrence instances in scheduling messages submitted to the scheduling Outbox collection with the POST method. CALDAV:max-attendees-per-instance - when present this indicates the maximum number of ATTENDEE properties in any instance of scheduling messages submitted to the scheduling Outbox collection with the POST method. Example: POST /home/cyrus/calendars/outbox/ HTTP/1.1 Host: cal.example.com Content-Type: text/calendar; charset="utf-8" Content-Length: xxxx BEGIN:VCALENDAR VERSION:2.0 PRODID:-//Example Corp.//CalDAV Client//EN METHOD:REQUEST BEGIN:VFREEBUSY UID:4FD3AD926350 DTSTAMP:20090602T190420Z DTSTART:20090602T000000Z DTEND:20090604T000000Z ORGANIZER;CN="Cyrus Daboo":mailto:cyrus@example.com ATTENDEE;CN="Wilfredo Sanchez Vega":mailto:wilfredo@example.com ATTENDEE;CN="Bernard Desruisseaux":mailto:bernard@example.net ATTENDEE;CN="Mike Douglass":mailto:mike@example.org END:VFREEBUSY END:VCALENDAR >> Response << HTTP/1.1 200 OK Date: Tue, 02 Jun 2009 20:07:34 GMT Content-Type: application/xml; charset="utf-8" Content-Length: xxxx mailto:wilfredo@example.com 2.0;Success BEGIN:VCALENDAR VERSION:2.0 PRODID:-//Example Corp.//CalDAV Server//EN METHOD:REPLY BEGIN:VFREEBUSY UID:4FD3AD926350 DTSTAMP:20090602T200733Z DTSTART:20090602T000000Z DTEND:20090604T000000Z ORGANIZER;CN="Cyrus Daboo":mailto:cyrus@example.com ATTENDEE;CN="Wilfredo Sanchez Vega":mailto:wilfredo@example.com FREEBUSY;FBTYPE=BUSY:20090602T110000Z/20090602T120000Z FREEBUSY;FBTYPE=BUSY:20090603T170000Z/20090603T180000Z END:VFREEBUSY END:VCALENDAR mailto:bernard@example.net 2.0;Success BEGIN:VCALENDAR VERSION:2.0 PRODID:-//Example Corp.//CalDAV Server//EN METHOD:REPLY BEGIN:VFREEBUSY UID:4FD3AD926350 DTSTAMP:20090602T200733Z DTSTART:20090602T000000Z DTEND:20090604T000000Z ORGANIZER;CN="Cyrus Daboo":mailto:cyrus@example.com ATTENDEE;CN="Bernard Desruisseaux":mailto:bernard@example.net FREEBUSY;FBTYPE=BUSY:20090602T150000Z/20090602T160000Z FREEBUSY;FBTYPE=BUSY:20090603T090000Z/20090603T100000Z FREEBUSY;FBTYPE=BUSY:20090603T180000Z/20090603T190000Z END:VFREEBUSY END:VCALENDAR mailto:mike@example.org 3.7;Invalid calendar user

Author:

brad

Field Summary
- Fields inherited from class io.milton.http.annotated.scheduling.BaseSchedulingResource
  calendarSearchService, name, principal

Constructor Summary

Constructors
Constructor and Description
`SchedulingOutboxResource(CalDavPrincipal principal, CalendarSearchService calendarSearchService, String name)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`authorise(Request request, Request.Method method, Auth auth)`
`Resource`	`child(String childName)`
`List<? extends Resource>`	`getChildren()`
`Long`	`getContentLength()`
`String`	`getContentType(String accepts)`
`Date`	`getCreateDate()`
`Long`	`getMaxAgeSeconds(Auth auth)`
`String`	`processForm(Map<String,String> parameters, Map<String,FileItem> files)`
`List<SchedulingResponseItem>`	`queryFreeBusy(String iCalText)` A POST request may deliver a scheduling message to one or more Calendar Users.
`void`	`sendContent(OutputStream out, Range range, Map<String,String> params, String contentType)`

Methods inherited from class io.milton.http.annotated.scheduling.BaseSchedulingResource
authenticate, authenticate, checkRedirect, getModifiedDate, getName, getRealm, getUniqueId, isDigestAllowed

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.milton.resource.Resource
authenticate, checkRedirect, getModifiedDate, getName, getRealm, getUniqueId

- Constructor Detail
  - SchedulingOutboxResource
```
public SchedulingOutboxResource(CalDavPrincipal principal,
                                CalendarSearchService calendarSearchService,
                                String name)
```
- Method Detail
  - queryFreeBusy
```
public List<SchedulingResponseItem> queryFreeBusy(String iCalText)
```
    A POST request may deliver a scheduling message to one or more Calendar Users. Thus the response needs to contain separate status information for each recipient. This specification defines a new XML response body to convey multiple recipient status. A response to a POST method that indicates status for one or more recipients MUST be an XML document with a CALDAV:schedule-response XML element as its root element. This MUST contain one or more CALDAV:response elements for each recipient, with each of those containing elements that indicate which recipient they correspond to, the scheduling status for that recipient, any error codes and an optional description. See Section 14.1 for the detail on the child elements. In the case of a freebusy request, the CALDAV:response elements can also contain CALDAV:calendar-data elements which contain freebusy information (e.g., an iCalendar VFREEBUSY component) indicating the busy state of the corresponding recipient, assuming that the freebusy request for that recipient succeeded.
    
    Parameters:
    
    iCalText -
    
    Returns:
  - child
```
public Resource child(String childName)
               throws NotAuthorizedException,
                      BadRequestException
```
    Specified by:
    
    child in interface CollectionResource
    
    Throws:
    
    NotAuthorizedException
    
    BadRequestException
  - getChildren
```
public List<? extends Resource> getChildren()
                                     throws NotAuthorizedException,
                                            BadRequestException
```
    Specified by:
    
    getChildren in interface CollectionResource
    
    Throws:
    
    NotAuthorizedException
    
    BadRequestException
  - processForm
```
public String processForm(Map<String,String> parameters,
                          Map<String,FileItem> files)
                   throws BadRequestException,
                          NotAuthorizedException,
                          ConflictException
```
    Specified by:
    
    processForm in interface PostableResource
    
    Throws:
    
    BadRequestException
    
    NotAuthorizedException
    
    ConflictException
  - sendContent
```
public void sendContent(OutputStream out,
                        Range range,
                        Map<String,String> params,
                        String contentType)
                 throws IOException,
                        NotAuthorizedException,
                        BadRequestException,
                        NotFoundException
```
    Specified by:
    
    sendContent in interface GetableResource
    
    Throws:
    
    IOException
    
    NotAuthorizedException
    
    BadRequestException
    
    NotFoundException
  - getMaxAgeSeconds
```
public Long getMaxAgeSeconds(Auth auth)
```
    Specified by:
    
    getMaxAgeSeconds in interface GetableResource
  - getContentType
```
public String getContentType(String accepts)
```
    Specified by:
    
    getContentType in interface GetableResource
  - getContentLength
```
public Long getContentLength()
```
    Specified by:
    
    getContentLength in interface GetableResource
  - authorise
```
public boolean authorise(Request request,
                         Request.Method method,
                         Auth auth)
```
    Specified by:
    
    authorise in interface Resource
    
    Overrides:
    
    authorise in class BaseSchedulingResource
  - getCreateDate
```
public Date getCreateDate()
```
    Specified by:
    
    getCreateDate in interface PropFindableResource

Class SchedulingOutboxResource

Field Summary

Fields inherited from class io.milton.http.annotated.scheduling.BaseSchedulingResource

Constructor Summary

Method Summary

Methods inherited from class io.milton.http.annotated.scheduling.BaseSchedulingResource

Methods inherited from class java.lang.Object

Methods inherited from interface io.milton.resource.Resource

Constructor Detail

SchedulingOutboxResource

Method Detail

queryFreeBusy

child

getChildren

processForm

sendContent

getMaxAgeSeconds

getContentType

getContentLength

authorise

getCreateDate