com.quantum.dxi.rest.nas

Class ShareAdministrators

java.lang.Object

Base

com.quantum.dxi.rest.nas.ShareAdministrators

public class ShareAdministrators
extends Base

The ShareAdministrators resource represents Windows Active Directory domain users and groups that have been granted share admin privileges on the system. The ShareAdministrators interface includes services for adding, deleting, and getting share administrators.

The schema that defines the ShareAdministrators resource is defined below.

 
    <xs:element name="ShareAdministrator">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="UserName" type="xs:string"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="ShareAdministrators">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="TotalCount" type="xs:int" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Total number of share administrators</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element ref="ShareAdministrator" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="ShareAdministratorColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="UserName"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
ShareAdministrators()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addShareAdministrator(javax.servlet.http.HttpServletRequest request, ShareAdministrator shareAdministrator, java.lang.String errorType) POST /rest/ShareAdministrators
void	deleteShareAdministrator(javax.servlet.http.HttpServletRequest request, java.lang.String userName, java.lang.String errorType) DELETE /rest/ShareAdministrators/{userName}
ShareAdministrator	getShareAdministrator(javax.servlet.http.HttpServletRequest request, java.lang.String userName) GET /rest/ShareAdministrators/{userName}
NumericScalarType	getShareAdministratorCount(javax.servlet.http.HttpServletRequest request, int start, int limit, java.lang.String filterString, java.lang.String errorType) GET /rest/ShareAdministrators/getRowCount
java.lang.Object	getShareAdministrators(javax.servlet.http.HttpServletRequest request, int start, int limit, java.lang.String sortColumn, java.lang.String sortDirection, java.lang.String actionString, java.lang.String filterString, java.lang.String errorType) GET /rest/ShareAdministrators

Methods inherited from class java.lang.Object

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

Constructor Detail

ShareAdministrators

public ShareAdministrators()

Method Detail

getShareAdministratorCount

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

GET /rest/ShareAdministrators/getRowCount

Get the number of domain Share Administrators on the system.

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

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

Since:

1.1

getShareAdministrators

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

GET /rest/ShareAdministrators

Get the domain Share Administrators on the system.

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

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

Since:

1.1

getShareAdministrator

public ShareAdministrator getShareAdministrator(@Context
                                                javax.servlet.http.HttpServletRequest request,
                                                java.lang.String userName)

GET /rest/ShareAdministrators/{userName}

Get the domain Share Administrator on the system identified by {shareName}.

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

Since:

1.1

deleteShareAdministrator

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

DELETE /rest/ShareAdministrators/{userName}

Remove the domain user identified by {shareName} as a share administrator on the system.

Since:

1.1

addShareAdministrator

public javax.ws.rs.core.Response addShareAdministrator(@Context
                                                       javax.servlet.http.HttpServletRequest request,
                                                       ShareAdministrator shareAdministrator,
                                                       java.lang.String errorType)

POST /rest/ShareAdministrators

Add a domain user as a share administrator on the system.

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

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

Since:

1.1