com.quantum.dxi.rest.nas

Class WorkgroupUsers

java.lang.Object

Base

com.quantum.dxi.rest.nas.WorkgroupUsers

public class WorkgroupUsers
extends Base

The WorkgroupUsers resource represents Windows Workgroup users known to the system. This allows sharing CIFS/SMB shares from the system to workgroup users. The WorkgroupUsers interface includes services for adding, deleting, and getting workgroup users.

The schema that defines the WorkgroupUsers resource is defined below.

 
    <xs:element name="WorkgroupUser">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="UserName" type="xs:string"/>
                <xs:element name="AdminPrivileges" type="xs:boolean"/>
                <xs:element name="Password" type="xs:string" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Required for POST, optional for PUT, not returned by GET.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="Description" type="xs:string" minOccurs="0"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="WorkgroupUsers">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="TotalCount" type="xs:int" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Total number of workgroup users</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element ref="WorkgroupUser" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="WorkgroupUserColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="UserName"/>
            <xs:enumeration value="AdminPrivilege"/>
            <xs:enumeration value="Password"/>
            <xs:enumeration value="Description"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
WorkgroupUsers()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addWorkgroupUser(javax.servlet.http.HttpServletRequest request, WorkgroupUser workgroupUser, String errorType) POST /rest/WorkgroupUsers
void	deleteWorkgroupUser(javax.servlet.http.HttpServletRequest request, String userName, String errorType) DELETE /rest/WorkgroupUsers/{userName}
WorkgroupUser	getWorkgroupUser(javax.servlet.http.HttpServletRequest request, String userName) GET /rest/WorkgroupUsers/{userName}
NumericScalarType	getWorkgroupUserCount(javax.servlet.http.HttpServletRequest request, int start, int limit, String filterString, String errorType) GET /rest/WorkgroupUsers/getRowCount
Object	getWorkgroupUsers(javax.servlet.http.HttpServletRequest request, int start, int limit, String sortColumn, String sortDirection, String actionString, String filterString, String errorType) GET /rest/WorkgroupUsers
javax.ws.rs.core.Response	updateWorkgroupUser(javax.servlet.http.HttpServletRequest request, String userName, WorkgroupUser workgroupUser, String errorType) PUT /rest/WorkgroupUsers/{userName}

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkgroupUsers

public WorkgroupUsers()

Method Detail

getWorkgroupUserCount

public NumericScalarType getWorkgroupUserCount(@Context
                                               javax.servlet.http.HttpServletRequest request,
                                               int start,
                                               int limit,
                                               String filterString,
                                               String errorType)

GET /rest/WorkgroupUsers/getRowCount

Get the number of Workgroup Users on the system.

getWorkgroupUsersCount supports the table query parameters for filtering by column name. Column names are defined in <xs:element name="WorkgroupUserColumnName">

Response Entity type: <xs:element name="NumericScalarType">

Since:

1.1

getWorkgroupUsers

public Object getWorkgroupUsers(@Context
                                javax.servlet.http.HttpServletRequest request,
                                int start,
                                int limit,
                                String sortColumn,
                                String sortDirection,
                                String actionString,
                                String filterString,
                                String errorType)

GET /rest/WorkgroupUsers

Get the Workgroup Users on the system.

Response Entity type: <xs:element name="WorkgroupUsers">

<xs:element name="WorkgroupUsers"> supports the table query parameters. Column names for sorting and filtering are defined in <xs:element name="WorkgroupUserColumnName">

Since:

1.1

getWorkgroupUser

public WorkgroupUser getWorkgroupUser(@Context
                                      javax.servlet.http.HttpServletRequest request,
                                      String userName)

GET /rest/WorkgroupUsers/{userName}

Get the Workgroup User on the system identified by {shareName}.

Response Entity type: <xs:element name="WorkgroupUser">

Since:

1.1

deleteWorkgroupUser

public void deleteWorkgroupUser(@Context
                                javax.servlet.http.HttpServletRequest request,
                                String userName,
                                String errorType)

DELETE /rest/WorkgroupUsers/{userName}

Remove the user identified by {shareName} as a workgroup user on the system.

Since:

1.1

updateWorkgroupUser

public javax.ws.rs.core.Response updateWorkgroupUser(@Context
                                                     javax.servlet.http.HttpServletRequest request,
                                                     String userName,
                                                     WorkgroupUser workgroupUser,
                                                     String errorType)

PUT /rest/WorkgroupUsers/{userName}

Edit a workgroup user on the system.

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

Response Entity type: <xs:element name="WorkgroupUser">

Since:

1.1

addWorkgroupUser

public javax.ws.rs.core.Response addWorkgroupUser(@Context
                                                  javax.servlet.http.HttpServletRequest request,
                                                  WorkgroupUser workgroupUser,
                                                  String errorType)

POST /rest/WorkgroupUsers

Add a workgroup user on the system.

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

Response Entity type: <xs:element name="WorkgroupUser">

Since:

1.1