You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2024/06/15 15:06:54 UTC
svn commit: r69773 [14/20] - in /dev/commons/email/2.0.0-M1-RC1: ./ binaries/ site/ site/apidocs/ site/apidocs/legal/ site/apidocs/org/ site/apidocs/org/apache/ site/apidocs/org/apache/commons/ site/apidocs/org/apache/commons/mail2/ site/apidocs/org/ap...
Added: dev/commons/email/2.0.0-M1-RC1/site/apidocs/src-html/org/apache/commons/mail2/jakarta/DataSourceResolver.html
==============================================================================
--- dev/commons/email/2.0.0-M1-RC1/site/apidocs/src-html/org/apache/commons/mail2/jakarta/DataSourceResolver.html (added)
+++ dev/commons/email/2.0.0-M1-RC1/site/apidocs/src-html/org/apache/commons/mail2/jakarta/DataSourceResolver.html Sat Jun 15 15:06:54 2024
@@ -0,0 +1,126 @@
+<!DOCTYPE HTML>
+<html lang="en">
+<head>
+<!-- Generated by javadoc (17) -->
+<title>Source code</title>
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta name="description" content="source: package: org.apache.commons.mail2.jakarta, interface: DataSourceResolver">
+<meta name="generator" content="javadoc/SourceToHTMLConverter">
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+</head>
+<body class="source-page">
+<main role="main">
+<div class="source-container">
+<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
+<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one or more</span>
+<span class="source-line-no">003</span><span id="line-3"> * contributor license agreements. See the NOTICE file distributed with</span>
+<span class="source-line-no">004</span><span id="line-4"> * this work for additional information regarding copyright ownership.</span>
+<span class="source-line-no">005</span><span id="line-5"> * The ASF licenses this file to You under the Apache License, Version 2.0</span>
+<span class="source-line-no">006</span><span id="line-6"> * (the "License"); you may not use this file except in compliance with</span>
+<span class="source-line-no">007</span><span id="line-7"> * the License. You may obtain a copy of the License at</span>
+<span class="source-line-no">008</span><span id="line-8"> *</span>
+<span class="source-line-no">009</span><span id="line-9"> * http://www.apache.org/licenses/LICENSE-2.0</span>
+<span class="source-line-no">010</span><span id="line-10"> *</span>
+<span class="source-line-no">011</span><span id="line-11"> * Unless required by applicable law or agreed to in writing, software</span>
+<span class="source-line-no">012</span><span id="line-12"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
+<span class="source-line-no">013</span><span id="line-13"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
+<span class="source-line-no">014</span><span id="line-14"> * See the License for the specific language governing permissions and</span>
+<span class="source-line-no">015</span><span id="line-15"> * limitations under the License.</span>
+<span class="source-line-no">016</span><span id="line-16"> */</span>
+<span class="source-line-no">017</span><span id="line-17">package org.apache.commons.mail2.jakarta;</span>
+<span class="source-line-no">018</span><span id="line-18"></span>
+<span class="source-line-no">019</span><span id="line-19">import java.io.IOException;</span>
+<span class="source-line-no">020</span><span id="line-20"></span>
+<span class="source-line-no">021</span><span id="line-21">import jakarta.activation.DataSource;</span>
+<span class="source-line-no">022</span><span id="line-22"></span>
+<span class="source-line-no">023</span><span id="line-23">/**</span>
+<span class="source-line-no">024</span><span id="line-24"> * Creates a {@code DataSource} based on an URL.</span>
+<span class="source-line-no">025</span><span id="line-25"> *</span>
+<span class="source-line-no">026</span><span id="line-26"> * @since 1.3</span>
+<span class="source-line-no">027</span><span id="line-27"> */</span>
+<span class="source-line-no">028</span><span id="line-28">public interface DataSourceResolver {</span>
+<span class="source-line-no">029</span><span id="line-29"></span>
+<span class="source-line-no">030</span><span id="line-30"> /**</span>
+<span class="source-line-no">031</span><span id="line-31"> * Resolves the given resource location to a {@code DataSource}.</span>
+<span class="source-line-no">032</span><span id="line-32"> *</span>
+<span class="source-line-no">033</span><span id="line-33"> * @param resourceLocation the location of the resource</span>
+<span class="source-line-no">034</span><span id="line-34"> * @return the {@code DataSource}</span>
+<span class="source-line-no">035</span><span id="line-35"> * @throws IOException the resource was not found</span>
+<span class="source-line-no">036</span><span id="line-36"> */</span>
+<span class="source-line-no">037</span><span id="line-37"> DataSource resolve(String resourceLocation) throws IOException;</span>
+<span class="source-line-no">038</span><span id="line-38"></span>
+<span class="source-line-no">039</span><span id="line-39"> /**</span>
+<span class="source-line-no">040</span><span id="line-40"> * Resolves the given resource location to a {@code DataSource}.</span>
+<span class="source-line-no">041</span><span id="line-41"> *</span>
+<span class="source-line-no">042</span><span id="line-42"> * @param resourceLocation the location of the resource</span>
+<span class="source-line-no">043</span><span id="line-43"> * @param isLenient shall we ignore resources not found or complain with an exception?</span>
+<span class="source-line-no">044</span><span id="line-44"> * @return the data source containing the resource or null if the resource was not found in lenient mode</span>
+<span class="source-line-no">045</span><span id="line-45"> * @throws IOException resolving the resource failed</span>
+<span class="source-line-no">046</span><span id="line-46"> */</span>
+<span class="source-line-no">047</span><span id="line-47"> DataSource resolve(String resourceLocation, boolean isLenient) throws IOException;</span>
+<span class="source-line-no">048</span><span id="line-48">}</span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</main>
+</body>
+</html>
Added: dev/commons/email/2.0.0-M1-RC1/site/apidocs/src-html/org/apache/commons/mail2/jakarta/DefaultAuthenticator.html
==============================================================================
--- dev/commons/email/2.0.0-M1-RC1/site/apidocs/src-html/org/apache/commons/mail2/jakarta/DefaultAuthenticator.html (added)
+++ dev/commons/email/2.0.0-M1-RC1/site/apidocs/src-html/org/apache/commons/mail2/jakarta/DefaultAuthenticator.html Sat Jun 15 15:06:54 2024
@@ -0,0 +1,131 @@
+<!DOCTYPE HTML>
+<html lang="en">
+<head>
+<!-- Generated by javadoc (17) -->
+<title>Source code</title>
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta name="description" content="source: package: org.apache.commons.mail2.jakarta, class: DefaultAuthenticator">
+<meta name="generator" content="javadoc/SourceToHTMLConverter">
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+</head>
+<body class="source-page">
+<main role="main">
+<div class="source-container">
+<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
+<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one or more</span>
+<span class="source-line-no">003</span><span id="line-3"> * contributor license agreements. See the NOTICE file distributed with</span>
+<span class="source-line-no">004</span><span id="line-4"> * this work for additional information regarding copyright ownership.</span>
+<span class="source-line-no">005</span><span id="line-5"> * The ASF licenses this file to You under the Apache License, Version 2.0</span>
+<span class="source-line-no">006</span><span id="line-6"> * (the "License"); you may not use this file except in compliance with</span>
+<span class="source-line-no">007</span><span id="line-7"> * the License. You may obtain a copy of the License at</span>
+<span class="source-line-no">008</span><span id="line-8"> *</span>
+<span class="source-line-no">009</span><span id="line-9"> * http://www.apache.org/licenses/LICENSE-2.0</span>
+<span class="source-line-no">010</span><span id="line-10"> *</span>
+<span class="source-line-no">011</span><span id="line-11"> * Unless required by applicable law or agreed to in writing, software</span>
+<span class="source-line-no">012</span><span id="line-12"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
+<span class="source-line-no">013</span><span id="line-13"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
+<span class="source-line-no">014</span><span id="line-14"> * See the License for the specific language governing permissions and</span>
+<span class="source-line-no">015</span><span id="line-15"> * limitations under the License.</span>
+<span class="source-line-no">016</span><span id="line-16"> */</span>
+<span class="source-line-no">017</span><span id="line-17">package org.apache.commons.mail2.jakarta;</span>
+<span class="source-line-no">018</span><span id="line-18"></span>
+<span class="source-line-no">019</span><span id="line-19">import jakarta.mail.Authenticator;</span>
+<span class="source-line-no">020</span><span id="line-20">import jakarta.mail.PasswordAuthentication;</span>
+<span class="source-line-no">021</span><span id="line-21"></span>
+<span class="source-line-no">022</span><span id="line-22">/**</span>
+<span class="source-line-no">023</span><span id="line-23"> * This is a very simple authentication object that can be used for any transport needing basic userName and password type authentication.</span>
+<span class="source-line-no">024</span><span id="line-24"> *</span>
+<span class="source-line-no">025</span><span id="line-25"> * @since 1.0</span>
+<span class="source-line-no">026</span><span id="line-26"> */</span>
+<span class="source-line-no">027</span><span id="line-27">public class DefaultAuthenticator extends Authenticator {</span>
+<span class="source-line-no">028</span><span id="line-28"></span>
+<span class="source-line-no">029</span><span id="line-29"> /** Stores the login information for authentication. */</span>
+<span class="source-line-no">030</span><span id="line-30"> private final PasswordAuthentication authentication;</span>
+<span class="source-line-no">031</span><span id="line-31"></span>
+<span class="source-line-no">032</span><span id="line-32"> /**</span>
+<span class="source-line-no">033</span><span id="line-33"> * Default constructor.</span>
+<span class="source-line-no">034</span><span id="line-34"> *</span>
+<span class="source-line-no">035</span><span id="line-35"> * @param userName user name to use when authentication is requested</span>
+<span class="source-line-no">036</span><span id="line-36"> * @param password password to use when authentication is requested</span>
+<span class="source-line-no">037</span><span id="line-37"> * @since 1.0</span>
+<span class="source-line-no">038</span><span id="line-38"> */</span>
+<span class="source-line-no">039</span><span id="line-39"> public DefaultAuthenticator(final String userName, final String password) {</span>
+<span class="source-line-no">040</span><span id="line-40"> this.authentication = new PasswordAuthentication(userName, password);</span>
+<span class="source-line-no">041</span><span id="line-41"> }</span>
+<span class="source-line-no">042</span><span id="line-42"></span>
+<span class="source-line-no">043</span><span id="line-43"> /**</span>
+<span class="source-line-no">044</span><span id="line-44"> * Gets the authentication object that will be used to login to the mail server.</span>
+<span class="source-line-no">045</span><span id="line-45"> *</span>
+<span class="source-line-no">046</span><span id="line-46"> * @return A {@code PasswordAuthentication} object containing the login information.</span>
+<span class="source-line-no">047</span><span id="line-47"> * @since 1.0</span>
+<span class="source-line-no">048</span><span id="line-48"> */</span>
+<span class="source-line-no">049</span><span id="line-49"> @Override</span>
+<span class="source-line-no">050</span><span id="line-50"> protected PasswordAuthentication getPasswordAuthentication() {</span>
+<span class="source-line-no">051</span><span id="line-51"> return authentication;</span>
+<span class="source-line-no">052</span><span id="line-52"> }</span>
+<span class="source-line-no">053</span><span id="line-53">}</span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</main>
+</body>
+</html>