Sun Java System Calendar Server 6 2005Q1 Developer's Guide |
Chapter 2
CSAPI ReferenceThis section details the nine CSAPI interfaces each of which is an API. The APIs are divided between client and server side.
Use the APIs listed in Table 2-1 and Table 2-2 to augment or override Calendar Server’s default behavior:
Table 2-2 Server APIs
Provides general server information, including version number.
Allows access to server’s memory allocation mechanism.
csIAccessControlImplement the methods in this interface to augment or override the default access control behavior of Calendar Server.
Methods
The csIAccessControl interface implements two methods:
Description
Defines the types of access allowed. You must set the return code to specify whether you are using the default access control or overriding the default.
CheckAccess
Purpose
Sets users’ calendar access.
Syntax
PRUint32 CheckAccess (char* aUser, char* aCalid, PRInt32 *aAccessRequest, PRInt32 *aAccessAllowed, PRInt32 *aReturnCode) = 0;
Parameters
The method has the following five parameters:
Returns
NS_OK on success. A non-zero error code on failure.
Description
Use this method to request access types for this user. You send in the name of the user in the aUser parameter, and the access types requested in the aAccessRequest parameter (bitmask).The system checks for only those access types specified in the aAccessRequest bitmask. The returned bitmask, aAccessAllowed, represents the user’s allowed access for the types you requested.
For anonymous access, the user ID is “anonymous”.
ICS_ACCESSTYPE constants (bitmaps) that define available access types are as follows:
Use this method to specify your own access control procedure. You can augment the native access control mechanism, performing your own processing first, then continuing with the default process, or you can completely replace the native access control mechanism.
Init
Purpose
Confirms that the interface has been registered, and provides a reference to the server.
Syntax
PRUint32 Init (nsISupports *a Server) = 0;
Parameters
The method has the following parameter:
aServer
On return, this location contains a reference to the server with which the module is registered.
Returns
NS_OK on success. A non-zero error code on failure.
Description
The server calls this method, after finding and registering the interface on module load, to confirm that the operation was successful. You can use the pointer returned in aServer to make calls out to the server.
csIAuthenticationAll plug-ins wishing to augment or override the default authentication behavior of the calendar server must implement this interface.
Methods
The csIAuthentication interface implements five methods:
Change a user’s password.
Confirms that the interface was found and registered.
Logs in a user.
Logs out a user.
Verify a user’s existence.
Description
Allows you to define logon, logoff, verification, and password methods that implement the authentication technique of your choice. You may replace a method and still continue to use the default for the others. Each method uses the return code parameter (aReturnCode) to tell the server whether to continue with the default access control process after executing the method. The return code value must be one of the following constants:
ChangePassword
Purpose
Changes the password for the specified user.
Syntax
PRUint32 Init (char* aUser, char* aOldPassword, char* aNewPassword, PRInt32 *aReturnCode) = 0;
Parameters
The method has the following four parameters:
Returns
On success, NS_AUTHENTICATION_CHANGEPASSWORD_SUCCESS. On failure, NS_AUTHENTICATION_CHANGEPASSWORD_FAILURE.
Description
Changes the password of the specified user.
Init
Purpose
Confirms that the interface has been registered, and provides a reference to the server.
Syntax
PRUint32 Init (nsISupports *aServer) = 0;
Parameters
The method has the following parameter:
aServer
On return, this location contains a reference to the server with which the module is registered.
Returns
NS_OK on success. A non-zero code on failure.
Description
The server calls this method after finding and registering the interface on module load, to confirm that the operation was successful. You can use the pointer returned in aServer to make calls out to the server.
Logon
Purpose
Augment or override the authentication procedure for plain text login.
Syntax
PRUint32 Login (char* aUser, char* aPassword, PRInt32 *aReturnCode) = 0;
Parameters
The method has the following three parameters:
Returns
On success, NS_AUTHENTICATION_LOGON_SUCCESS. On failure, NS_AUTHENTICATION_LOGON_FAILURE.
Description
Use this method to specify your own authentication procedure on login to Calendar Server. You can augment the native authentication mechanism, performing your own processing first, then continuing with the default process, or you can completely replace the native authentication mechanism
Logout
Purpose
Logout a user.
Syntax
PRUint32 Init (char* aUser,PRInt32 *aReturnCode) = 0;
Parameters
The method has the following two parameters:
Returns
NS_OK on success. A non-zero error code on failure.
Description
None.
VerifyUserExists
Purpose
Verify that the user ID is in the LDAP directory.
Syntax
PRUint32 Init (char* aUser,PRInt32 *aReturnCode) = 0;
Parameters
The method has the following two parameters:
Returns
NS_OK on success. A non-zero error code on failure.
Description
None.
csICalendarLookupImplement the methods in this interface to augment or override the default calendar lookup (LDAP). There are two types of calendar lookup provided in Calendar Server: algorithmic or LDAP. LDAP is the default type. Some of the methods in this plug-in are used only by the LDAP-type lookup.
The table that follows lists the methods for this plug-in, tells which type of lookup it supports: Algorithmic (Alg), or LDAP, and gives a description of the method.
Methods
The csICalendarLookup implements the following methods:
Description
Allows you to control calendar lookup by implementing one or more of the methods.
piReturnCode Values
There are four possible return codes for the piReturnCode parameter:
DeleteHostnameForCalid
Purpose
Removes the hostname in LDAP associated with the specified calid.
Syntax
PRInt32 GetHostnameForCalid(char* psCalid, PRInt32 *piReturnCode) = 0;
Parameters
The following are the parameters and definitions for this method:
psCalid
calid for which the hostname is requested.
piReturnCode
0= successful, non-zero indicates failure.
Returns
Returns zero for success; a non-zero code for failure. See piReturnCode Values.
Description
Removes the hostname associated with the specified calendar in the calendar lookup database. This is a no-op for the algorithmic implementation.
FreeCalid
Purpose
Frees a previously allocated, fully qualified calendar ID (calid).
Syntax
PRUint32 FreeCalid(char** aQualifiedCalid,PRInt32 *aReturnCode) = 0;
Parameters
The method has the following parameters:
aQualifiedCalid
calid to free.
aReturnCode
NS_OK if successful. Normal processing will not continue if unsuccessful.
Returns
NS_OK on success, non-zero error code on failure.
Description
Used by both implementations of lookup.
FreeType
Purpose
Frees a previously allocated database plug-in type.
Syntax
PRUint32 FreeType(char* aType,PRInt32 *aReturnCode) = 0;
Parameters
The method has the following parameters:
aType
The database plug-in type to free
aReturnCode
NS_OK if successful. Normal processing will not continue if unsuccessful.
Returns
NS_OK on success, non-zero error code on failure.
Description
Frees the string allocated in QueryType method. Used by both implementations.
GetHostnameForCalid
Purpose
Retrieves the hostname associated with the specified calid.
Syntax
PRInt32 GetHostnameForCalid(char* psCalid, char** ppsHost, PRInt32 *piReturnCode) = 0;
Parameters
The following are the parameters and definitions for this method:
psCalid
calid for which the hostname is requested.
ppsHost
The hostname to be returned.
piReturnCode
0= successful, non-zero indicates failure.
Returns
Returns zero for success; a non-zero code for failure. See piReturnCode Values.
Description
Gets the hostname associated with a calendar in the calendar lookup database. This is a no-op for the algorithmic implementation.
Init
Purpose
Confirms that the interface has been registered, and provides a reference to the server.
Syntax
PRUint32 Init(nsISupports *aServer) = 0;
Parameters
The method has the following parameter:
Returns
NS_OK on success, non-zero error code on failure.
Description
The server calls this method after finding and registering the interface on module load, to confirm that the operation was successful. You can use the pointer returned in aServer to make calls out to the server.
QualifyCalid
Purpose
Qualifies the relative calid.
Syntax
PRUint32 QualifyCalid(char* psCalid, char** ppsQualifiedCalid, PRInt32 *piReturnCode) = 0;
Parameters
The method has the following parameters:
psCalid
The calid to be qualified.
ppsQualifiedCalid
On return, contains the URL of the qualified calid.
piReturnCode
0= successful, non-zero indicates failure.
Returns
Zero on success, non-zero error code on failure.
Description
Returns the name of the qualified calid. The qualified calid format is:
dwp://back-end host[:port]/psCalid
QueryType
Purpose
Query type of database plug-in.
Syntax
PRUint32 QueryType(char* aType,PRInt32 *aReturnCode) = 0;
Parameters
The method has the following parameters:
aType
The type of CLD (Calendar Lookup Database).
aReturnCode
NS_OK if successful. Normal processing will not continue if unsuccessful.
Returns
NS_OK on success, non-zero error code on failure.
Description
This function retrieves a string representing the type of CLD the plugin implements.
The only supported type is “algorithmic”, which supports regular expressions.
SetHostnameForCalid
Purpose
Not currently used. Sets the host name for a calendar user.
Syntax
PRInt32 SetHostnameForCalid(char* psCalid, char* ppsHost, PRInt32 *piReturnCode) = 0;
Parameters
This method uses the following parameters:
psCalid
calid for which the hostname is to be set.
ppsHost
The hostname to be set.
piReturnCode
0= successful, non-zero indicates failure.
Returns
Zero for success; non-zero for failure. See
Description
Sets the hostname for a calid that is about to be created. This is a no-op for the algorithmic implementation.
csIDataTranslatorThis is the interface for data translator plug-ins. All parameters should be allocated by the plug-in.
Methods
The csIDataTranslator interface implements three methods:
Informs the server about the content types that this database translator supports.
Confirms that the interface was found and registered.
Translates calendar data to the specified MIME format.
Description
This interface allows you to manipulate or change the HTML Body content of calendar data flowing to, or from, the database, or between various data translators. The data translator manipulates the output format (fmt-out) component of a WCAP response.
Calendar Server supports the following MIME-types for translating calendar data:
A CSAPI Data Translation module registers with the server for a specific MIME-type using the GetSupportedContentType method. The translator can request that the incoming data be provided in any of the supported MIME-types.
When incoming data is in the MIME-type that the module takes as input, the server passes the data to the module’s Translate method. The translator converts the data to its supported MIME-type and passes it back to the server, which proceeds to update the database.
GetSupportedContentTypes
Purpose
Gets the content type this database translator supports.
Syntax
PRUint32 GetSupportedContentTypes (char** aSupportedInContentTypes, char** aSupportedOutContentType, char** aPreferredInContentType, PRInt32 *aReturnCode) = 0;
Parameters
The method has the following parameters:
Returns
NS_OK on success. A non-zero on failure.
Description
Get the content type this database translator supports.
Init
Purpose
Confirm that the interface has been registered and obtain a reference to the server.
Syntax
PRUint32 Init (nsISupports *aServer) = 0;
Parameters
The method has the following parameter:
aServer
On return, this location contains a reference to the server with which the module is registered.
Returns
NS_OK on success, non-zero error code on failure.
Description
The server calls this method after finding and registering the interface on module load, to confirm that the operation was successful. You can use the pointer returned in aServer to make calls out to the server.
Translate
Purpose
Implement the translation from one content type to another.
Syntax
PRUint32 Translate (char* aInContentType, char* aOutContentType, char** aInBuffer, char** aOutBuffer, PRInt32 *aInSize, PRInt32 *aOutsize, PRInt32 *aReturncode) = 0;
Parameters
The method has the following parameters:
Returns
NS_OK on success, non-zero on failure.
Description
This method retrieves content of the specified input type from the specified buffer, translates the content from its original format to the output format, stores the translated content in the specified output buffer, and stores the size of the output buffer at the specified location.
csIPluginYou should implement the methods in this interface in order to provide the server with information about your plug-in module on startup.
Methods
The csIPlugin interface implements four methods:
Gets a textual description of what the plug-in does.
Gets a textual description of the vendor supplying this plug-in.
Gets the major and minor version of the plug-in. This value must be greater than or equal to 1.0. For a list of the current version numbers for each plug-in API, seeTable 1-1 Current Plug-in API Versions in Chapter 1, "Calendar Server API (CSAPI) Overview.".
Confirms that the interface was found and registered.
Description
This interface is not required, but it is highly recommended that you implement it in each module to provide version information to the server when it loads that module. The methods return descriptive information to the server.
GetDescription
Purpose
Retrieve a text description of the module.
Syntax
PRUint32 GetDescription (nsString& aDescription) = 0;
Parameters
The method has the following parameter:
Returns
NS_OK on success, non-zero error code on failure.
Description
Use this method to provide a text description of the module.
GetVendorName
Purpose
Retrieve a text description of the vendor supplying the module.
Syntax
PRInt32 GetVendorName (nsString& aVendorName) = 0;
Parameters
The method has the following parameter:
Returns
NS_OK on success, non-zero error code on failure.
Description
Use this method to identify the module’s supplier.
GetVersion
Purpose
Provide server with version information on startup.
Syntax
PRUint32 GetVersion (PRUint32& aMajorValue, PRUint32& aMinorValue) = 0;
Parameters
The method has the following two parameters:
aMajorValue
On return, contains the major version number.
aMinorValue
On return, contains the minor version number.
Returns
NS_OK on success, non-zero error code on failure.
Description
Use this method to identify the module’s major and minor version number. The number must be greater than or equal to 1.0.
Init
Purpose
Confirm that the interface has been registered and obtains a reference to the server.
Syntax
PRUint32 Init (nsISupports *aServer) = 0;
Parameters
The method has the following parameter:
aServer
On return, this location contains a reference to the server with which the module is registered.
Returns
NS_OK on success, non-zero error code on failure.
Description
The server calls this method, after finding and registering the interface on module load, to confirm that the operation was successful. You can use the pointer returned in aServer to make calls out to the server.
csIQualifiedCalidLookupImplement the methods in this interface to augment or override the default method of retrieving the calendar ID of the qualified URL passed in.
Methods
The csICalendarLookup implements two methods:
Description
Retrieves the calendar ID of the qualified URL passed in to it. If the calid is not found, the command returns an error.
FindCalid
Purpose
Finds the calendar ID for the URL specified.
Syntax
PRUint32 FindCalid (char* pQualifiedURL, char** ppCalidOut, PRInt32 *piCalidSize, PRInt32 *aReturnCode) = 0;
Parameters
The method has the following parameters:
Returns
The calid for the qualified URL passed in.
Description
Uses the qualified URL pointer passed to it to perform a search of the calendar ID database. If it finds a match, it returns a pointer to the address of the calid and an integer with the size of the calid.
Init
Purpose
Confirms that the interface has been registered, and provides a reference to the server.
Syntax
PRUint32 Init (nsISupports *aServer) = 0;
Parameters
The method has the following parameter:
Returns
NS_OK on success, non-zero error code on failure.
Description
The server calls this method after finding and registering the interface on module load, to confirm that the operation was successful. You can use the pointer returned in aServer to make calls out to the server.
csIUserAttributesImplement the methods in this interface to override the procedure for setting or retrieving user attributes.
Methods
The csIUserAttributes interface implements four methods:
Free the memory used to store a retrieved attribute.
Retrieve an attribute value for a user.
Confirm that the interface was found and registered.
Set an attribute value for a user.
Description
The User Attributes interface allows a CSAPI module to maintain or manipulate all requests coming in for setting and retrieving user attribute values. You provide methods that retrieve and set attributes using the technique of your choice.
FreeAttribute
Purpose
Free the memory associated with your local attribute storage.
Syntax
PRint32 FreeAttribute (char* aValue, PRInt32 *aReturnCode) = 0;
Parameters
The method has the following two parameters:
Returns
NS_OK on success, non-zero error code on failure.
Description
When you retrieve the value of an attribute using the GetAttribute method, the value is stored at a location that you have allocated, using the memory management technique of your choice. Use the FreeAttribute method to free that memory when it is no longer needed, using the same memory management technique. (See csIMalloc.)
GetAttribute
Purpose
Retrieve an attribute value for a user.
Syntax
PRUint32 GetAttribute (char* aUser, char* aKey, char** aValue, PRInt32 *aReturnCode) = 0;
Parameters
The method has the following four parameters:
Returns
NS_OK on success, non-zero error code on failure.
Description
Retrieves the value of the specified attribute for the specified user, and stores it at the location pointed to by aValue. You are responsible for allocating storage space for the returned attribute, and for freeing it (using the FreeAttribute method) when it is no longer needed.
Init
Purpose
Confirm that the interface has been registered and obtain a reference to the server.
Syntax
PRUint32 Init (nsISupports *aServer) = 0;
Parameters
The method has the following parameter:
aServer
On return, this location contains a reference to the server with which the module is registered.
Returns
NS_OK on success, non-zero error code on failure.
Description
The server calls this method, after finding and registering the interface on module load, to confirm that the operation was successful. You can use the pointer returned in aServer to make calls out to the server.
SetAttribute
Purpose
Set an attribute value for a user.
Syntax
PRUint32 SetAttribute (char* aUser, char* aKey, char* aValue, PRInt32 *aReturnCode) = 0;
Parameters
The method has the following parameters:
Returns
NS_OK on success, non-zero error code on failure.
Description
Sets the specified attribute for the specified user to the specified value.
csICalendarServerProvides server version information to a plug-in module.
Methods
The csICalendarServer interface implements two methods:
Description
Plug-in modules can query the csICalendarServer interface to get version information about the running instance of Calendar Server. The object is valid for the full lifetime of the client, so Init does not return a reference.
GetVersion
Purpose
Provide plug-in module with server version information.
Syntax
PRUint32 GetVersion (PRUint32& aMajorValue, PRUint32& aMinorValue) = 0;
Parameters
The method has the following two parameters:
aMajorValue
On return, contains the major version number.
aMinorValue
On return, contains the minor version number.
Returns
NS_OK on success, non-zero error code on failure.
Description
Use this method to identify the server’s major and minor version number. The number is always greater than or equal to 1.0.
Init
Purpose
Confirm that the interface has been registered.
Syntax
PRUint32 Init() = 0;
Parameters
The method has no parameters.
Returns
NS_OK on success, non-zero error code on failure.
Description
The server calls this method to confirm that the interface was found and registered successfully.
csIMallocAllocates and frees memory.
Methods
The csIMalloc interface implements six methods:
Description
Plug-in modules can use this object to take advantage of the server’s efficient memory allocation technique.The object is valid for the full lifetime of the client, so Init does not return a reference.
Calloc
Purpose
Allocates, and initializes to zero, memory for a number of objects.
Syntax
void* Calloc (PRUint32 aSize, PPRUint32 aNum) = 0;
Parameters
The method has the following two parameters:
Returns
A pointer to the allocated memory on success, or NULL on failure.
Description
This method allocates enough memory for the specified number of objects of the specified size, and initializes the memory to zero.
Free
Purpose
Free memory previously allocated by the Malloc method.
Syntax
PRUint32 Free (void * aPtr) = 0;
Parameters
The method has the following parameter:
Returns
NS_OK on success, non-zero error code on failure.
Description
Use this method in the same way as its C/C++ counterpart to free previously allocated memory.
FreeIf
Purpose
Free memory previously allocated by the Malloc method, allowing a NULL pointer.
Syntax
PRUint32 FreeIf (void * aPtr) = 0;
Parameters
The method has the following parameter:
Returns
NS_OK on success, non-zero error code on failure.
Description
Frees the memory at the specified location, if aPtr is not NULL.
Init
Purpose
Confirm that the interface has been registered.
Syntax
PRUint32 Init() = 0;
Parameters
The method has no parameters.
Returns
NS_OK on success, non-zero error code on failure.
Description
The server calls this method to confirm that the interface was found and registered successfully.
Malloc
Purpose
Allocate a specified amount of memory.
Syntax
void* Malloc (PRUint32 nBytes) = 0;
Parameters
The method has the following parameter:
Returns
A pointer to the allocated memory on success, or NULL on failure.
Description
Use this method in the same way as its C/C++ counterpart.
Realloc
Purpose
Reallocates memory that was previously allocated.
Syntax
void* Realloc (void* aPtr,PRUint32 nBytes) = 0;
Parameters
The method has the following parameter:
aPtr
A pointer to previously allocated memory.
nBytes
The size in bytes of the memory to be allocated.
Returns
A pointer to the allocated memory on success, or NULL on failure.
Description
Use this method in the same way as its C/C++ counterpart to reallocate memory that was previously allocated.