Export (0) Print
Expand All

3.1.4.1 Common Message Processing Rules and Events

SharePoint

The protocol server MUST follow the following common processing rules for all types of subrequests:

  • The Url attribute in the cell storage service Request element specifies the unique URL for the file that the request is to be processed for. The Url attribute is specified in section 2.2.3.2.

  • The SubRequestToken attribute in the cell storage service SubRequest element uniquely identifies a subrequest for a file. The SubRequestToken attribute is specified in section 2.2.4.3.

  • The Type attribute in the cell storage service SubRequest element specifies the type of cell storage service subrequest. The protocol server uses the Type attribute to identify the type of cell storage service subrequest. The Type attribute is specified in section 2.2.4.2.

  • The DependencyType attribute in the cell storage service SubRequest element specifies the type of dependency that a subrequest has on another subrequest. DependencyType attribute for a SubRequest element is specified in section 2.2.4.3. The protocol server identifies the dependency type to check if the subrequest is to be processed.

  • The DependsOn attribute specifies the SubRequestToken of the subrequest that this subrequest depends on. The DependsOn attribute for a SubRequest element is specified in section 2.2.4.3.

The protocol server uses a combination of the DependsOn and DependencyType attributes for a specific subrequest to decide if a cell storage service subrequest will be executed. The protocol server sends a Response element for each Request element and a SubResponse element corresponding to each SubRequest element contained within a Request element.

If the protocol server supports shared locking, the protocol server MUST support at least one of the following subrequests:

  • The coauthoring subrequest

  • The schema lock subrequest

If the protocol server supports the coauthoring subrequest, it MUST support tracking the coauthoring transition. The coauthoring transition allows for the number of users editing the file to increase from 1 to n or to decrease from n to 1, where n is the maximum number of users who are allowed to edit a single file at an instant in time. If the protocol server supports the coauthoring subrequest, it MUST return a coauthoring status as specified in section 2.3.1.7.

A shared lock on a file is granted by sending one of the following subrequests to the protocol server:

  • A coauthoring subrequest

  • A schema lock subrequest

  • An exclusive lock subrequest of type "Convert to schema lock"

  • An exclusive lock subrequest of type "Convert to schema lock with coauthoring transition tracked"

An exclusive lock on a file is granted by sending one of the following subrequests to the protocol server:

  • An exclusive lock subrequest

  • A coauthoring subrequest of type "Convert to exclusive lock"

  • A schema lock subrequest of type "Convert to exclusive lock"

The protocol server does the following to decide when to release the lock on the file: When the timeout expires for a client, and no refresh on the timeout was received, the protocol server MUST release that client’s lock on the shared file. When the timeouts for all clients holding a shared lock on the file expire, the shared lock on the file MUST<26> be released by the protocol server. To prevent the lock on the file from expiring, the protocol client MUST send a request to refresh the timeout at a regular interval that is shorter than the lock timeout.

The protocol server is used by clients to synchronize both coauthorable files and files that are not coauthorable. The protocol server is also used by clients to synchronize file’s metadata contents.

The protocol server MAY return an error code value set to "RequestNotSupported" for a cell storage service subrequest if the following conditions are all true:

  • The protocol client sent a coauthoring subrequest.

  • The protocol server supports shared locking with tracking of the coauthoring transition.

  • The coauthoring administrator setting for the server is turned off.

Show:
© 2014 Microsoft