com.quantum.dxi.rest.alert

Class EmailServer

java.lang.Object

Base

com.quantum.dxi.rest.alert.EmailServer

public class EmailServer
extends Base

The EmailServer resource represents the configuration of the EmailServer feature on the system. The EmailServer interface includes services for getting and updating the EmailServer configuration. If a secure email server is desired, see the SecureEmailServer resource.

The schema defining the EmailServer resource is described below.

 
    <xs:element name="EmailServer">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="EmailServerHostName" type="xs:string"/>
                <xs:element name="FromEmailAddress" type="xs:string"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
 
 

Constructor Summary

Constructors

Constructor and Description
EmailServer()

Method Summary

Modifier and Type	Method and Description
void	deleteEmailServer(javax.servlet.http.HttpServletRequest request, String errorType) DELETE /rest/EmailServer
com.quantum.dxi.dao.types.EmailServer	getEmailServer(javax.servlet.http.HttpServletRequest request, String errorType) GET /rest/EmailServer
BooleanScalarType	getNotSetAlert(javax.servlet.http.HttpServletRequest request) GET /rest/EmailServer/notSetAlert
BooleanScalarType	getSendToVendor(javax.servlet.http.HttpServletRequest request) GET /rest/EmailServer/sendToVendor
BooleanScalarType	setNotSetAlert(javax.servlet.http.HttpServletRequest request, BooleanScalarType enable) PUT /rest/EmailServer/notSetAlert
BooleanScalarType	setSendToVendor(javax.servlet.http.HttpServletRequest request, BooleanScalarType enable) PUT /rest/EmailServer/sendToVendor
com.quantum.dxi.dao.types.EmailServer	updateEmailServer(javax.servlet.http.HttpServletRequest request, com.quantum.dxi.dao.types.EmailServer server, String errorType) PUT /rest/EmailServer

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailServer

public EmailServer()

Method Detail

getEmailServer

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

GET /rest/EmailServer

Get the configuration of the EmailServer feature on the system.

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

Since:

1.1

updateEmailServer

public com.quantum.dxi.dao.types.EmailServer updateEmailServer(@Context
                                                               javax.servlet.http.HttpServletRequest request,
                                                               com.quantum.dxi.dao.types.EmailServer server,
                                                               String errorType)

PUT /rest/EmailServer

Update the configuration of the EmailServer feature on the system.

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

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

Since:

1.1

deleteEmailServer

public void deleteEmailServer(@Context
                              javax.servlet.http.HttpServletRequest request,
                              String errorType)

DELETE /rest/EmailServer

Delete the configuration of the EmailServer feature on the system.

Since:

1.1

setNotSetAlert

public BooleanScalarType setNotSetAlert(@Context
                                        javax.servlet.http.HttpServletRequest request,
                                        BooleanScalarType enable)

PUT /rest/EmailServer/notSetAlert

Enable or disable the creation of administrative alerts when the eamil server is not configured. server is not set.

Since:

1.2.4

getNotSetAlert

public BooleanScalarType getNotSetAlert(@Context
                                        javax.servlet.http.HttpServletRequest request)

GET /rest/EmailServer/notSetAlert

Return the state of the condition that creates administrative alerts when the email server is not configured.

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

Since:

1.2.4

setSendToVendor

public BooleanScalarType setSendToVendor(@Context
                                         javax.servlet.http.HttpServletRequest request,
                                         BooleanScalarType enable)

PUT /rest/EmailServer/sendToVendor

Enables or disables the automatic sending of status and configuration reports to the vendor.

Since:

1.2.4

getSendToVendor

public BooleanScalarType getSendToVendor(@Context
                                         javax.servlet.http.HttpServletRequest request)

GET /rest/EmailServer/sendToVendor

Return the state of the condition that automatically sends status and configuration reports to the vendor.

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

Since:

1.2.4