Contents


About This Reference

Who Should Read This Book
What You Need to Know
How This Book is Organized
Document Conventions
Where to Find Related Information
Where to Find This Book Online

Chapter 1 Architecture Overview

What is iPlanet Calendar Server?

Summary of Features

What's New in Version 5.0?
Calendar Server Services

csadmind
cshttpd
csnotifyd
csdwpd
enpd
Start Order

Group Scheduling

Directory Server Services

Horizontal Scalability

Configurations
Simple Single Instance
Network Front End, Database Back End
Multiple Front Ends, Multiple Back Ends

New Default Client UI: SHTML
Architecture Basics

SHTML and WCAP
Core
Database

Calendar Data

Calendar Data Format
Groups
Event Feeds
Calendar Data Exchange
Calendar User Preferences
Calendar Access Control
Supported Format Encoding

Calendar Server API (CSAPI)
Event Notification Service (ENS)
Proxy Authentication SDK (authSDK)
Single Sign-on (SSO)
Web Calendar Access Protocol (WCAP)

Chapter 2 Calendar Server API (CSAPI) Overview

CSAPI Architecture

Thread Safe Requirement
Dependencies

Using CSAPI

Loading CSAPI Modules
Plug-in Interfaces
Client and Server APIs

Server Query Example

CSAPI Samples

Chapter 3 CSAPI Reference

csIAccessContro

CheckAccess
Init

csIAuthenticatio

ChangePassword
Init
Logon
Logout
VerifyUserExists

csICalendarLooku

Init
QualifyCalid
FreeCalid
QueryType
FreeType

csIDataTranslato

GetSupportedContentTypes
Init
Translate

csIPlugi

GetDescription
GetVendorName
GetVersion
Init

csIQualifiedCalidLooku

FindCalid
Init

csIUserAttribute

FreeAttribute
GetAttribute
Init
SetAttribute

csICalendarServe

GetVersion
Init

csIMallo

Calloc
Free
FreeIf
Init
Malloc
Realloc

Chapter 4 Event Notification Service (ENS) Overview

ENS Glossary
Events
Event References

Example

Event Notification Service

Notify
Subscribe
Unsubscribe

Calendar Server Interaction with ENS

Alarm Queue
Daemons
Alarm Transfer Reliability
Example

API Overview

Publisher API Functions
Subscriber API Functions
Publish and Subscribe Dispatcher API Functions

Building and Running Custom Applications

Location of Sample Code
Location of Include Files
Dynamically Linked/Shared Libraries
Your Runtime Library Path Variable

Chapter 5 Event Notification Service API Reference

Publisher API Functions List
Subscriber API Functions List
Publish and Subscribe Dispatcher Functions List
Publisher AP

publisher_t
publisher_cb_t
publisher_new_a
publisher_new_s
publish_a
publish_s
publisher_delete
publisher_get_subscriber
renl_create_publisher
renl_cancel_publisher

Subscriber AP

subscriber_t
subscription_t
subscriber_cb_t
subscriber_notify_cb_t
subscriber_new_a
subscriber_new_s
subscribe_a
unsubscribe_a
subscriber_delete
subscriber_get_publisher
renl_create_subscriber
renl_cancel_subscriber

Publish and Subscribe Dispatcher AP

pas_dispatcher_t
pas_dispatcher_new
pas_dispatcher_delete
pas_dispatch
pas_shutdown

Sample Code

Simple Publisher and Subscriber

Publisher Code Sample
Subscriber Code Sample

Reliable Publisher and Subscriber

Reliable Publisher Sample
Reliable Subscriber Sample

Chapter 6 Proxy Authentication SDK Overview

Who Will Use the authSDK?
What Is the authSDK?
Architecture

Initialization
Lookup
Cleanup

Functions Overview

Chapter 7 Proxy Authentication SDK Reference

Proxy Authentication SDK Functions List
Proxy Authentication SDK Function

CEXP_GenerateLoginURL
CEXP_GetVersion
CEXP_Init
CEXP_SetHttpPort
CEXP_Shutdown

How to Use the authSDK

Other Tips

Chapter 8 Single Sign-on Authentication

What is Single Sign-on?
Limitations of Single Sign-on
Process Flow
Implementation Requirements

Cookie Information
Other recommended settings:
Trusted Applications Record
Single Sign-off Parameter
Prefix String

Single Sign-on Example

The Example
Configuration Parameters for the Example

Issues

Security
Management
Scalability
Performance

Chapter 9 Web Calendar Access Protocol (WCAP) Overview

Introduction
What's New in This Version
Command Overview

Session Identifiers

Command Formats

Client Request Formats

URI Format
HTML Form
Client Side Event Notification

Server Response Formats

Chapter 10 WCAP Commands

Common topics
Commands

Common Topics

Access Control Entries
Choosing a Different Language or Character Set
Deleting Recurring Components
Encoded Characters
Error Handling

Error String
Layer Error Number Array.
Layer Count Array.
Error Codes

Formatting of Time, Strings, Parameters, Etc.
Freebusy Access
New in iPlanet Calendar Server 5.0

New Commands
New Parameters

Output Format

Condensed Output

Recurrence Handling

rrules
rdates
exrules
exdates
rid
mod
rchange

Commands

addlink
change_password
check_id
createcalendar
deletecalendar
deletecomponents_by_range
deleteevents_by_id
deleteevents_by_range
deletetodos_by_id
deletetodos_by_range
export
fetchcomponents_by_alarmrange
fetchcomponents_by_attendee_error
Purpose.
fetchcomponents_by_lastmod
fetchcomponents_by_range
fetchevents_by_id
fetchtodos_by_id
get_all_timezones
get_calprops
get_freebusy
get_guids
get_userprefs
import
login
logout
ping
search_calprops
set_calprops
set_userprefs
storeevents
storetodos
upload_file
version
write_file

Index