3.1.4.14 LockStatus Subrequest

  • Article

This operation is used to retrieve information about the lock state of a file.<64>

The protocol client sends a LockStatus SubRequest message, which is of type LockStatusSubRequestType as specified in section 2.3.1.49. The protocol server responds with a LockStatus SubResponse message, which is of type LockStatusSubResponseType as specified in section 2.3.1.51. This is done as follows:

  • The protocol client prepares a request containing a URL for the file, a unique request token, and one or more SubRequest elements, as defined in section 2.2.3.2 and section 2.2.3.8. The SubRequest element is of type "LockStatus".

  • The protocol server receives the request and parses the logic to request the information about the lock status on a file. The requested information is prepared as a response and sent back to the protocol client.

The Response element is defined in section 2.2.3.5, and the SubResponse element is defined in section 2.2.3.10. The LockStatusSubResponseDataType defines the type of the SubResponseData element inside the LockStatus SubResponse element. The LockStatusSubResponseDataType is defined in section 2.3.1.50. The protocol server sends the requested information as attributes in the LockStatus SubResponseData element. The attributes sent by the protocol server are defined in section 2.3.1.50.

The protocol returns results based on the following conditions:

  • If the processing of the LockStatus subrequest by the protocol server failed to get the requested information about lock status or encountered an unknown exception, the protocol server returns an error code value set to "SubRequestFail".

Otherwise, the protocol server sets the error code value to "Success" to indicate success in processing the LockStatus subrequest.