com.quantum.dxi.rest.dataservices

Class BackupApplicationUsers

java.lang.Object

Base

com.quantum.dxi.rest.dataservices.BackupApplicationUsers

public class BackupApplicationUsers
extends Base

The BackupApplicationUsers resource represents user authentication credentials for backup applications connected to the system. The BackupApplicationusers interface includes services for getting the list of configured backup users, adding users, modifying users, and deleting users.

The schema that defines the BackupApplicationUsers resource is defined below.

 
    <xs:element name="BackupApplicationUsers">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="TotalCount" type="xs:int" minOccurs="0"/>
                <xs:element ref="BackupApplicationUser" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="BackupApplicationUser">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="Username" type="xs:string"/>
                <xs:element name="Password" type="xs:string" minOccurs="0"/>
                <xs:element name="Description" type="xs:string" minOccurs="0"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="BackupApplicationUserColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="Username"/>
            <xs:enumeration value="Description"/>
            <xs:enumeration value="Password"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
BackupApplicationUsers()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addBackupApplicationUser_1_1(javax.servlet.http.HttpServletRequest request, BackupApplicationUser backupApplicationUser) POST /rest/BackupApplicationUsers
BackupApplicationUser	addBackupApplicationUser(javax.servlet.http.HttpServletRequest request, BackupApplicationUser backupApplicationUser) Deprecated. As of 1.1 replaced by addBackupApplicationUser_1_1(HttpServletRequest, BackupApplicationUser)
void	deleteBackupApplicationUser(javax.servlet.http.HttpServletRequest request, java.lang.String userName) DELETE /rest/BackupApplicationUsers/{userName}
BackupApplicationUser	getBackupApplicationUser(javax.servlet.http.HttpServletRequest request, java.lang.String userName) GET /rest/BackupApplicationUsers/{userName}
java.lang.Object	getBackupApplicationUsers(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) GET /rest/BackupApplicationUsers
NumericScalarType	getRowCount(javax.servlet.http.HttpServletRequest request, int start, int limit, java.lang.String filterString) GET /rest/BackupApplicationUsers/getRowCount
BackupApplicationUser	updateBackupApplicationUser(javax.servlet.http.HttpServletRequest request, java.lang.String userName, BackupApplicationUser backupApplicationUser) PUT /rest/BackupApplicationUsers/{userName}

Methods inherited from class java.lang.Object

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

Constructor Detail

BackupApplicationUsers

public BackupApplicationUsers()

Method Detail

getRowCount

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

GET /rest/BackupApplicationUsers/getRowCount

Get the number of backup application users on the system.

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

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

Since:

1.1

getBackupApplicationUsers

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

GET /rest/BackupApplicationUsers

Get the list of backup application users on the system.

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

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

Deprecated as of 1.1: The "action" query parameter is deprecated.
?action=getRowCount replaced by getRowCount(HttpServletRequest, int, int, String)

Response Entity type: <xs:element name="NumericScalarType"> for query parameter ?action=getRowCount

getBackupApplicationUser

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

GET /rest/BackupApplicationUsers/{userName}

Get the backup application user on the system identified by {userName}.

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

deleteBackupApplicationUser

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

DELETE /rest/BackupApplicationUsers/{userName}

Delete the backup application user on the system identified by {userName}.

updateBackupApplicationUser

public BackupApplicationUser updateBackupApplicationUser(@Context
                                                         javax.servlet.http.HttpServletRequest request,
                                                         java.lang.String userName,
                                                         BackupApplicationUser backupApplicationUser)

PUT /rest/BackupApplicationUsers/{userName}

Modify the backup application user on the system identified by {userName}.

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

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

addBackupApplicationUser_1_1

public javax.ws.rs.core.Response addBackupApplicationUser_1_1(@Context
                                                              javax.servlet.http.HttpServletRequest request,
                                                              BackupApplicationUser backupApplicationUser)

POST /rest/BackupApplicationUsers

Create a new backup application user on the system.

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

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

Since:

1.1

addBackupApplicationUser

public BackupApplicationUser addBackupApplicationUser(@Context
                                                      javax.servlet.http.HttpServletRequest request,
                                                      BackupApplicationUser backupApplicationUser)

Deprecated. As of 1.1 replaced by addBackupApplicationUser_1_1(HttpServletRequest, BackupApplicationUser)

POST /rest/BackupApplicationUsers

Create a new backup application user on the system.

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

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