com.quantum.dxi.rest.ost

Class RemoteAIRCredentials

java.lang.Object

Base

com.quantum.dxi.rest.ost.RemoteAIRCredentials

public class RemoteAIRCredentials
extends Base

The RemmoteAIRCredentials resource represents user accounts and credentials for remote systems for use with OST Automatic Image Replication (AIR). The RemoteAIRCredentials service includes interfaces for getting, adding, updating, and deleting credentials for remote users for use with AIR.

The schema that defines the RemoteAIRCredentials resource is defined below.

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

    <xs:element name="RemoteAIRCredential">
        <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="RemoteAIRCredentialColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="Username"/>
            <xs:enumeration value="Password"/>
            <xs:enumeration value="Description"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
RemoteAIRCredentials()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addRemoteAIRCredential_1_1(javax.servlet.http.HttpServletRequest request, RemoteAIRCredential remoteAIRCredential) POST /rest/RemoteAIRCredentials
RemoteAIRCredential	addRemoteAIRCredential(javax.servlet.http.HttpServletRequest request, RemoteAIRCredential remoteAIRCredential) Deprecated. As of 1.1, @see #addRemoteAIRCredential_1_1(HttpServletRequest, RemoteAIRCredential)
void	deleteRemoteAIRCredential(javax.servlet.http.HttpServletRequest request, String user) DELETE /rest/RemoteAIRCredentials/{username}
RemoteAIRCredential	getRemoteAIRCredential(javax.servlet.http.HttpServletRequest request, String username) GET /rest/RemoteAIRCredentials/{username}
Object	getRemoteAIRCredentials(javax.servlet.http.HttpServletRequest request, int start, int limit, String sortColumn, String sortDirection, String actionString, String filterString) GET /rest/RemoteAIRCredentials
NumericScalarType	getRemoteAIRCredentialsCount(javax.servlet.http.HttpServletRequest request, int start, int limit, String filterString) GET /rest/RemoteAIRCredentials/getRowCount
StringListScalarType	getRemoteAIRCredentialsUsers(javax.servlet.http.HttpServletRequest request, int start, int limit, String filterString) GET /rest/RemoteAIRCredentials/getUsers
RemoteAIRCredential	updateRemoteAIRCredentialUsername(javax.servlet.http.HttpServletRequest request, String username, RemoteAIRCredential remoteAIRCredential) PUT /rest/RemoteAIRCredentials/{username}

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteAIRCredentials

public RemoteAIRCredentials()

Method Detail

getRemoteAIRCredentialsCount

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

GET /rest/RemoteAIRCredentials/getRowCount

Get the number of remote AIR credentials on the system.

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

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

Since:

1.1

getRemoteAIRCredentialsUsers

public StringListScalarType getRemoteAIRCredentialsUsers(@Context
                                                         javax.servlet.http.HttpServletRequest request,
                                                         int start,
                                                         int limit,
                                                         String filterString)

GET /rest/RemoteAIRCredentials/getUsers

Get the names of remote AIR users on the system.

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

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

Since:

1.1

getRemoteAIRCredential

public RemoteAIRCredential getRemoteAIRCredential(@Context
                                                  javax.servlet.http.HttpServletRequest request,
                                                  String username)

GET /rest/RemoteAIRCredentials/{username}

Get credentials for the remote AIR account identified by {username}.

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

Since:

1.2

getRemoteAIRCredentials

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

GET /rest/RemoteAIRCredentials

Get the list of remote AIR credentials on the system.

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

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

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

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

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

deleteRemoteAIRCredential

public void deleteRemoteAIRCredential(@Context
                                      javax.servlet.http.HttpServletRequest request,
                                      String user)

DELETE /rest/RemoteAIRCredentials/{username}

Delete the remote AIR credentials on the system for the user identified by {username}.

updateRemoteAIRCredentialUsername

public RemoteAIRCredential updateRemoteAIRCredentialUsername(@Context
                                                             javax.servlet.http.HttpServletRequest request,
                                                             String username,
                                                             RemoteAIRCredential remoteAIRCredential)

PUT /rest/RemoteAIRCredentials/{username}

Update the credentials for the remote AIR account identified by {username} on the system.

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

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

addRemoteAIRCredential_1_1

public javax.ws.rs.core.Response addRemoteAIRCredential_1_1(@Context
                                                            javax.servlet.http.HttpServletRequest request,
                                                            RemoteAIRCredential remoteAIRCredential)

POST /rest/RemoteAIRCredentials

Add credentials for a new remote AIR account on the system.

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

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

Since:

1.1

addRemoteAIRCredential

public RemoteAIRCredential addRemoteAIRCredential(@Context
                                                  javax.servlet.http.HttpServletRequest request,
                                                  RemoteAIRCredential remoteAIRCredential)

Deprecated. As of 1.1, @see #addRemoteAIRCredential_1_1(HttpServletRequest, RemoteAIRCredential)

POST /rest/RemoteAIRCredentials

Add credentials for a new remote AIR account on the system.

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

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