This chapter describes the Calendar Server specific items you need to use the ENS APIs.
This chapter contains these sections:
There are two parts to the format of an Calendar Server notification:
The event reference– A URL identifying the event.
The payload– The data describing the event. Three different payload formats are supported: binary, text/calendar, and text/XML.
There are two types of calendar notifications:
Alarm Notifications– relay reminders
Calendar Update Notifications– distribute changes to the calendar database
Alarm notifications relay reminders. They are published by the csadmind daemon whenever it wants to send a reminder. The default subscriber for these alarms in Communications Suite is the csnotifyd daemon. Notifications consumed by csnotifyd have a binary payload and are acknowledged (reliable).
Additionally, the server can be configured to generate one additional notification for each reminder, which can be consumed by a third party notification infrastructure.
Table 5–1 shows the configuration variables that enable these notifications.
Table 5–1 Alarm Notifications
ics.conf |
Default Value |
Descripton |
||
---|---|---|---|---|
|
|
Used by csadmind and csnotifyd to send SMTP reminders. |
||
|
yes |
Enable or disable the default alarm (binary) transport provided by the Calendar Server product. |
||
|
NULL |
ENS topic URL for custom implementation. If this is NULL, then no formatted messages will be published. The ics.conf value will be set to enp:///ics/alarm. |
||
|
text/xml |
Content MIME type of formatted message. |
||
|
300 |
Retry interval in seconds for failed deliveries. Specify zero (0) to disable retry. |
Event URL parameters are the same for either one:
calid - Calendar ID
uid - Component, either event or todo (task) ID
rid - Recurrence ID
aid - Alarm ID
comptype - An event or a todo (task)
URI
Calendar update notifications distribute changes to the calendar database. They are published by the cshttpd or csdwpd daemons whenever a change is made to the database (if the notification is enabled for this type of change).
There are eleven types of notifications. Table 5–2 lists each type of calendar update notification, it’s ics.conf parameters, and their default values.
Table 5–2 Calendar Update Notifications
Types |
ics.conf Parameters |
Default Value |
||||||
---|---|---|---|---|---|---|---|---|
Attendee refresh actions |
|
|
||||||
Attendee reply action |
|
|
||||||
Calendar creation |
|
|
||||||
Calendar deletion |
|
|
||||||
Calendar modification |
|
|
||||||
Event creation |
|
|
||||||
Event modification |
|
|
||||||
Event deletion |
|
|
||||||
Todo (task) creation |
|
|
||||||
Todo (task) modification |
|
|
||||||
Todo (task) deletion |
|
|
Event URL parameters include:
calid - Calendar ID
uid - Component, either event or todo (task) ID
rid - Recurrence ID
Normally, ENS notifications for attendee replies and organizer refreshes are published to the caldb.berkeleydb.ensmsg.modifyevent topic along with other modifications. By setting the ics.conf parameter caldb.berkeleydb.ensmsg.advancedtopics to “yes” (the default is “no”), the ENS notifications can be published to separate modify, reply and refresh topics. This allows the consumer of the notification to understand more precisely what type of transaction triggered the notification.
Table 5–3 shows the topics ENS publishes notifications to depending on the setting of the ics.conf parmeter caldb.berkeleydb.ensmsg.advancedtopics.
Table 5–3 Advanced Topics Parameter
Value of Advanced Topics Parameter |
Topics to Which ENS Publishes Attendee Notifications |
|
---|---|---|
yes |
|
|
no |
|
When ENS sends out notifications of modifications made to existing events, it returns two X-Tokens with the notification, X-NSCP-COMPONENT-SOURCE and X-NSCP-TRIGGERED-BY.
The contents of the X-NSCP-COMPONENT-SOURCE X-Token varies depending on who originated the event and the absence or presence of the appid parameter in the original WCAP command that requested the event.
If the appid parameter is present in the original WCAP command, ENS returns its value in the X-NSCP-COMPONENT-SOURCE X-Token.(Only certain commands take the appid parameter. See the Calendar Server Programmer’s Manual for further information on the appid parameter.) Using this mechanism, applications can “tag” ENS notifications in order to detect which ones it originated. The value of the appid command is a character string of the application’s choosing. If the appid parameter is missing, standard values are assigned to the X-Token depending on the origin, see Table 5–4 that follows for the standard values).
The X-Token, X-NSCP-TRIGGERED-BY holds the name (uid) of the organizer or attendee that triggered the notification regardless of the absence or presence of the appid parameter.
Table 5–4 shows the effect of the presence of the appid parameter in WCAP commands on the value of the X-Token X-NSCP-COMPONENT-SOURCE.
Table 5–4 Presence of appid and Value of X-Token X-NSCP-COMPONENT-SOURCE
appid Present? |
Value of X-Token X-NSCP-COMPONENT-SOURCE (with Request Origin) |
---|---|
no |
WCAP (default) CALENDAR EXPRESS (from UI) ADMIN (from Admin tools) |
yes |
Value of appid |
Calendar Server ships with a complete ENS implementation. If you wish to customize it, you may use the ENS APIs to do so. The following four code samples, a simple publisher and subscriber pair, and a reliable publisher and subscriber pair, illustrate how to use the ENS API. The sample code is provided with the product in the following directory:
/opt/SUNWics5/cal/csapi/samples/ens
This sample code pair establishes a simple interactive asynchronous publisher and subscriber.
/* * Copyright 2000 by Sun Microsystems, Inc. * All rights reserved * * apub : simple interactive asynchronous publisher using * * Syntax: * apub host port */ #include <stdlib.h> #include <stdio.h> #include "pasdisp.h" #include "publisher.h" static pas_dispatcher_t *disp = NULL; static publisher_t *_publisher = NULL; static int _shutdown = 0; static void _read_stdin(); static void _exit_usage() { printf("\nUsage:\napub host port\n"); exit(5); } static void _exit_error(const char *msg) { printf("%s\n", msg); exit(1); } static void _call_shutdown() { _shutdown = 1; pas_shutdown(disp); } static void _open_ack(void *arg, int rc, void *enc) { _publisher = (publisher_t *)enc; (void *)arg; if (!_publisher) { printf("Failed to create publisher with status %d\n", rc); _call_shutdown(); return; } _read_stdin(); return; } static void _publish_ack(void *arg, int rc, void *ignored) { (void *)ignored; free(arg); if (rc != 0) { printf("Publish failed with status %d\n", rc); _call_shutdown(); return; } _read_stdin(); return; } static void _read_stdin() { static char input[1024]; printf("apub> "); fflush(stdout); while (!_shutdown) { if ( !fgets(input, sizeof(input), stdin) ) { continue; } else { char *message; unsigned int message_len; input[strlen(input) - 1] = 0; /* Strip off the \n */ if (*input == ’.’ && input[1] == 0) { publisher_delete(_publisher); _call_shutdown(); break; } message = strdup(input); message_len = strlen(message); publish(_publisher, "enp://siroe.com/xyz",message, message_len, _publish_ack, NULL, (void *)message, 0); return; } } return; } main(int argc, char **argv) { unsigned short port = 7997; char host[256]; if (argc < 2) _exit_usage(); if (*(argv[1]) == ’0’) { strcpy(host, "127.0.0.1"); } else { strcpy(host, argv[1]); } if (argc > 2) { port = (unsigned short)atoi(argv[2]); } disp = pas_dispatcher_new(NULL); if (disp == NULL) _exit_error("Can’t create publisher"); publisher_new_a(disp, NULL, host, port, _open_ack, disp); pas_dispatch(disp); _shutdown = 1; pas_dispatcher_delete(disp); exit(0); }
/* * Copyright 2000 by Sun Microsystems, Inc. * All rights reserved * * asub : example asynchronous subscriber * * Syntax: * asub host port */ #include <stdlib.h> #include <stdio.h> #include "pasdisp.h" #include "subscriber.h" static pas_dispatcher_t *disp = NULL; static subscriber_t *_subscriber = NULL; static subscription_t *_subscription = NULL; static renl_t *_renl = NULL; static void _exit_usage() { printf("\nUsage:\nasub host port\n"); exit(5); } static void _exit_error(const char *msg) { printf("%s\n", msg); exit(1); } static void _subscribe_ack(void *arg, int rc, void *subscription) { (void)arg; if (!rc) { _subscription = subscription; printf("Subscription successful\n"); } else { printf("Subscription failed - status %d\n", rc); pas_shutdown(disp); } } static void _unsubscribe_ack(void *arg, int rc, void *ignored) { (void *)ignored; (void *)arg; if (rc != 0) { printf("Unsubscribe failed - status %d\n", rc); } subscriber_delete(_subscriber); pas_shutdown(disp); } static int _handle_notify(void *arg, char *url, char *str, int len) { (void *)arg; printf("[%s] %.*s\n", url, len, (str) ? str : "(null)"); return 0; } static void _open_ack(void *arg, int rc, void *enc) { _subscriber = (subscriber_t *)enc; (void *)arg; if (rc) { printf("Failed to create subscriber with status %d\n", rc); pas_shutdown(disp); return; } subscribe(_subscriber, "enp://siroe.com/xyz", _handle_notify, NULL, _subscribe_ack, NULL); return; } static void _unsubscribe(int sig) { (int)sig; unsubscribe(_subscriber, _subscription, _unsubscribe_ack, NULL); } main(int argc, char **argv) { unsigned short port = 7997; char host[256]; if (argc < 2) _exit_usage(); if (*(argv[1]) == ’0’) { strcpy(host, "127.0.0.1"); } else { strcpy(host, argv[1]); } if (argc > 2) { port = (unsigned short)atoi(argv[2]); } disp = pas_dispatcher_new(NULL); if (disp == NULL) _exit_error("Can’t create publisher"); subscriber_new_a(disp, NULL, host, port, _open_ack, NULL); pas_dispatch(disp); pas_dispatcher_delete(disp); exit(0); }
This sample code pair establishes a reliable asynchronous publisher and subscriber.
/* * Copyright 2000 by Sun Microsystems, Inc. * All rights reserved * * rpub : simple *reliable* interactive asynchronous publisher. * It is designed to be used in combination with rsub, * the reliable subscriber. * * Syntax: * rpub host port */ #include <stdlib.h> #include <stdio.h> #include "pasdisp.h" #include "publisher.h" static pas_dispatcher_t *disp = NULL; static publisher_t *_publisher = NULL; static int _shutdown = 0; static renl_t *_renl; static void _read_stdin(); static void _exit_usage() { printf("\nUsage:\nrpub host port\n"); exit(5); } static void _exit_error(const char *msg) { printf("%s\n", msg); exit(1); } static void _call_shutdown() { _shutdown = 1; pas_shutdown(disp); } static void _renl_create_cb(void *arg, int rc, void *ignored) { (void *)arg; (void *)ignored; if (!_publisher) { printf("Failed to create RENL - status %d\n", rc); _call_shutdown(); return; } _read_stdin(); return; } static void _publisher_new_cb(void *arg, int rc, void *enc) { _publisher = (publisher_t *)enc; (void *)arg; if (!_publisher) { printf("Failed to create publisher - status %d\n", rc); _call_shutdown(); return; } renl_create_publisher(_publisher, "renl_id", NULL, _renl_create_cb,NULL); return; } static void _recv_ack(void *arg, int rc, void *ignored) { (void *)ignored; if (rc < 0) { printf("Acknowledgment Timeout\n"); } else if ( rc == 0) { printf("Acknowledgment Received\n"); } fflush (stdout); _read_stdin(); free(arg); return; } static void _read_stdin() { static char input[1024]; printf("rpub> "); fflush(stdout); while (!_shutdown) { if ( !fgets(input, sizeof(input), stdin) ) { continue; } else { char *message; unsigned int message_len; input[strlen(input) - 1] = 0; /* Strip off the \n */ if (*input == ’.’ && input[1] == 0) { publisher_delete(_publisher); _call_shutdown(); break; } message = strdup(input); message_len = strlen(message); /* five seconds timeout */ publish(_publisher, "enp://siroe.com/xyz", message, message_len, NULL, _recv_ack, message, 5000); return; } } return; } main(int argc, char **argv) { unsigned short port = 7997; char host[256]; if (argc < 2) _exit_usage(); if (*(argv[1]) == ’0’) { strcpy(host, "127.0.0.1"); } else { strcpy(host, argv[1]); } if (argc > 2) { port = (unsigned short)atoi(argv[2]); } disp = pas_dispatcher_new(NULL); if (disp == NULL) _exit_error("Can’t create publisher"); publisher_new_a(disp, NULL, host, port, _publisher_new_cb, NULL); pas_dispatch(disp); _shutdown = 1; pas_dispatcher_delete(disp); exit(0); }
/* * Copyright 2000 by Sun Microsystems, Inc. * All rights reserved * * asub : example asynchronous subscriber * * Syntax: * asub host port */ #include <stdlib.h> #include <stdio.h> #include "pasdisp.h" #include "subscriber.h" static pas_dispatcher_t *disp = NULL; static subscriber_t *_subscriber = NULL; static subscription_t *_subscription = NULL; static renl_t *_renl = NULL; static void _exit_usage() { printf("\nUsage:\nasub host port\n"); exit(5); } static void _exit_error(const char *msg) { printf("%s\n", msg); exit(1); } static void _subscribe_ack(void *arg, int rc, void *subscription) { (void)arg; if (!rc) { _subscription = subscription; printf("Subscription successful\n"); _renl = renl_create_subscriber(_subscription, "renl_id", NULL); } else { printf("Subscription failed - status %d\n", rc) pas_shutdown(disp); } } static void _unsubscribe_ack(void *arg, int rc, void *ignored) { (void *)ignored; (void *)arg; if (rc != 0) { printf("Unsubscribe failed - status %d\n", rc); } subscriber_delete(_subscriber); pas_shutdown(disp); } static int _handle_notify(void *arg, char *url, char *str, int len) { (void *)arg; printf("[%s] %.*s\n", url, len, (str) ? str : "(null)"); return 0; } static void _open_ack(void *arg, int rc, void *enc) { _subscriber = (subscriber_t *)enc; (void *)arg; if (rc) { printf("Failed to create subscriber with status %d\n", rc); pas_shutdown(disp); return; } subscribe(_subscriber, "enp://siroe.com/xyz",_handle_notify, NULL,_subscribe_ack, NULL); return; } static void _unsubscribe(int sig) { (int)sig; unsubscribe(_subscriber, _subscription, _unsubscribe_ack, NULL); } main(int argc, char **argv) { unsigned short port = 7997; char host[256]; if (argc < 2) _exit_usage(); if (*(argv[1]) == ’0’) { strcpy(host, "127.0.0.1"); } else { strcpy(host, argv[1]); } if (argc > 2) { port = (unsigned short)atoi(argv[2]); } disp = pas_dispatcher_new(NULL); if (disp == NULL) _exit_error("Can’t create publisher"); subscriber_new_a(disp, NULL, host, port, _open_ack, NULL); pas_dispatch(disp); pas_dispatcher_delete(disp); exit(0);
}