Calendar:WCAP Provider

Please remind that this provider IS STILL PRELIMINARY, NO WARRANTY!

Using

Initial Steps

The Lightning Create New Calendar wizard comes up with a third Format type for remote calendars (Sun Java System Calendar Server (WCAP)). As location, provide a HTTP URL to a Sun Java System Calendar server.

http://cal-server/

After creation, you need to switch the view on for this calendar in the Calendars list.

Login

For login, you will be asked for a pair of UserName/Password. If you don't pass login, you will be asked again. If you cancel login, you won't be asked again anymore.

For login, HTTPS is enforced, even if you have specified plain HTTP, because the password is transmitted. If the calendar server does not support HTTPS (at least for login), you will be asked whether to continue the login. For calendar data retrieval, the specified protocol (HTTP, HTTPS) of the URL is used. If you want to use a different calid (i.e. user[:calendar]), e.g. if you want to work on another calendar than your default one, then you currently have to specify this in the URL, e.g.

http://john%3apublic-cal@cal-server/

%3a encodes the colon of the calid john:public-cal. Of course, this ought to be specified by a convenient UI in the future. If you don't specify the :calendar part, the user's default calendar is taken.

UI

If you create items, keep care to have the correct calendar selected and checked in the Calendars list, because this will be the one for insertion. It can be confusing if the selected calendar is not shown (unchecked), i.e. you won't see your newly created event. IMO we have to improve this.

Logging

Log Level

The provider can log for diagnose purposes. Logs go to the js console, eventually to stdout (if user_pref("browser.dom.window.dump.enabled", true);) or log file.

Three log levels are defined:

• 0 => no logging (release)
• 1 => some logging, connection etc., but no calendar data
• 2 => full log

Building Lightning, the default log level (i.e. 0) can be overridden, e.g.

make wcap_logging=2

Moreover, you can increase the log level your user.js in your profile:

user_pref("calendar.wcap.log_level", n);

The effective log level is

max( build-default-log-level, user-pref-log-level )

Log File

You can specify a log file. Logs are always appended to the specified file.

user_pref("calendar.wcap.log_file", "/system/path/to/log/file");

EXPERIMENTAL Local Caching

You have two options for caching:

• in-memory → memory
• persistent on hard disc → storage

using the following preference. By default, local caching is currently turned off, because of performance problems using the storage provider:

user_pref("calendar.wcap.cache", "[off|memory|storage]");

For storage caching, all the caching data is stored by default in the following directory:

profile-dir/wcap

You can use a different directory by setting:

user_pref("calendar.wcap.cache_dir", "/system/path/to/data/directory");

If you feel the need to flush/renew your local calendar cache, just delete that directory. All data will be refreshed on next startup.

Misc

• contribution tracked via issue 340949