com.quantum.dxi.rest.system

Class DateTime

java.lang.Object

Base

com.quantum.dxi.rest.system.DateTime

public class DateTime
extends Base

The DateTime resource represents the Date and Time settings on the system. The DateTime interface includes services for getting the current date and time settings and updating the date and time settings on the system.

The schema that defines the DateTime resource is defined below.

 
 <xs:element name="DateTime">
     <xs:complexType>
         <xs:sequence>
             <xs:element name="Date" type="xs:long" minOccurs="0">
                 <xs:annotation>
                     <xs:documentation>milliseconds since unix epoc. Only if NTP is false</xs:documentation>
                 </xs:annotation>
             </xs:element>
             <xs:element name="NTP" type="xs:boolean"/>
             <xs:element name="TimeZone" type="xs:string"/>
             <xs:element name="MilitaryTime" type="xs:boolean"/>
             <xs:element name="NtpServerHostName" type="xs:string" minOccurs="0">
                 <xs:annotation>
                     <xs:documentation>Only if NTP is true</xs:documentation>
                 </xs:annotation>
             </xs:element>
         </xs:sequence>
     </xs:complexType>
 </xs:element>
 <xs:element name="DateTimeScalarName">
     <xs:simpleType>
         <xs:restriction base="xs:string">
             <xs:enumeration value="DatetimeDate"/>
             <xs:enumeration value="DatetimeNTP"/>
             <xs:enumeration value="DatetimeTimeZone"/>
             <xs:enumeration value="DatetimeMilitaryTime"/>
             <xs:enumeration value="DatetimeNtpServerHostName"/>
             <xs:enumeration value="DatetimeTestStatus"/>
             <xs:enumeration value="DatetimeTestDetails"/>
         </xs:restriction>
     </xs:simpleType>
 </xs:element>
 <xs:element name="NtpPool">
     <xs:complexType>
         <xs:sequence>
             <xs:element name="PoolName" type="xs:string"/>
         </xs:sequence>
     </xs:complexType>
 </xs:element>
 <xs:element name="NtpPools">
     <xs:complexType>
         <xs:sequence>
             <xs:element name="TotalCount" type="xs:int" minOccurs="0">
                 <xs:annotation>
                     <xs:documentation>Total number of NTP pools</xs:documentation>
                 </xs:annotation>
             </xs:element>
             <xs:element ref="NtpPool" minOccurs="0" maxOccurs="unbounded"/>
         </xs:sequence>
     </xs:complexType>
 </xs:element>
 <xs:element name="DateTimeNtpTest">
     <xs:complexType>
         <xs:sequence>
             <xs:element name="Status" type="xs:string"/>
             <xs:element name="Details" type="xs:string" minOccurs="0"/>
         </xs:sequence>
      </xs:complexType>
   </xs:element>
 
 

Constructor Summary

Constructors

Constructor and Description
DateTime()

Method Summary

Modifier and Type	Method and Description
com.quantum.dxi.dao.types.DateTime	getDateTime(javax.servlet.http.HttpServletRequest request) GET /rest/DateTime
ScalarType	getDateTimeScalar(javax.servlet.http.HttpServletRequest request, String name) Deprecated. As of 1.1
NtpPools	getNtpPools(javax.servlet.http.HttpServletRequest request) GET /rest/NtpPools
DateTimeNtpTest	testNtp(javax.servlet.http.HttpServletRequest request) POST /rest/DateTime/TestNtp
DateTimeNtpTest	testNtp(javax.servlet.http.HttpServletRequest request, String poolOrServerName) POST /rest/DateTime/TestNtp/{poolOrServerName}
com.quantum.dxi.dao.types.DateTime	updateDateTime(javax.servlet.http.HttpServletRequest request, com.quantum.dxi.dao.types.DateTime dateTime, String errorType) PUT /rest/DateTime

Methods inherited from class java.lang.Object

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

Constructor Detail

DateTime

public DateTime()

Method Detail

getDateTime

public com.quantum.dxi.dao.types.DateTime getDateTime(@Context
                                                      javax.servlet.http.HttpServletRequest request)

GET /rest/DateTime

Get the current date and time configuration from the system.

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

getDateTimeScalar

public ScalarType getDateTimeScalar(@Context
                                    javax.servlet.http.HttpServletRequest request,
                                    String name)

Deprecated. As of 1.1

GET /rest/DateTime/{propertyName}

Get the value of the named DateTime property from the system. Valid property names are defined in <xs:element name="DateTimeScalarName">

Example: GET /rest/DateTime/DateTimeMilitaryTime

Response Entity type: subtype of <xs:element name="ScalarType">, appropriate for the property type.

testNtp

public DateTimeNtpTest testNtp(@Context
                               javax.servlet.http.HttpServletRequest request)

POST /rest/DateTime/TestNtp

Tests the saved NTP server or pool

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

Since:

1.1

testNtp

public DateTimeNtpTest testNtp(@Context
                               javax.servlet.http.HttpServletRequest request,
                               String poolOrServerName)

POST /rest/DateTime/TestNtp/{poolOrServerName}

Tests the specified NTP pool or server

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

Since:

1.1

updateDateTime

public com.quantum.dxi.dao.types.DateTime updateDateTime(@Context
                                                         javax.servlet.http.HttpServletRequest request,
                                                         com.quantum.dxi.dao.types.DateTime dateTime,
                                                         String errorType)

PUT /rest/DateTime

Update the date and time configuration on the system.

Important: The system will reboot automatically whenever the DateTime is updated.

Request Entity type: <xs:element name="DateTime">
Response Entity type: <xs:element name="DateTime">

getNtpPools

public NtpPools getNtpPools(@Context
                            javax.servlet.http.HttpServletRequest request)
                     throws DaoException

GET /rest/NtpPools

Gets the list of common NTP server or pools

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

Throws:

DaoException

Since:

1.1