com.quantum.dxi.rest.retention

Class Lock

java.lang.Object

Base

com.quantum.dxi.rest.retention.Lock

public class Lock
extends Base

The Retention Lock resource represents lock status data for share files.

The schema that defines the Retention Lock status resource is defined below.

 
    <xs:complexType name="LockStatus">
        <xs:sequence>
            <xs:element name="DirEntry" type="xs:string" />
            <xs:element name="EntryType" type="xs:string" minOccurs="0" />
            <xs:element name="Enabled" type="xs:boolean" minOccurs="0" />
            <xs:element name="Days" type="xs:string" minOccurs="0" />
            <xs:element name="Locked" type="xs:long" minOccurs="0" />
            <xs:element name="LockedUntil" type="xs:long" minOccurs="0" />
            <xs:element name="Created" type="xs:long" minOccurs="0" />
            <xs:element name="Modified" type="xs:long" minOccurs="0" />
            <xs:element name="Size" type="xs:long" minOccurs="0" />
        </xs:sequence>
    </xs:complexType>
    <xs:complexType name="LockStatusList">
        <xs:sequence>
            <xs:element name="TotalCount" type="xs:int" minOccurs="0" />
            <xs:element name="List" type="LockStatus" minOccurs="0" maxOccurs="unbounded" />
        </xs:sequence>
    </xs:complexType>
    <xs:complexType name="RetentionLockAction">
        <xs:sequence>
            <xs:element name="Files" type="xs:string" maxOccurs="unbounded" />
            <xs:element name="Enabled" type="xs:boolean" />
            <xs:element name="Days" type="xs:string" minOccurs="0" />
        </xs:sequence>
    </xs:complexType>
 
 

Since:

1.2.11

Constructor Summary

Constructors

Constructor and Description
Lock()

Method Summary

Modifier and Type	Method and Description
LockStatusList	listRetentionStatus(javax.servlet.http.HttpServletRequest request, String share, String start, String count, String filter) GET /rest/retention/lock/{share}
LockStatusList	listRetentionStatus(javax.servlet.http.HttpServletRequest request, String share, String subdir, String start, String count, String filter) GET /rest/retention/lock/{share}/{subdir:.+}
void	setRetentionLock(javax.servlet.http.HttpServletRequest request, String share, RetentionLockAction lockAction) PUT /rest/retention/lock/{share}
void	unlockExpired(javax.servlet.http.HttpServletRequest request) PUT /rest/retention/lock/unlock-expired
void	unlockExpired(javax.servlet.http.HttpServletRequest request, String share) PUT /rest/retention/lock/{share}/unlock-expired

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Lock

public Lock()

Method Detail

listRetentionStatus

public LockStatusList listRetentionStatus(@Context
                                          javax.servlet.http.HttpServletRequest request,
                                          String share,
                                          String start,
                                          String count,
                                          String filter)

GET /rest/retention/lock/{share}

List Retention Lock status for files in a share.

Request Entity type: <xs:element name="LockStatusList">

Since:

1.2.11

listRetentionStatus

public LockStatusList listRetentionStatus(@Context
                                          javax.servlet.http.HttpServletRequest request,
                                          String share,
                                          String subdir,
                                          String start,
                                          String count,
                                          String filter)

GET /rest/retention/lock/{share}/{subdir:.+}

List Retention Lock status for files within a sub-directory in a share.

Request Entity type: <xs:element name="LockStatusList">

Since:

1.2.11

setRetentionLock

public void setRetentionLock(@Context
                             javax.servlet.http.HttpServletRequest request,
                             String share,
                             RetentionLockAction lockAction)

PUT /rest/retention/lock/{share}

Lock/unlock files in a share.

Since:

1.2.11

unlockExpired

public void unlockExpired(@Context
                          javax.servlet.http.HttpServletRequest request)

PUT /rest/retention/lock/unlock-expired

Unlock all files with expired retention period.

Since:

1.2.11

unlockExpired

public void unlockExpired(@Context
                          javax.servlet.http.HttpServletRequest request,
                          String share)

PUT /rest/retention/lock/{share}/unlock-expired

Unlock all files in a share with expired retention period.

Since:

1.2.11