Depth Property

The depth associated with the current operation.


public int getDepth();
public void setDepth(int depth);

Enumerated values: public final static int dpUnspecified = 0; public final static int dpResourceOnly = 1; public final static int dpImmediateChildren = 2; public final static int dpInfinity = 3;


When performing certain operations on resource collections, the component will use Depth to instruct the server on how deep to operate within the collection. Depth is an enumerated type with the following possible values:

dpUnspecified (0)The server will use the protocol default depth for the operation (this is normally "infinity").
dpResourceOnly (1)The server will operate only on the collection resource URI, and not on any of its internal member resources.
dpImmediateChildren (2)The server will operate on the collection resource URI and all of its immediate member resources (but on none of their member resources).
dpInfinity (3)The server will recursively operate on the target resource URI and all of its internal member URIs through all levels of the collection hierarchy.

Depth is used when performing the following operations: LockResource, MoveResource CopyResource, FindProperties, PatchProperties, and ListDirectory.

Default Value


Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2020 Android Edition - Version 20.0 [Build 8161]