org.apache.commons.mail.resolver

Class DataSourceUrlResolver

java.lang.Object

org.apache.commons.mail.resolver.DataSourceBaseResolver

org.apache.commons.mail.resolver.DataSourceUrlResolver

All Implemented Interfaces:

DataSourceResolver

public class DataSourceUrlResolver
extends DataSourceBaseResolver

Creates a DataSource based on an URL.

Since:

1.3

Constructor Summary

Constructors

Constructor and Description
DataSourceUrlResolver(java.net.URL baseUrl) Constructor.
DataSourceUrlResolver(java.net.URL baseUrl, boolean lenient) Constructor.

Method Summary

Modifier and Type	Method and Description
protected java.net.URL	createUrl(java.lang.String resourceLocation) Create an URL based on a base URL and a resource location suitable for loading the resource.
java.net.URL	getBaseUrl() Get the base URL used for resolving relative resource locations.
javax.activation.DataSource	resolve(java.lang.String resourceLocation) Resolves the given resource location to a DataSource.
javax.activation.DataSource	resolve(java.lang.String resourceLocation, boolean isLenient) Resolves the given resource location to a DataSource.

Methods inherited from class org.apache.commons.mail.resolver.DataSourceBaseResolver

isCid, isFileUrl, isHttpUrl, isLenient

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSourceUrlResolver

public DataSourceUrlResolver(java.net.URL baseUrl)

Constructor.

Parameters:

baseUrl - the base URL used for resolving relative resource locations

DataSourceUrlResolver

public DataSourceUrlResolver(java.net.URL baseUrl,
                             boolean lenient)

Constructor.

Parameters:

baseUrl - the base URL used for resolving relative resource locations

lenient - shall we ignore resources not found or complain with an exception

Method Detail

getBaseUrl

public java.net.URL getBaseUrl()

Get the base URL used for resolving relative resource locations.

Returns:

the baseUrl

resolve

public javax.activation.DataSource resolve(java.lang.String resourceLocation)
                                    throws java.io.IOException

Resolves the given resource location to a DataSource.

Parameters:

resourceLocation - the location of the resource

Returns:

the DataSource

Throws:

java.io.IOException - the resource was not found

resolve

public javax.activation.DataSource resolve(java.lang.String resourceLocation,
                                           boolean isLenient)
                                    throws java.io.IOException

Resolves the given resource location to a DataSource.

Parameters:

resourceLocation - the location of the resource

isLenient - shall we ignore resources not found or complain with an exception?

Returns:

the data source containing the resource or null if the resource was not found in lenient mode

Throws:

java.io.IOException - resolving the resource failed

createUrl

protected java.net.URL createUrl(java.lang.String resourceLocation)
                          throws java.net.MalformedURLException

Create an URL based on a base URL and a resource location suitable for loading the resource.

Parameters:

resourceLocation - a resource location

Returns:

the corresponding URL

Throws:

java.net.MalformedURLException - creating the URL failed