Sun Java System Calendar Server 6 2005Q4 Administration Guide

Event Notification Server (ENS) Configuration

Calendar Server, when configured to do so, uses an external generic service called the Event Notification Server (ENS), which accepts reports of server-level events that can be categorized into specific areas of interest and notifies other servers that have registered interest in certain categories of events. Calendar Server uses ENS to send and receive alarm notifications that include the creation, deletion, or modification of calendar events and tasks as well as general operational warning and error messages.

The following table shows the Event Notification Server (ENS) configuration parameters in ics.conf. with each parameter’s default value and description.

Table E–18 Event Notification Server (ENS) Configuration Parameters in the ics.conf File

Parameter  

Default Value  

Description  

service.ens.enable

"yes"

If "yes", start the enpd service when starting all services and stop enpd when stopping all services.

service.ens.host

"localhost"

The host name of the machine on which ENS is running. 

service.ens.port

"57997"

The port number of the machine on which ENS is running. 

service.ens.library

"xenp"

The name of ENS plug-in. 

service.notify.enable

"yes"

If "yes", start the csnotifyd service when starting all services and stop csnotifyd when stopping all services.

service.notify.maxretrytime

"-1"

How many times csnotifyd will consecutively retry and fail to contact ENS. 

A value of "-1" causes the alarm thread to retry indefinitely.

service.notify.retryinterval

"3"

Number (in seconds) that csnotifyd waits before attempting to recontact ENS after a connection failure.

service.notify.startupretrytime

"0"

Total number of seconds Calendar Server keeps trying to contact ENS before it stops. This setting is similar to caldb.serveralarms.maxretrytime except that it applies only when the alarm thread is first starting. Once the alarm thread has successfully started, caldb.serveralarms.maxretrytime is used.

A value of "0" tells the alarm thread to exit immediately if it fails to connect to ENS at startup.

ens.startlistener

"0"

Acceptable values: 

  • "1"

  • "0"

caldb.berkeleydb.alarmretrytime

"300"

Retry time in seconds after a recoverable alarm delivery error. 

caldb.berkeleydb.ensmsg.createcal

"no"

If "yes", create an Event Notification Service message when a calendar is created using the following format: 

enp://ics/createcal?calid=cal

caldb.berkeleydb.ensmsg.modifycal

"no"

If "yes", create an Event Notification Service message when a calendar is modified using the following format:

enp://ics/modifycal?calid=cal

caldb.berkeleydb.ensmsg.deletecal

"no"

If "yes", create an Event Notification Service message when a calendar is deleted using the following format:

enp://ics/deletecal?calid=cal

caldb.berkeleydb.ensmsg.advancedtopics

"no"

Specifies how modify event notifications are published: 

  • If "yes", the system differentiates between reply, refresh, or modify transactions by publishing to the respective topic:

    caldb.berkeleydb.ensmsg.replyevent

    caldb.berkeleydb.ensmsg.refreshevent

    caldb.berkeleydb.ensmsg.modifyevent

  • If "no", the system publishes all three types (reply, refresh, modify) to the following topic:

    caldb.berkeleydb.ensmsg.modifyevent

caldb.berkeleydb.ensmsg.createevent

"no"

If "yes", create an ENS message when an event is created.

caldb.berkeleydb.ensmsg.deleteevent

"no"

If "yes", create an ENS message when an event is deleted.

caldb.berkeleydb.ensmsg.modifyevent

"no"

If "yes", create an ENS message when an event is modified.

caldb.berkeleydb.ensmsg.refreshevent

"no"

Specifies whether Calendar Server should create an ENS message when an event is refreshed. 

caldb.berkeleydb.ensmsg.refreshevent.contenttype

"text/xml"

Specifies the content type of the message data for the refresh of an event. Values can be "text/xml" or "text/calendar".

caldb.berkeleydb.ensmsg.refreshevent.url

"enp:///ics/caleventrefresh"

Specifies the URL for ENS message for the refresh of an event. 

caldb.berkeleydb.ensmsg.replyevent

"no"

Specifies whether Calendar Server should create an ENS message for a reply to an event. 

caldb.berkeleydb.ensmsg.replyevent.contenttype

"text/xml"

Specifies the content type of the message data for a reply to an event. Values can be "text/xml" or "text/calendar".

caldb.berkeleydb.ensmsg.replyevent.url

"enp:///ics
/caleventreply"

Specifies the URL for the ENS message for a reply to an event. 

caldb.berkeleydb.ensmsg.createtodo

"no"

If "yes", create an Event Notification Service message when a todo (task) is created using the following format:

enp://ics/createtodo?
uid=uid&rid=rid

caldb.berkeleydb.ensmsg.modifytodo

"no"

If "yes", create an Event Notification Service message when a task is modified using the following format: 

enp://ics/modifytodo?
uid=uid&rid=rid

caldb.berkeleydb.ensmsg.deletetodo

"no"

If "yes", create an Event Notification Service message when a task is deleted using the following format:

enp://ics/deletetodo?uid=uid&rid=rid

caldb.berkeleydb.ensmsg.qsize

"10000"

Initial size of the in-memory ENS message queue. This queue stores all ENS messages other than alarm reminders. 

caldb.berkeleydb.ensmsg.schedreq

"no"

If "yes", create an Event Notification Service message when a scheduling request is written to the calendar is deleted using the following format:

enp://ics/schedreq?calid=cal
&method=method&type={event|todo}
&uid=uid&rid=rid

caldb.serveralarms

"yes"

If "yes", alarm emails will be sent. 

caldb.serveralarms.acktimeout

"30"

Specifies the number of seconds ENS’s alarm thread waits for an acknowledgment from csnotifyd after publishing an alarm notification. If the timeout expires, the alarm thread assumes the alarm notification is no longer processing and publishes the alarm notification again. 

caldb.serveralarms.dispatchtype

"ens"

Specifies the dispatch type for Calendar Server alarms: 

  • If "ens", the server uses the external ENS to send and receive alarms.

  • If "smtp", the server sends alarms as standard SMTP messages and to bypass ENS.

caldb.serveralarms.initthreads

"10"

Initial number of server alarm threads. 

caldb.serveralarms.maxretrytime

"-1"

How many times the alarm thread will consecutively retry and fail to contact ENS. 

"-1" causes the alarm thread to retry indefinitely.

caldb.serveralarms.maxthreads

"10"

Maximum number of server alarm threads. 

caldb.serveralarms.retryinterval

"5"

Number (in seconds) that the alarm thread (in csadmind) waits before attempting to recontact ENS. 

caldb.serveralarms.stacksize

"65536"

Stack frame size for server alarm threads. 

caldb.serveralarms.startupretrytime

"0"

Total number of seconds Calendar Server keeps trying to contact ENS before failing. This setting is similar to the setting caldb.serveralarms.maxretrytime except that it applies only when the alarm thread is first starting. Once the alarm thread has started successfully, caldb.serveralarms.maxretrytime is used. 

If "0", the alarm thread exits immediately if it fails to connect to ENS at startup.

caldb.smtphost

"localhost"

Send alarm emails to this SMTP host.