scriptella.driver.mail

Class MailConnection

java.lang.Object

scriptella.spi.AbstractConnection

scriptella.driver.mail.MailConnection

All Implemented Interfaces:

Connection

public class MailConnection
extends AbstractConnection

Represents a JavaMail connection.

For configuration details and examples see overview page.

TODO:

• Support for attachments
• Increase batch send performance by reusing tranport connection

Version:

1.0

Author:

Fyodor Kupolov

Nested Class Summary

Nested classes/interfaces inherited from class scriptella.spi.AbstractConnection

AbstractConnection.StatementCounter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SUBJECT Name of the subject connection property.
static java.lang.String	TYPE Name of the type connection property.
static java.lang.String	TYPE_HTML
static java.lang.String	TYPE_TEXT

Fields inherited from class scriptella.spi.AbstractConnection

counter

Constructor Summary

Constructors

Constructor and Description
MailConnection(ConnectionParameters parameters) Creates an email connection.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection and releases all related resources.
void	executeQuery(Resource queryContent, ParametersCallback parametersCallback, QueryCallback queryCallback) Executes a query specified by its content.
void	executeScript(Resource scriptContent, ParametersCallback parametersCallback) Executes a script specified by its content.
protected javax.mail.internet.MimeMessage	format(java.io.Reader reader, PropertiesSubstitutor ps)
protected void	send(javax.mail.internet.MimeMessage message) Template method to decouple transport dependency, overriden in test classes.

Methods inherited from class scriptella.spi.AbstractConnection

commit, getDialectIdentifier, getExecutedStatementsCount, isReadonly, rollback, setDialectIdentifier, toString

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final java.lang.String TYPE

Name of the type connection property. Specifies type of E-Mail message content: TYPE_TEXT, TYPE_HTML.

See Also:

Constant Field Values

SUBJECT

public static final java.lang.String SUBJECT

Name of the subject connection property. Specifies e-mail subject.

See Also:

Constant Field Values

TYPE_TEXT

public static final java.lang.String TYPE_TEXT

See Also:

Constant Field Values

TYPE_HTML

public static final java.lang.String TYPE_HTML

See Also:

Constant Field Values

Constructor Detail

MailConnection

public MailConnection(ConnectionParameters parameters)

Creates an email connection.

Parameters:

parameters - connection parameters.

Method Detail

executeScript

public void executeScript(Resource scriptContent,
                          ParametersCallback parametersCallback)
                   throws ProviderException

Description copied from interface: Connection

Executes a script specified by its content.

scriptContent may be used as a key for caching purposes, i.e. provider may precompile scripts and use compiled versions for subsequent executions. Please note that only inline text resources can be safely cached.

Parameters:

scriptContent - script content. Cannot be null.

parametersCallback - callback to get parameter values. Cannot be null.

Throws:

ProviderException - if script execution failed.

format

protected javax.mail.internet.MimeMessage format(java.io.Reader reader,
                                                 PropertiesSubstitutor ps)
                                          throws javax.mail.MessagingException,
                                                 java.io.IOException

Throws:

javax.mail.MessagingException

java.io.IOException

send

protected void send(javax.mail.internet.MimeMessage message)
             throws javax.mail.MessagingException

Template method to decouple transport dependency, overriden in test classes.

Parameters:

message - message to send.

Throws:

javax.mail.MessagingException

executeQuery

public void executeQuery(Resource queryContent,
                         ParametersCallback parametersCallback,
                         QueryCallback queryCallback)
                  throws ProviderException

Description copied from interface: Connection

Executes a query specified by its content.

Parameters:

queryContent - query content. Cannot be null.

parametersCallback - callback to get parameter values. Cannot be null.

queryCallback - callback to call for each result set element produced by this query. Cannot be null.

Throws:

ProviderException - if query execution failed.

See Also:

Connection.executeScript(scriptella.spi.Resource,scriptella.spi.ParametersCallback)

close

public void close()
           throws ProviderException

Description copied from interface: Connection

Closes the connection and releases all related resources.

Throws:

ProviderException - if a critical failure occured.