Package org.apache.commons.mail2.javax.resolver

Class DataSourcePathResolver

java.lang.Object

org.apache.commons.mail2.javax.resolver.DataSourceBaseResolver

org.apache.commons.mail2.javax.resolver.DataSourcePathResolver

All Implemented Interfaces:

DataSourceResolver

public final class DataSourcePathResolver
extends DataSourceBaseResolver

Creates a DataSource based on a Path. The implementation also resolves file resources.

Since:

1.6.0

Constructor Summary

Constructors

Constructor	Description
DataSourcePathResolver()	Constructs a new instance.
DataSourcePathResolver(Path baseDir)	Constructs a new instance.
DataSourcePathResolver(Path baseDir, boolean lenient, OpenOption... options)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
Path	getBaseDir()	Gets the base directory used for resolving relative resource locations.
DataSource	resolve(String resourceLocation)	Resolves the given resource location to a DataSource.
DataSource	resolve(String resourceLocation, boolean isLenient)	Resolves the given resource location to a DataSource.

Methods inherited from class org.apache.commons.mail2.javax.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 Details

DataSourcePathResolver

public DataSourcePathResolver()

Constructs a new instance.

DataSourcePathResolver

public DataSourcePathResolver(Path baseDir)

Constructs a new instance.

Parameters:

baseDir - the base directory of the resource when resolving relative paths

DataSourcePathResolver

public DataSourcePathResolver(Path baseDir,
 boolean lenient,
 OpenOption... options)

Constructs a new instance.

Parameters:

baseDir - the base directory of the resource when resolving relative paths

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

options - options for opening streams.

Method Details

getBaseDir

public Path getBaseDir()

Gets the base directory used for resolving relative resource locations.

Returns:

the baseUrl

resolve

public DataSource resolve(String resourceLocation)
                   throws IOException

Resolves the given resource location to a DataSource.

Parameters:

resourceLocation - the location of the resource

Returns:

the DataSource

Throws:

IOException - the resource was not found

resolve

public DataSource resolve(String resourceLocation,
 boolean isLenient)
                   throws 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:

IOException - resolving the resource failed