|
IP*Works! V9 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectipworks.CalLock
public class CalLock
Group of fields used when locking and unlocking a calendar resource.
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.
LockType: 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: 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: 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:
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: 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: 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.
Atom
,
Atom.CalLock
Constructor Summary | |
---|---|
CalLock()
|
Method Summary | |
---|---|
java.lang.String |
getLockType()
|
java.lang.String |
getOwner()
|
java.lang.String |
getScope()
|
int |
getTimeout()
|
java.lang.String |
getTokens()
|
void |
setLockType(java.lang.String value)
|
void |
setOwner(java.lang.String value)
|
void |
setScope(java.lang.String value)
|
void |
setTimeout(int value)
|
void |
setTokens(java.lang.String value)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CalLock()
Method Detail |
---|
public java.lang.String getLockType()
public void setLockType(java.lang.String value)
public java.lang.String getOwner()
public void setOwner(java.lang.String value)
public java.lang.String getScope()
public void setScope(java.lang.String value)
public int getTimeout()
public void setTimeout(int value)
public java.lang.String getTokens()
public void setTokens(java.lang.String value)
|
IP*Works! V9 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |