CalLock Type

Group of fields used when locking and unlocking a calendar resource.

Remarks

LockType, Owner, Scope Timeout, and Tokens are used when locking and unlocking a calendar resource. You may lock the whole calendar, or only a single event within the calendar, depending on the URI you use when locking. After a successful LockCalendar operation, the bean will set all of these fields to the values returned in the server's response. The lock Tokens are then passed along when copying or moving a calendar event.

Fields

LockType
String

The type of the current resource lock.

Before the calendar resource can be locked, the LockType may be set to the type of lock being requested. Currently, the bean only supports requesting locks of type "write", although the protocol defines an optional "read" lock. After a successful LockCalendar operation, the bean will set the LockType field to the correct value returned in the server's response.

Owner
String

The principle that owns the current resource lock.

Before the calendar resource can be locked, the Lock Owner may be set to the name of a principle or group of principles that will own the lock. If no owner is specified, the server will automatically associate the lock with the requesting principle. After a successful LockCalendar operation, the bean will set the Owner field to the correct value returned in the server's response.

Scope
String

The scope of the current resource lock.

Before the calendar resource can be locked, the Lock Scope may be set to the type of scope needed for the lock. Currently the bean will only allow two types of scopes to be requested:


"exclusive"	The lock belongs exclusively to the requesting principle. No other principle may modify the locked resource URI.
"shared"	The locked resource may not be modified by non-trusted principles. Users who have access rights, however, may request a shared lock which they can then use to modify or operate on the resource.

If no scope is specified, the protocol default scope, "exclusive", will be requested. After a successful LockCalendar operation, the bean will set the Scope field to the correct value returned in the server's response.

Timeout
int

The time to live for the current resource lock.

Before the calendar resource can be locked, the Lock Timeout may be set to a specific amount of time needed for the locked operation to take place. The timeout is used to determine how long the lock may exist before the server automatically unlocks the resource URI. If Timeout of 0 is specified, the server will use a default timeout. After a successful LockCalendar operation, the bean will set the Lock Timeout field to the correct value returned in the server's response.

Tokens
String

The lock string to be used when submitting operations on a locked resource.

Before the calendar resource can be locked, the Lock Tokens may be set to the tokens returned by a previous lock operation. This is useful when renewing a timeout. The server will respond with a new timeout value, which will be stored in Timeout. If the lock request is not a lock refresh, Tokens must be empty, and will be parsed out of the server response after a successful LockCalendar operation.

Constructors

public CalLock();