com.quantum.dxi.rest.system

Class Tls

java.lang.Object

Base

com.quantum.dxi.rest.system.Tls

public class Tls
extends Base

The Tls resource represents the configuration of the TLS files used for HTTPS. The Tls interface includes services for viewing and modifying the encryption configuration for accessing the remote management console, including services to set a custom TLS certificate and revert to factory defaults. Because the APIs can change protocol (http/https) or encryption, a successful operation may have no return value or may indicate no return; for example, curl will return CURLE_GOT_NOTHING (52).

The schema that defines the TLS resource is defined below.

 
   <xs:element name="HttpsInstall">
       <xs:complexType>
           <xs:sequence>
               <xs:element name="Certificate" type="xs:string"/>
               <xs:element name="Key" type="xs:string"/>
               <xs:element name="PassPhrase" type="xs:string"/>
           </xs:sequence>
       </xs:complexType>
   <xs:element name="HttpsStatus">
       <xs:complexType>
           <xs:sequence>
               <xs:element name="Enabled" type="xs:boolean"/>
               <xs:element name="DefaultsInUse" type="xs:boolean"/>
           </xs:sequence>
       </xs:complexType>
   </xs:element>
 
 

Constructor Summary

Constructors

Constructor and Description
Tls()

Method Summary

Modifier and Type	Method and Description
void	disable(javax.servlet.http.HttpServletRequest request) POST /rest/Tls/disable
void	enable(javax.servlet.http.HttpServletRequest request) POST /rest/Tls/enable
com.quantum.dxi.dao.types.HttpsStatus	get(javax.servlet.http.HttpServletRequest request) GET /rest/Tls
HttpsInstall	install(javax.servlet.http.HttpServletRequest request, HttpsInstall httpsInstall, java.lang.String errorType) PUT /rest/Tls/install
void	revert(javax.servlet.http.HttpServletRequest request) POST /rest/Tls/revert

Methods inherited from class java.lang.Object

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

Constructor Detail

Tls

public Tls()

Method Detail

enable

public void enable(@Context
                   javax.servlet.http.HttpServletRequest request)

POST /rest/Tls/enable

Enable SSL/TLS for HTTPS on the system.

Since:

1.1

disable

public void disable(@Context
                    javax.servlet.http.HttpServletRequest request)

POST /rest/Tls/disable

Disable SSL/TLS for HTTPS on the system.

Since:

1.1

install

public HttpsInstall install(@Context
                            javax.servlet.http.HttpServletRequest request,
                            HttpsInstall httpsInstall,
                            java.lang.String errorType)

PUT /rest/Tls/install

Installs the server certificate, private key, and activation pass phrase. The certificate and key files must have been previously uploaded. See FileUpload.

Since:

1.1

revert

public void revert(@Context
                   javax.servlet.http.HttpServletRequest request)

POST /rest/Tls/revert

Reverts SSL/TLS for HTTPS on the system to factory defaults.

Since:

1.1

get

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

GET /rest/Tls

Get the configuration state of SSL/TLS for HTTPS on the system.

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

Since:

1.1