Package org.apache.webdav.lib

Class Lock

java.lang.Object
org.apache.webdav.lib.Lock
public class Lock extends Object
This class represents a lock on a resource.
Version:
$Revision: 1.3.2.1 $

  • Field Details

    • TAG_NAME

      public static final String TAG_NAME
      The property name.
      See Also:

    • TYPE_WRITE

      public static final int TYPE_WRITE
      The write constant in the locktype.
      See Also:

    • TYPE_TRANSACTION

      public static final int TYPE_TRANSACTION
      Type indicating lock is a transaction lock.
      See Also:

    • SCOPE_EXCLUSIVE

      public static final int SCOPE_EXCLUSIVE
      The exclusive constant in the lockscope.
      See Also:

    • SCOPE_SHARED

      public static final int SCOPE_SHARED
      The shared constant in the lockscope.
      See Also:

    • lockScope

      protected int lockScope

    • lockType

      protected int lockType

    • depth

      protected int depth

    • owner

      protected String owner

    • timeout

      protected int timeout

    • lockToken

      protected String lockToken

    • principalUrl

      protected String principalUrl

  • Constructor Details

    • Lock

      public Lock(int lockScope, int lockType)
      Default constructor for the lockentry.

    • Lock

      public Lock(int lockScope, int lockType, int depth, String owner, int timeout, String lockToken)
      Default constructor for the activelock.

    • Lock

      public Lock(int lockScope, int lockType, int depth, String owner, int timeout, String lockToken, String principalUrl)

    • Lock

      public Lock(int lockScope, int lockType, int depth, String owner, long timeout, String lockToken)
      Deprecated.
      The timeout value MUST NOT be greater than 2^32-1.
      Default constructor for the activelock.

  • Method Details

    • getLockScope

      public int getLockScope()
      Get whether a lock is an exclusive lock, or a shared lock.
      Returns:
      The lock scope. If it's not set, it could be -1.

    • getLockType

      public int getLockType()
      Get the access type of a lock.
      Returns:
      The lock type. If it's not set, it could be -1.

    • getDepth

      public int getDepth()
      Get the value of the depth.
      Returns:
      The depth vlaue. If it's not set, it could be -1.

    • getOwner

      public String getOwner()
      Get information about the principal taking out a lock.
      Returns:
      The owner.

    • getPrincipalUrl

      public String getPrincipalUrl()
      Get the principal-URL property of the lock, if one.
      Returns:
      an URL as String

    • getTimeout

      public int getTimeout()
      Get the timeout associated with a lock.
      Returns:
      The timeout vlaue. If it's not set, it could be -1.

    • getLockToken

      public String getLockToken()
      Get the access type of a lock.
      Returns:
      The lock token.

    • toString

      public String toString()
      Overrides:
      toString in class Object