Previous      Contents      Index      Next
Sun Java System Calendar Server 6 2005Q1 Developer's Guide

About This Reference

This document of gives detailed instructions on the use of the following Sun Java™ System Calendar Server 6 2005Q1 (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
Accessing Sun Documentation 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 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)
Part 1 Non-WCAP APIs
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 Calendar Server.

Chapter 4, "Proxy Authentication SDK Reference"

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

Part 2 WCAP API
Chapter 5, "Web Calendar Access Protocol Overview"

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

Chapter 6, "WCAP Common Topics"

Covers topics of common interest that span multiple commands.

Chapter 7, "WCAP Command Reference"

This chapter details the individual commands.

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.

---

Accessing Sun Documentation Online

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

Sun Java System Calendar Server 6 2005Q1 Release Notes
Sun Java System Calendar Server 6 2005Q1 Administration Guide
Sun Java System Calendar Server 6 2005Q1 Developer’s Guide
Sun Java System Communications Services 6 2005Q1 Event Notification Service Guide
Sun Java System Communications Services 6 2005Q1 Schema Reference
Sun Java System Communications Services 6 2005Q1 Schema Migration Guide
Sun Java System Communications Services 6 2005Q1 User Management Utility Administration Guide
Sun Java System Communications Express 6 2005Q1 Administration Guide
Sun Java System Communications Express 6 2005Q1 Customization Guide

To find this book and all Calendar Server 6 2005Q1 documentation, use the following URL:

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

In addition, both graphical user interfaces, Calendar Express and Communications Express, have online help.

---

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

---

Part No:819-0025-10.   Copyright 2005 Sun Microsystems, Inc. All rights reserved.