DataSourceCompositeResolver (Apache Commons Email 1.4 API)

java.lang.Object
+
- org.apache.commons.mail.resolver.DataSourceBaseResolver
- +
  - org.apache.commons.mail.resolver.DataSourceCompositeResolver
  +
+

+
+
All Implemented Interfaces:
+
DataSourceResolver
+
+
+
+
```
public class DataSourceCompositeResolver
+extends DataSourceBaseResolver
```
+
A composite data source resolver. It allows to resolve data sources coming from + multiple locations such as the classpath, the file system or an URL.
+
Since:
+
1.3
+
Version:
+
$Id$
+

+ +

Constructor Summary

+ + + + + + + + + + + +

Constructors
Constructor and Description
`DataSourceCompositeResolver(DataSourceResolver[] dataSourceResolvers)` + Constructor. +
`DataSourceCompositeResolver(DataSourceResolver[] dataSourceResolvers, + boolean isLenient)` + Constructor. +

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + +

Methods
Modifier and Type	Method and Description
`DataSourceResolver[]`	`getDataSourceResolvers()` + Get the underlying data source resolvers. +
`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.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
  + + + +
  - +
    DataSourceCompositeResolver
    +
```
public DataSourceCompositeResolver(DataSourceResolver[] dataSourceResolvers)
```
    +
    Constructor.
    +
    Parameters:
    dataSourceResolvers - a list of of resolvers being used
    +
  + + + +
  - +
    DataSourceCompositeResolver
    +
```
public DataSourceCompositeResolver(DataSourceResolver[] dataSourceResolvers,
+                           boolean isLenient)
```
    +
    Constructor.
    +
    Parameters:
    dataSourceResolvers - a list of of resolvers being used
    isLenient - shall we ignore resources not found or throw an exception?
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    getDataSourceResolvers
    +
```
public DataSourceResolver[] getDataSourceResolvers()
```
    +
    Get the underlying data source resolvers.
    +
    Returns:
    underlying data source resolvers
    +
  + + + +
  - +
    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
    +
  +
+

java.lang.Object
+
- org.apache.commons.mail.resolver.DataSourceBaseResolver
- +
  - org.apache.commons.mail.resolver.DataSourceFileResolver
  +
+

+
+
All Implemented Interfaces:
+
DataSourceResolver
+
+
+
+
```
public class DataSourceFileResolver
+extends DataSourceBaseResolver
```
+
Creates a DataSource based on an URL. The implementation + also resolves file resources.
+
Since:
+
1.3
+
Version:
+
$Id$
+

+ +

+ + +

Constructor Summary

+ + + + + + + + + + + + + + +

Constructors
Constructor and Description
`DataSourceFileResolver()` + Constructor. +
`DataSourceFileResolver(File baseDir)` + Constructor. +
`DataSourceFileResolver(File baseDir, + boolean lenient)` + Constructor. +

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + +

Methods
Modifier and Type	Method and Description
`File`	`getBaseDir()` + Get 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.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
  + + + +
  - +
    DataSourceFileResolver
    +
```
public DataSourceFileResolver()
```
    +
    Constructor.
    +
  + + + +
  - +
    DataSourceFileResolver
    +
```
public DataSourceFileResolver(File baseDir)
```
    +
    Constructor.
    +
    Parameters:
    baseDir - the base directory of the resource when resolving relative paths
    +
  + + + +
  - +
    DataSourceFileResolver
    +
```
public DataSourceFileResolver(File baseDir,
+                      boolean lenient)
```
    +
    Constructor.
    +
    Parameters:
    baseDir - the base directory of the resource when resolving relative paths
    lenient - shall we ignore resources not found or complain with an exception
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    getBaseDir
    +
```
public File getBaseDir()
```
    +
    Get 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
    +
  +
+

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
+
Version:
+
$Id$
+

+ +

+ + +

Constructor Summary

+ + + + + + + + + + + +

Constructors
Constructor and Description
`DataSourceUrlResolver(URL baseUrl)` + Constructor. +
`DataSourceUrlResolver(URL baseUrl, + boolean lenient)` + Constructor. +

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + +

Methods
Modifier and Type	Method and Description
`protected URL`	`createUrl(String resourceLocation)` + Create an URL based on a base URL and a resource location suitable for loading + the resource. +
`URL`	`getBaseUrl()` + Get the base URL 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.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(URL baseUrl)
```
    +
    Constructor.
    +
    Parameters:
    baseUrl - the base URL used for resolving relative resource locations
    +
  + + + +
  - +
    DataSourceUrlResolver
    +
```
public DataSourceUrlResolver(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 URL getBaseUrl()
```
    +
    Get the base URL 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
    +
  + + + +
  - +
    createUrl
    +
```
protected URL createUrl(String resourceLocation)
+                 throws 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:
    +
    MalformedURLException - creating the URL failed
    +
  +
+

+ + + + + + + + + + + + +

Packages that use DataSourceBaseResolver
Package	Description
org.apache.commons.mail.resolver	+ Contains implementation classes to resolve data sources from the following locations: + + class path + file system + URL + +

+ + +

Uses of DataSourceBaseResolver in org.apache.commons.mail.resolver

+ + + + + + + + + + + + + + + + + + + + + + + + +

Subclasses of DataSourceBaseResolver in org.apache.commons.mail.resolver
Modifier and Type	Class and Description
`class`	`DataSourceClassPathResolver` + Creates a `DataSource` based on an class path. +
`class`	`DataSourceCompositeResolver` + A composite data source resolver. +
`class`	`DataSourceFileResolver` + Creates a `DataSource` based on an URL. +
`class`	`DataSourceUrlResolver` + Creates a `DataSource` based on an URL. +

Class DataSourceCompositeResolver

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

DataSourceCompositeResolver

DataSourceCompositeResolver

Method Detail

getDataSourceResolvers

resolve

resolve

Class DataSourceFileResolver

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

DataSourceFileResolver

DataSourceFileResolver

DataSourceFileResolver

Method Detail

getBaseDir

resolve

resolve

Class DataSourceUrlResolver

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

DataSourceUrlResolver

DataSourceUrlResolver

Method Detail

getBaseUrl

resolve

resolve

createUrl

Uses of Classorg.apache.commons.mail.resolver.DataSourceBaseResolver

Uses of DataSourceBaseResolver in org.apache.commons.mail.resolver

Uses of Classorg.apache.commons.mail.resolver.DataSourceClassPathResolver

Uses of Classorg.apache.commons.mail.resolver.DataSourceCompositeResolver

Uses of Class
org.apache.commons.mail.resolver.DataSourceBaseResolver

Uses of Class
org.apache.commons.mail.resolver.DataSourceClassPathResolver

Uses of Class
org.apache.commons.mail.resolver.DataSourceCompositeResolver