Sun Java System Calendar Server 6 2005Q4 Developer's Guide

Preface

The Sun Java^TM System Calendar Server 6 2005Q4 Developer's Guide gives detailed instructions on the use of the following Sun Java^TM System Calendar Server 6 2005Q4 (Calendar Server) application program interfaces (API's) and a protocol that you can use to customize your server installation:

Calendar Server Application Program Interface (CSAPI)

Used to modify server functionality.
Proxy Authentication SDK (authSDK)

Plug-in for a portal authentication service.
Web Calendar Access Protocol (WCAP)

A protocol with commands used to access calendar services and data.

Topics covered in this preface include:

Who Should Use This Book

This guide is for software engineers who want to customize applications in order to implement Calendar Server.

Before You Read This Book

This book assumes that you are a software engineer with a knowledge of C/C++, and that you have a general understanding of the following:

The Internet and the World Wide Web
Calendaring concepts
LDAP
RFC 2445, RFC 2446, RFC 2447

These RFC's describe in detail the format and definition for times, strings, parameters, and so forth used in WCAP commands.

The RFC’s can be found at the IETF web site:
- http://www.ietf.org/rfc/rfc2445.txt
- http://www.ietf.org/rfc/rfc2446.txt
- http://www.ietf.org/rfc/rfc2447.txt

How This Book is Organized

This book documents an API, an SDK, and a protocol inside Calendar Server. For each interface, there is an overview chapter, followed by one or more reference chapters.

A list of the chapters follows:

Part 1 Calendar Server API (CSAPI)
- Chapter 1, Calendar Server API (CSAPI) Overview
  
  This API allows software engineers to customize server functionality in five areas:
  - Access Control
  - Authentication
  - Calendar Lookup
  - Data-Format Translation
  - User-Attribute Access
- Chapter 2, CSAPI Reference
  
  This chapter describes the CSAPI interfaces and their methods. Two types of interfaces exist: client and server.
Part 2 Proxy Authentication SDK (authSDK)
- Chapter 3, Proxy Authentication SDK Overview
  
  This chapter discusses one of the three authentication schemes shipped with the server. This API allows you to integrate your portal service with Calendar Server.
- Chapter 4, Proxy Authentication SDK Reference
  
  This chapter describes the five functions that make up the SDK.
Part 3 Web Calendar Access Protocol (WCAP)
- Chapter 5, Web Calendar Access Protocol Overview
  
  This chapter gives an introduction to the WCAP protocol. WCAP is a command-based system for transmitting calendar data.
- Chapter 6, WCAP Common Topics
  
  This chapter covers topics of common interest that span multiple commands.
- Chapter 7, WCAP Command Reference
  
  This chapter details the individual commands.

Related Books

The following Calendar Server documents are available online in PDF and HTML formats:

In addition, the graphical user interface, Communications Express, has online help.

Related Third-Party Web Site References

Third-party URL's are referenced in this document and provide additional, related information.

Note –

Sun is not responsible for the availability of third-party Web sites mentioned in this document. Sun does not endorse, and is not responsible or liable for, any content, advertising, products, or other materials that are available on or through such sites or resources. Sun is not responsible or liable for any actual or alleged damage or loss caused by or in connection with the use of or reliance on any such content, goods, or services that are available on or through such sites or resources.

Documentation, Software, Support, and Training

Sun Function	URL	Description
Documentation	http://www.sun.com/documentation	Download PDF and HTML documents, and order printed documents
Software	http://www.sun.com/software	Sun Software Gateway
Support	http://www.sun.com/support	Obtain technical support, download patches
Training	http://www.sun.com/training	Learn about Sun courses

Typographic Conventions

The following table describes the typographic changes that are used in this book.

Table P–1 Typographic Conventions


Typeface or Symbol	Meaning	Example
`AaBbCc123`	The names of commands, files, and directories, and onscreen computer output	Edit your `.login` file. Use `ls -a` to list all files. `machine_name% you have mail.`
`AaBbCc123`	What you type, contrasted with onscreen computer output	`machine_name%` `su` `Password:`
`aabbcc123`	Placeholder: replace with a real name or value	The command to remove a file is `rm` `filename`.
AaBbCc123	Book titles, new terms, and terms to be emphasized	Read Chapter 6 in the User's Guide. Perform a patch analysis. Do not save the file. [Note that some emphasized items appear bold online.]

Shell Prompts in Command Examples

The following table shows the default system prompt and superuser prompt for the C shell, Bourne shell, and Korn shell.

Table P–2 Shell Prompts


Shell	Prompt
C shell prompt	`machine_name%`
C shell superuser prompt	`machine_name#`
Bourne shell and Korn shell prompt	`$`
Bourne shell and Korn shell superuser prompt	`#`