350
edits
Changes
new 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 <code>HTTP</code> URL to a [http://www.sun.com/software/products/calendar_srvr/index.xml Sun Java System Calendar server].
<pre>
http://cal-server/
</pre>
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, <code>HTTPS</code> is enforced, even if you have specified plain <code>HTTP</code>,
because the password is transmitted. If the calendar server does not
support <code>HTTPS</code> (at least for login), you will be asked whether to
continue the login. For calendar data retrieval, the specified protocol
(<code>HTTP</code>, <code>HTTPS</code>) of the URL is used.
If you want to use a different <code>calid</code> (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.
<pre>
http://john%3apublic-cal@cal-server/
</pre>
<code>%3a</code> encodes the colon of the calid <code>john:public-cal</code>.
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 <code>js</code> console, eventually to <code>stdout</code> (if <code>user_pref("browser.dom.window.dump.enabled", true);</code>) or
[[#Log_File|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 <code>user.js</code> 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 can switch local caching on/off using a boolean preference.
''Local caching is currently turned ''off'', because of performance problems using the storage provider'':
user_pref("calendar.wcap.use_local_data", ''[true|false]'');
All local calendar 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.local_data", "''/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 [https://bugzilla.mozilla.org/show_bug.cgi?id=340949 issue 340949]
==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 <code>HTTP</code> URL to a [http://www.sun.com/software/products/calendar_srvr/index.xml Sun Java System Calendar server].
<pre>
http://cal-server/
</pre>
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, <code>HTTPS</code> is enforced, even if you have specified plain <code>HTTP</code>,
because the password is transmitted. If the calendar server does not
support <code>HTTPS</code> (at least for login), you will be asked whether to
continue the login. For calendar data retrieval, the specified protocol
(<code>HTTP</code>, <code>HTTPS</code>) of the URL is used.
If you want to use a different <code>calid</code> (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.
<pre>
http://john%3apublic-cal@cal-server/
</pre>
<code>%3a</code> encodes the colon of the calid <code>john:public-cal</code>.
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 <code>js</code> console, eventually to <code>stdout</code> (if <code>user_pref("browser.dom.window.dump.enabled", true);</code>) or
[[#Log_File|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 <code>user.js</code> 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 can switch local caching on/off using a boolean preference.
''Local caching is currently turned ''off'', because of performance problems using the storage provider'':
user_pref("calendar.wcap.use_local_data", ''[true|false]'');
All local calendar 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.local_data", "''/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 [https://bugzilla.mozilla.org/show_bug.cgi?id=340949 issue 340949]
