org.pentaho.platform.web.http.api.resources

Class EmailResource

java.lang.Object

org.pentaho.platform.web.http.api.resources.AbstractJaxRSResource

org.pentaho.platform.web.http.api.resources.EmailResource

public class EmailResource
extends AbstractJaxRSResource

Configures and manage the Email configuration in the platform

Author:

rmansoor

Field Summary

Fields inherited from class org.pentaho.platform.web.http.api.resources.AbstractJaxRSResource

acceptableMediaTypes, httpServletRequest, httpServletResponse, TEXT_HTML

Constructor Summary

Constructors

Constructor and Description
EmailResource() Constructs an instance of this class using the default email service
EmailResource(org.pentaho.platform.api.email.IEmailService emailService) Constructs an instance of this class using the default email service

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	deleteEmailConfig() Delete the stored email configuration from the platform.
org.pentaho.platform.api.email.IEmailConfiguration	getEmailConfig() Retrieves the email configuration
javax.ws.rs.core.Response	isValid() Checks whether the current email configuration is valid
javax.ws.rs.core.Response	sendEmailTest(EmailConfiguration emailConfiguration) Process the current email configuration
javax.ws.rs.core.Response	setEmailConfig(EmailConfiguration emailConfiguration) Stores the email configuration in the platform

Methods inherited from class org.pentaho.platform.web.http.api.resources.AbstractJaxRSResource

setHttpHeaders

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailResource

public EmailResource()
              throws IllegalArgumentException

Constructs an instance of this class using the default email service

Throws:

IllegalArgumentException - Indicates that the default location for the email configuration file is invalid

EmailResource

public EmailResource(org.pentaho.platform.api.email.IEmailService emailService)
              throws IllegalArgumentException

Constructs an instance of this class using the default email service

Throws:

IllegalArgumentException - Indicates that the default location for the email configuration file is invalid

Method Detail

deleteEmailConfig

public javax.ws.rs.core.Response deleteEmailConfig()

Delete the stored email configuration from the platform.

Parameters:

emailConfiguration - EmailConfiguration

Returns:

setEmailConfig

public javax.ws.rs.core.Response setEmailConfig(EmailConfiguration emailConfiguration)

Stores the email configuration in the platform

Parameters:

emailConfiguration - EmailConfiguration

Returns:

getEmailConfig

public org.pentaho.platform.api.email.IEmailConfiguration getEmailConfig()

Retrieves the email configuration

Returns:

emailConfiguration EmailConfiguration

sendEmailTest

public javax.ws.rs.core.Response sendEmailTest(EmailConfiguration emailConfiguration)
                                        throws Exception

Process the current email configuration

Parameters:

emailConfiguration - EmailConfiguration

Returns:

Throws:

Exception

isValid

public javax.ws.rs.core.Response isValid()

Checks whether the current email configuration is valid

Returns:

("true" or "false")