com.quantum.dxi.rest.dxi

Class Licenses

java.lang.Object

Base

com.quantum.dxi.rest.dxi.Licenses

public class Licenses
extends Base

The Licenses resource represents licenses on the system. The Licences interface includes services for adding a license and getting information for all licenses or a specific license.

The schema that defines the Licenses resource is defined below.

 
    <xs:element name="License">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="Id" type="xs:int"/>
                <xs:element name="Name" type="xs:string"/>
                <xs:element name="Installed" type="xs:boolean"/>
                <xs:element name="DateInstalled" type="xs:long" minOccurs="0"/>
                <xs:element name="ShortDescription" type="xs:string"/>
                <xs:element name="DetailedDescription" type="xs:string"/>
                <xs:element name="Dependencies" type="xs:string" minOccurs="0"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
    <xs:element name="Licenses">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="TotalCount" type="xs:int" minOccurs="0"/>
                <xs:element ref="License" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
    <xs:simpleType name="LicenseColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="Id"/>
            <xs:enumeration value="Name"/>
            <xs:enumeration value="Installed"/>
            <xs:enumeration value="DateInstalled"/>
            <xs:enumeration value="ShortDescription"/>
            <xs:enumeration value="DetailedDescription"/>
            <xs:enumeration value="Dependencies"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Field Summary

Fields

Modifier and Type	Field and Description
static int	CAPACITY
static int	DEDUP
static int	DISK_ENCRYPTION
static int	INTEGRATED_PTT
static int	NAS
static int	OST
static int	PTT
static int	REP
static int	VISION
static int	VISION_FOR_SERVICE
static int	VTL

Constructor Summary

Constructors

Constructor and Description
Licenses()

Method Summary

Modifier and Type	Method and Description
StringScalarType	addLicense(javax.servlet.http.HttpServletRequest request, StringScalarType licenseKey, java.lang.String errorType) PUT /rest/Licenses
License	getLicense(javax.servlet.http.HttpServletRequest request, int licenseId, java.lang.String errorType) GET /rest/Licenses/{id}
java.lang.Object	getLicenses(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/Licenses
NumericScalarType	getLicensesCount(javax.servlet.http.HttpServletRequest request, int start, int limit, java.lang.String filterString, java.lang.String errorType) GET /rest/Licenses/getRowCount

Methods inherited from class java.lang.Object

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

Field Detail

VTL

public static int VTL

NAS

public static int NAS

INTEGRATED_PTT

public static int INTEGRATED_PTT

PTT

public static int PTT

DEDUP

public static int DEDUP

REP

public static int REP

CAPACITY

public static int CAPACITY

OST

public static int OST

VISION

public static int VISION

VISION_FOR_SERVICE

public static int VISION_FOR_SERVICE

DISK_ENCRYPTION

public static int DISK_ENCRYPTION

Constructor Detail

Licenses

public Licenses()

Method Detail

getLicensesCount

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

GET /rest/Licenses/getRowCount

Get the number of licenses on the system.

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

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

Since:

1.1

getLicenses

public java.lang.Object getLicenses(@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,
                                    java.lang.String errorType)

GET /rest/Licenses

Get the list of licenses on the system.

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

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

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

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

getLicense

public License getLicense(@Context
                          javax.servlet.http.HttpServletRequest request,
                          int licenseId,
                          java.lang.String errorType)

GET /rest/Licenses/{id}

Get the license from the system identified by {id}.

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

addLicense

public StringScalarType addLicense(@Context
                                   javax.servlet.http.HttpServletRequest request,
                                   StringScalarType licenseKey,
                                   java.lang.String errorType)

PUT /rest/Licenses

Installs a license on the system.

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

Response Entity type: <xs:element name="StringScalarType"> Since 1.2