com.ozacc.mail.VelocityMailBuilder Maven / Gradle / Ivy

package com.ozacc.mail;

import java.io.File;

import org.apache.velocity.VelocityContext;

/**
 * Velocityと連携して動的にメールデータを生成し、そのデータからMailインスタンスを生成するインターフェース。
 * 
 * @see com.ozacc.mail.impl.XMLVelocityMailBuilderImpl
 * @see com.ozacc.mail.impl.JDomXMLMailBuilder
 * 
 * @since 1.0
 * @author Tomohiro Otsuka
 * @version $Id: VelocityMailBuilder.java,v 1.4.2.3 2005/01/21 16:51:20 otsuka Exp $
 */
public interface VelocityMailBuilder extends MailBuilder {

	/**
	 * 指定されたクラスパス上のファイルを読み込んでMailインスタンスを生成します。
	 * 指定されたVelocityContextを使って、XMLファイルの内容を動的に生成できます。
	 * 
	 * @param classPath メール内容を記述したファイルのパス
	 * @param context VelocityContext
	 * @return 生成されたMailインスタンス
	 * @throws MailBuildException Mailインスタンスの生成に失敗した場合
	 */
	Mail buildMail(String classPath, VelocityContext context) throws MailBuildException;

	/**
	 * 指定されたファイルを読み込んでMailインスタンスを生成します。
	 * 指定されたVelocityContextを使って、XMLファイルの内容を動的に生成できます。
	 * 
	 * @param file メール内容を記述したファイル
	 * @param context VelocityContext
	 * @return 生成されたMailインスタンス
	 * @throws MailBuildException Mailインスタンスの生成に失敗した場合
	 */
	Mail buildMail(File file, VelocityContext context) throws MailBuildException;

	/**
	 * メールデータキャッシュをクリアします。
	 * 
	 * @since 1.1.2
	 */
	void clearCache();

	/**
	 * VelocityContextとマージする前のメールデータをキャッシュするかどうかを設定します。
	 * デフォルトはキャッシュしない設定です。
	 * 
	 * キャッシュのキーは、buildMail()メソッド引数のメールデータファイルのクラスパス或いはファイルパスです。
	 * キャッシュに有効期限はありません。
	 * また、メールデータファイルの内容が途中で更新されても、キャッシュされているメールデータは更新されませんので注意してください。
	 * 
	 * falseを指定してこのメソッドを呼ぶとメールデータキャッシュはクリアされます。
	 * 
	 * @since 1.1.2
	 * @param cacheEnabled メールデータをキャッシュする場合は true
	 */
	void setCacheEnabled(boolean cacheEnabled);

	/**
	 * VelocityContextとマージする前のメールデータをキャッシュする設定かどうか判定します。
	 * 
	 * @since 1.1.2
	 * @return メールデータをキャッシュする設定の場合は true
	 */
	boolean isCacheEnabled();

}