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

Command: check_id

Purpose

This administrator only command allows the administrator to verify that a session is still valid.

Parameters

Table 7–1 check_id Parameters


Parameter	Type	Purpose	Required	Default
`id`	string	The session identifier.	Y	N/A
`fmt-out`	string	The format for the returned data. The three format types: `text/calendar` `text/xml`	N	`text/calendar`

Purpose

This command allows the administrator to verify that the session is still valid.

Returns

The server returns the property X-NSCP-WCAP-CHECK-ID. If the value of this property is 1 the session is valid. If a zero (0) is returned, the session is invalid. It has either timed out or is unrecognized.

Example

The following command returns whether the specified session is valid or not:

http://calendarserver/check_id.wcap?
                     id=n3l0eeu6s3n3o3b8v
                     &fmt-out=text/calendar

The output returned is:

HTTP/1.1 200
 Date: Thu, 14 Dec 2002 19:48:17 GMT
 Content-type: text/calendar; charset=UTF-8
 Content-length: 131
 Last-modified: Thu, 14 Dec 2002 19:48:17 GMT
 Pragma: no-cache
 Expires: 0
 Cache-Control: no-cache
 Connection: Keep-Alive
 BEGIN:VCALENDAR
 PRODID:-//SunJavaSystem/Calendar Hosting Server//EN
 METHOD:PUBLISH
 VERSION:6.0
 X-NSCP-WCAP-CHECK-ID:1
 END:VCALENDAR