How to use FreeBusyQuery with caldavcollection? #86
Comments
|
Here's a quick example of how to use FreeQueryReport, without CalDAVCollection: HttpClient httpClient = new HttpClient();
// Initialize the Query Report
FreeBusyQuery fb = new FreeBusyQuery();
Date start = new DateTime("20000101T000000Z"); // ical4j Date objects
Date end = new DateTime("20000201T000000Z");
fb.setTimeRange(new TimeRange(start, end)); // Set the time range
// Print the XML to STDOUT
System.out.println(XMLUtils.toPrettyXML(fb.createNewDocument()));
// Initialize the method, with the report, query
CalDAVReportMethod method = new CalDAVReportMethod("http://path/to/my/caldav/repo", fb);
method.setCalendarBuilder(new CalendarBuilder()); // Set the CalendarBuilder, to build the response
//Execute
httpClient.executeMethod(method);
// Return Response as iCal4j Calendar
Calendar calendar = method.getResponseBodyAsCalendar();Currently the CalDAVCollection does not have any support for freebusyqueries. I can though, add it in our next release as an enhancement. |
* Added a method to execute a Freebusyquery through CalDAVCollection. Enhancement for #86 * Fixed EnsureTrailingSlash, and used in CalDAVCredential
|
Hi @signalarun, it would be great if you can find some time to make a pull request with the FreeBusy query example! If your patch will be merged (after the code review/QA) you'll become a Caldav4j Contributor and could add that to your resume :) |
|
@TheAntimist Using Baikal But the server returned http 500 status. Using SOGO But the server returned http 501 status. |
|
@ioggstream " it would be great if you can find some time to make a pull request with the FreeBusy query example!" ? You meant to try with the given FreeBusyQueryFunctionalTest.java |
|
@signalrun, have you authenticated yourself? That could be an issue, but as far as I see it's a server issue. Does the server return anything other than the status code? Does SoGo, support Free busy? EDIT: Tested this against Baikal, another CalDAV server, and it works perfectly fine. Here's a quick sample of the calendar returned from my calendar: |
|
@TheAntimist authenticated using httpClient. Should I do anything additional to handle cookies. |
|
@signalarun I have been able to reproduce your issue, and have got successful responses in different scenarios. let me get back to you, when I have more info. |
|
The main issue as it turned out was that we for some reason have to do a MKCALENDAR, and it works, without it it doesn't. In the code below, if instead of @signalarun Here's a more comprehensive code which works in Baikal, the latest release: import net.fortuna.ical4j.model.Calendar;
import net.fortuna.ical4j.model.Date;
import net.fortuna.ical4j.model.DateTime;
import net.fortuna.ical4j.model.component.VEvent;
import net.fortuna.ical4j.model.property.Uid;
import net.fortuna.ical4j.util.UidGenerator;
import org.apache.commons.httpclient.Credentials;
import org.apache.commons.httpclient.UsernamePasswordCredentials;
import org.apache.commons.httpclient.auth.AuthScope;
import org.osaf.caldav4j.methods.*;
import org.osaf.caldav4j.model.request.FreeBusyQuery;
import org.osaf.caldav4j.model.request.MkCalendar;
import org.osaf.caldav4j.model.request.TimeRange;
import java.net.SocketException;
public class Test {
public static DateTime getToday() {
return new DateTime();
}
public static Date getTomorrow() {
java.util.Calendar calendar = java.util.Calendar.getInstance();
calendar.add(java.util.Calendar.DATE, +1);
return new DateTime(calendar.getTime());
}
public static Date getYesterday() {
java.util.Calendar calendar = java.util.Calendar.getInstance();
calendar.add(java.util.Calendar.DATE, -1);
return new DateTime(calendar.getTime());
}
public static Calendar createiCalendar(String uid) throws SocketException {
VEvent test = new VEvent(getToday(), getTomorrow(), "TEST EVENT");
UidGenerator generator = new UidGenerator("123");
test.getProperties().add(new Uid(uid));
Calendar c = new Calendar();
c.getComponents().add(test);
return c;
}
public static void main(String[] args) throws Exception {
String uri = "http://localhost:8080/cal.php/calendars/username/testcalendar/";
HttpClient client = new HttpClient();
// Set the Credentials for the calendar
Credentials creds = new UsernamePasswordCredentials("username", "password");
client.getState().setCredentials(AuthScope.ANY, creds);
CalDAV4JMethodFactory factory = new CalDAV4JMethodFactory();
String uid = "TESTUID";
Calendar cal = createiCalendar(uid);
//Create Calendar on server
MkCalendarMethod mkCalendarMethod = new MkCalendarMethod(uri, "TEST Calendar", "TEST DESCRIPTION");
client.executeMethod(mkCalendarMethod);
System.out.println("Got Status for MKCALENDAR: " + mkCalendarMethod.getStatusLine());
// Create iCalendar on server
PutMethod putMethod = factory.createPutMethod();
putMethod.setRequestBody(cal);
putMethod.setPath(uri + uid + ".ics");
client.executeMethod(putMethod);
System.out.println("Got PUT Status: " + putMethod.getStatusCode());
// Check if on server
GetMethod getMethod = factory.createGetMethod();
getMethod.setPath(uri + uid + ".ics");
client.executeMethod(getMethod);
System.out.println("Got response calendar as: ");
Calendar resp = getMethod.getResponseBodyAsCalendar();
System.out.println(resp);
// TEST FreebusyQuery on server for the time period
FreeBusyQuery query = new FreeBusyQuery();
query.setTimeRange(new TimeRange(getYesterday(), getTomorrow()));
CalDAVReportMethod method = factory.createCalDAVReportMethod(uri, query);
client.executeMethod(method);
System.out.println("For FreeBusyQuery got Status: " + method.getStatusLine());
System.out.println("For FreeBusyQuery got Response calendar:\n" + method.getResponseBodyAsCalendar());
// Delete iCal from server
DeleteMethod deleteMethod = new DeleteMethod(uri + uid + ".ics");
client.executeMethod(deleteMethod);
System.out.println("For Delete iCalendar got response code: " + deleteMethod.getStatusLine());
// Delete CalDAV Collection from server
deleteMethod = new DeleteMethod(uri);
client.executeMethod(deleteMethod);
System.out.println("For Delete CalDAV Collection got response code: " + deleteMethod.getStatusLine());
}
}@ioggstream I have added a similar test to FreeBusyQueryTest, as well. |
|
@TheAntimist |
|
That's seems to be a authentication issue, the Cookie should have your path, so no idea where that issue is popping in from. Can't help you there. |
|
@signalarun You could try: httpclient.getParams().setParameter(ClientPNames.COOKIE_POLICY,
CookiePolicy.BROWSER_COMPATIBILITY);Based on here: https://stackoverflow.com/questions/7459279/httpclient-warning-cookie-rejected-illegal-domain-attribute |
|
Tried with the same code as above. I'am using Baikal docker image.May be because of port mapping from 80 to 8800. |
|
@TheAntimist shall try with that. |
|
@signalarun Sogo, could have a different address for Freebusy. From what I see it does implement FreeBusy, but it could be some other issue. For example, I was getting the Http 5xx, even when I was running the command from cURL or Python, so, it was something else. I suppose some trial and error is the only solution to find what works. |
|
Working for Baikal after adding But parser exception at line Calendar resp = getMethod.getResponseBodyAsCalendar(); |
|
Hmm, that's weird. Can you provide the output after adding these lines to your <dependency>
<groupId>org.slf4j</groupId>
<artifactId>log4j-over-slf4j</artifactId>
<version>1.7.25</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
<version>1.7.25</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.25</version>
</dependency>Add the following code snippet as <?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
<appender name="CONSOLE" class="org.apache.log4j.ConsoleAppender">
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern"
value="%p - %C{1}.%M(%L) | %m%n"/>
</layout>
</appender>
<logger name="org.apache">
<level value="WARN"/>
</logger>
<logger name="org.osaf">
<level value="INFO"/>
</logger>
<logger name="httpclient.wire">
<level value="DEBUG"/>
</logger>
<root>
<level value="WARN"/>
<appender-ref ref="CONSOLE"/>
</root>
</log4j:configuration>EDIT: I have updated this snippet to reflect the actual one. |
|
Shall do it. For httpclient 3.1. this didnt helped me but worked after removing http://localhost from the method |
|
That's certainly odd, because the host configuration hasn't been set in my code. |
|
I tried after setting it up by |
|
Okay, then, can I close this issue? Or do you have more concerns regarding this? |
|
Yes, free busy query working fine for Baikal but not for SOGO as said above(may be server issue). |
|
That seems to be server specific, so can't help there. Closing this issue, since it seems to be complete. You could change the URI from collection to just the user, but not sure how that would work. |
|
One thing which I found for Baikal is that if Collection is created from their UI Admin panel for a particular user then our FreeBusy query wont work for that particular collection. But if the same collection is created from a client then free busy query works. May be because of permission assignment issue. |
|
Yes, I was able to reproduce the same on cURL and HttpClient and Python's Requests. |
|
Is it normal that Caldav server return only the free busy of the connected collection only, when there are freebusy information in other collection of same user ? |
|
Not sure, could be a server specific feature as I mentioned. Also, regarding Baikal's Http 500 status, could this help |
|
Had tried this<You could change the URI from collection to just the user, but not sure how that would work.> but doesnt work as expected. |
* Added a method to execute a Freebusyquery through CalDAVCollection. Enhancement for #86 * Fixed EnsureTrailingSlash, and used in CalDAVCredential
Before submitting an issue, read the FAQ
then describe the issue using the following template
Reproduce
Steps to reproduce the issue:
I expect
What do you expect
No example found to use freebusyquery with caldavcollection
Instead
What happens instead?
Notes
Further notes you want to attach
The text was updated successfully, but these errors were encountered: