| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <main role="main"> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span><a id="line.1">package org.apache.archiva.redback.integration.mail;</a> |
| <span class="sourceLineNo">002</span><a id="line.2"></a> |
| <span class="sourceLineNo">003</span><a id="line.3">/*</a> |
| <span class="sourceLineNo">004</span><a id="line.4"> * Licensed to the Apache Software Foundation (ASF) under one</a> |
| <span class="sourceLineNo">005</span><a id="line.5"> * or more contributor license agreements. See the NOTICE file</a> |
| <span class="sourceLineNo">006</span><a id="line.6"> * distributed with this work for additional information</a> |
| <span class="sourceLineNo">007</span><a id="line.7"> * regarding copyright ownership. The ASF licenses this file</a> |
| <span class="sourceLineNo">008</span><a id="line.8"> * to you under the Apache License, Version 2.0 (the</a> |
| <span class="sourceLineNo">009</span><a id="line.9"> * "License"); you may not use this file except in compliance</a> |
| <span class="sourceLineNo">010</span><a id="line.10"> * with the License. You may obtain a copy of the License at</a> |
| <span class="sourceLineNo">011</span><a id="line.11"> *</a> |
| <span class="sourceLineNo">012</span><a id="line.12"> * http://www.apache.org/licenses/LICENSE-2.0</a> |
| <span class="sourceLineNo">013</span><a id="line.13"> *</a> |
| <span class="sourceLineNo">014</span><a id="line.14"> * Unless required by applicable law or agreed to in writing,</a> |
| <span class="sourceLineNo">015</span><a id="line.15"> * software distributed under the License is distributed on an</a> |
| <span class="sourceLineNo">016</span><a id="line.16"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a> |
| <span class="sourceLineNo">017</span><a id="line.17"> * KIND, either express or implied. See the License for the</a> |
| <span class="sourceLineNo">018</span><a id="line.18"> * specific language governing permissions and limitations</a> |
| <span class="sourceLineNo">019</span><a id="line.19"> * under the License.</a> |
| <span class="sourceLineNo">020</span><a id="line.20"> */</a> |
| <span class="sourceLineNo">021</span><a id="line.21"></a> |
| <span class="sourceLineNo">022</span><a id="line.22">import org.apache.archiva.redback.keys.AuthenticationKey;</a> |
| <span class="sourceLineNo">023</span><a id="line.23"></a> |
| <span class="sourceLineNo">024</span><a id="line.24">import java.util.Locale;</a> |
| <span class="sourceLineNo">025</span><a id="line.25">import java.util.Map;</a> |
| <span class="sourceLineNo">026</span><a id="line.26"></a> |
| <span class="sourceLineNo">027</span><a id="line.27">/**</a> |
| <span class="sourceLineNo">028</span><a id="line.28"> * Mail generator component.</a> |
| <span class="sourceLineNo">029</span><a id="line.29"> *</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> * @author <a href="mailto:brett@apache.org">Brett Porter</a></a> |
| <span class="sourceLineNo">031</span><a id="line.31"> *</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> */</a> |
| <span class="sourceLineNo">033</span><a id="line.33">public interface MailGenerator</a> |
| <span class="sourceLineNo">034</span><a id="line.34">{</a> |
| <span class="sourceLineNo">035</span><a id="line.35"></a> |
| <span class="sourceLineNo">036</span><a id="line.36"></a> |
| <span class="sourceLineNo">037</span><a id="line.37"> /**</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * Generates a mail string from a template. How the template will be located depends on the underlying</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> * implementation.</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> * It uses a default locale.</a> |
| <span class="sourceLineNo">041</span><a id="line.41"> *</a> |
| <span class="sourceLineNo">042</span><a id="line.42"> * @param templateName the template name without extension</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> * @param authkey the authentication key of the current user</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> * @param baseUrl the base url</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> * @return A string for the mail body generated from the template</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> */</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> String generateMail( String templateName, AuthenticationKey authkey, String baseUrl );</a> |
| <span class="sourceLineNo">048</span><a id="line.48"></a> |
| <span class="sourceLineNo">049</span><a id="line.49"> /**</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> * Generates a mail string from a template. The given locale is used for retrieving the template.</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> * How the template will be located depends on the underlying implementation.</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> *</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> * @param templateName the template name without extension</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> * @param locale the locale used to find the template file</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> * @param authenticationKey the authentication key of the current user</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> * @param baseUrl the base url</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> * @return a string for the mail body generated from the template</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> */</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> String generateMail( String templateName, Locale locale, AuthenticationKey authenticationKey, String baseUrl );</a> |
| <span class="sourceLineNo">060</span><a id="line.60"></a> |
| <span class="sourceLineNo">061</span><a id="line.61"> /**</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> * Generates a mail string from a template. The given locale is used for retrieving the template.</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> * How the template will be located depends on the underlying implementation.</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> * The templateData is used as model data that is interpolated from the template.</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> *</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> * @param templateName the template name without extension</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> * @param locale the locale used to find the template file</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> * @param authenticationKey the authentication key of the current user</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> * @param baseUrl the base url</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> * @param templateData additional data used for interpolation in the template</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> * @return a string for the mail body generated from the template</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> */</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> String generateMail( String templateName, Locale locale, AuthenticationKey authenticationKey, String baseUrl,</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> Map<String, Object> templateData );</a> |
| <span class="sourceLineNo">075</span><a id="line.75"></a> |
| <span class="sourceLineNo">076</span><a id="line.76">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
