About This Reference

Sun ONE Calendar Server 6.0 Programmer's Manual

About This Reference

This document of gives detailed instructions on the use of the following Sun™ Open Net Environment (Sun ONE) Calendar Server APIs and protocol that you may use to customize your server installation:

Calendar Server Application Program Interface (CSAPI), to modify server functionality.

Proxy Authentication SDK (authSDK), an external plugin to use a portal authenticaion service.

Web Calendar Access Protocol (WCAP), to access calendar services.

Topics covered in this chapter include:

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

Related Third-Party Web Site References

Who Should Read This Book

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

What You Need to Know

This book assumes that you are a programmer 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 RFCs describe in detail the format and definition for times, strings, parameters, etc. used in WCAP commands, unless otherwise specified.

The RFC’s may 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 three APIs, an SDK, and a protocol inside Sun ONE Calendar Server, as well as containing an overall architecture discussion of the product. For each interface there is an overview chapter, followed by a reference chapter, where available.

A list of the chapters follows:

About This Reference (this chapter)

Chapter 1, "Calendar Server API (CSAPI) Overview"

This API allows programmers to customize server functionality in five areas: access control, authentication, calendar lookup, data format translation, and user attribute access.

Chapter 2, "CSAPI Reference"

This chapter describes the CSAPI interfaces and their methods.There are two types of interfaces: client and server.

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 Sun ONE Calendar Server.

Chapter 4, "Proxy Authentication SDK Reference"

This chapter describes the five functions that make up the SDK.

Chapter 5, "Web Calendar Access Protocol (WCAP) Overview"

This chapter give an introduction to the WCAP protocol. WCAP is a command based system for transmitting calendar data.

Chapter 6, "WCAP Commands"

Details of individual commands, and some common topics, comprise this chapter.

Glossary

Document Conventions

Monospaced Font

Monospaced font is used for any text that appears on the computer screen or text that you should type. It is also used for filenames, distinguished names, functions, and examples.

Italicized Font

Italicized font is used to represent text that you enter using information that is unique to your installation (for example, variables). It is used for server paths and names.

For example, throughout this document you will see path references of the form:

cal_svr_base/...

The Calendar Server Base (cal_svr_base) represents the directory path in which you install the server. The default value of the cal_svr_base is /opt/SUNWics5/cal.

Square or Straight Brackets

Square (or straight) brackets [] are used to enclose optional parameters.

Platform-specific Syntax

All paths specified in this manual are in UNIX® format.

Where to Find Related Information

In addition to this guide, these other documents are available:

Sun ONE Messaging and Collaboration Event Notification Service Manual

Sun ONE Calendar Server Administrator’s Guide

Sun ONE Calendar Server Installation Guide

Sun ONE Messaging and Collaboration Schema Reference Manual

Where to Find This Book Online

You can find the Calendar Server Programmer’s Manual online in PDF and HTML formats. To find this book and all the Sun ONE Calendar Server documentation, use this URL:

http://docs.sun.com/coll/S1_CalendarServer_60

Related Third-Party Web Site References

Third-party URLs 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 will not be 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.

Previous Contents Index Next

Copyright 2003 Sun Microsystems, Inc. All rights reserved.


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 will not be 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.