com.quantum.dxi.rest.Security

Class TLSFiles

java.lang.Object

Base

com.quantum.dxi.rest.Security.TLSFiles

public class TLSFiles
extends Base

The TLSFiles resource represents the configuration of the TLS files used for secure data transfer, including OST, Accent, and replication data transfer, on the system. The TLSFiles interface includes services for getting details about TLS file configuration, uploading new TLS files, and reverting to factory default TLS files.

The schema that defines the TLSFiles resource is defined below.

 
    <xs:element name="TLSFile">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="TLSFileName">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:enumeration value="cert.pem"/>
                            <xs:enumeration value="key.pem"/>
                            <xs:enumeration value="cacert.pem"/>
                            <xs:enumeration value="crl.pem"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="TLSStatus">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:enumeration value="FACTORY"/>
                            <xs:enumeration value="CUSTOMER"/>
                            <xs:enumeration value="MISSING"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="DateInstalled" type="xs:long"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
    <xs:element name="TLSFiles">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="TotalCount" type="xs:int" minOccurs="0"/>
                <xs:element ref="TLSFile" minOccurs="0" maxOccurs="4"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
    <xs:simpleType name="TLSFileColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="TLSFileName"/>
            <xs:enumeration value="TLSStatus"/>
            <xs:enumeration value="DateInstalled"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:element name="TlsInstallFiles">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="CertFileName" type="xs:string" minOccurs="0"/>
                <xs:element name="KeyFileName" type="xs:string" minOccurs="0"/>
                <xs:element name="CaCertFileName" type="xs:string" minOccurs="0"/>
                <xs:element name="CrlFileName" type="xs:string" minOccurs="0"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
 
 

Constructor Summary

Constructors

Constructor and Description
TLSFiles()

Method Summary

Modifier and Type	Method and Description
TLSFile	getTlsFile(javax.servlet.http.HttpServletRequest request, String tlsFileName, String errorType) GET /rest/TLSFiles/{tlsFileName}
com.quantum.dxi.dao.types.TLSFiles	getTlsFiles(javax.servlet.http.HttpServletRequest request, String errorType) GET /rest/TLSFiles
javax.ws.rs.core.Response	installTlsFiles(javax.servlet.http.HttpServletRequest request, com.quantum.dxi.dao.types.TlsInstallFiles tlsFiles, boolean delayReboot, String errorType) POST /rest/TLSFiles/installTLSFiles
javax.ws.rs.core.Response	installTlsFiles(javax.servlet.http.HttpServletRequest request, String actionString, String cert, String key, String cacert, String crl, boolean delayReboot, String errorType) Deprecated. As of 1.1 ?action=installTLSFiles @see #installTlsFiles(HttpServletRequest, com.quantum.dxi.dao.types.TLSFiles, boolean, String) ?action=revertToFactoryDefaultTLSFiles @see #revertToFactoryDefaults(HttpServletRequest, boolean, String)
javax.ws.rs.core.Response	revertToFactoryDefaults(javax.servlet.http.HttpServletRequest request, boolean delayReboot, String errorType) POST /rest/TLSFiles/revertToFactoryTLSFiles

Methods inherited from class java.lang.Object

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

Constructor Detail

TLSFiles

public TLSFiles()

Method Detail

getTlsFiles

public com.quantum.dxi.dao.types.TLSFiles getTlsFiles(@Context
                                                      javax.servlet.http.HttpServletRequest request,
                                                      String errorType)

GET /rest/TLSFiles

Get the TLS file configuration information on the system.

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

getTlsFile

public TLSFile getTlsFile(@Context
                          javax.servlet.http.HttpServletRequest request,
                          String tlsFileName,
                          String errorType)

GET /rest/TLSFiles/{tlsFileName}

Get the TLS file configuration information for the specified TLS file on the system.

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

installTlsFiles

public javax.ws.rs.core.Response installTlsFiles(@Context
                                                 javax.servlet.http.HttpServletRequest request,
                                                 com.quantum.dxi.dao.types.TlsInstallFiles tlsFiles,
                                                 boolean delayReboot,
                                                 String errorType)

POST /rest/TLSFiles/installTLSFiles

Install the files named in the request. The files must have been previously uploaded via POST /rest/Upload.

Supported query parameters are:

• ?delayReboot=true Delay the reboot until a more convenient time. In order for changes to take effect the system must be rebooted.

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

Response Entity type: <xs:element name="NumericScalarType"> representing the job id

Since:

1.1

revertToFactoryDefaults

public javax.ws.rs.core.Response revertToFactoryDefaults(@Context
                                                         javax.servlet.http.HttpServletRequest request,
                                                         boolean delayReboot,
                                                         String errorType)

POST /rest/TLSFiles/revertToFactoryTLSFiles

Revert the TLS files to the factory default files.

Supported query parameters are:

• ?delayReboot=true Delay the reboot until a more convenient time. In order for changes to take effect the system must be rebooted.

Response Entity type: <xs:element name="NumericScalarType"> representing the job id

Since:

1.1

installTlsFiles

public javax.ws.rs.core.Response installTlsFiles(@Context
                                                 javax.servlet.http.HttpServletRequest request,
                                                 String actionString,
                                                 String cert,
                                                 String key,
                                                 String cacert,
                                                 String crl,
                                                 boolean delayReboot,
                                                 String errorType)

Deprecated. As of 1.1
?action=installTLSFiles @see #installTlsFiles(HttpServletRequest, com.quantum.dxi.dao.types.TLSFiles, boolean, String)
?action=revertToFactoryDefaultTLSFiles @see #revertToFactoryDefaults(HttpServletRequest, boolean, String)

POST /rest/TLSFiles

Perform the requested action on the TLS file configuration. The action query parameter is required.

Supported actions are:

• ?action=installTLSFiles&cert=<certFileName>&cacert=<caCertFileName>&key=<keyFileName>&crl=<crlFileName>&delayReboot=true start a background job to install specified TLS files. At least one of the filename query parameters must be included with the action parameter. In order for changes to take effect the system must be rebooted.
• ?action=revertToFactoryDefaultTLSFiles&delayReboot=true Revert the TLS files to the factory default files. In order for changes to take effect the system must be rebooted.

Response Entity type: <xs:element name="NumericScalarType"> representing the job id