View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.mail.resolver;
18  
19  import org.apache.commons.mail.DataSourceResolver;
20  
21  import javax.activation.DataSource;
22  import java.io.IOException;
23  
24  /**
25   * A composite data source resolver. It allows to resolve data sources coming from
26   * multiple locations such as the classpath, the file system or an URL.
27   *
28   * @since 1.3
29   */
30  public class DataSourceCompositeResolver extends DataSourceBaseResolver
31  {
32      /** the list of resolvers */
33      private final DataSourceResolver[] dataSourceResolvers;
34  
35      /**
36       * Constructor.
37       *
38       * @param dataSourceResolvers a list of of resolvers being used
39       */
40      public DataSourceCompositeResolver(final DataSourceResolver[] dataSourceResolvers)
41      {
42          this.dataSourceResolvers = new DataSourceResolver[dataSourceResolvers.length];
43          System.arraycopy(dataSourceResolvers, 0, this.dataSourceResolvers, 0, dataSourceResolvers.length);
44      }
45  
46      /**
47       * Constructor.
48       *
49       * @param dataSourceResolvers a list of of resolvers being used
50       * @param isLenient shall we ignore resources not found or throw an exception?
51       */
52      public DataSourceCompositeResolver(final DataSourceResolver[] dataSourceResolvers, final boolean isLenient)
53      {
54          super(isLenient);
55          this.dataSourceResolvers = new DataSourceResolver[dataSourceResolvers.length];
56          System.arraycopy(dataSourceResolvers, 0, this.dataSourceResolvers, 0, dataSourceResolvers.length);
57      }
58  
59      /**
60       * Get the underlying data source resolvers.
61       *
62       * @return underlying data source resolvers
63       */
64      public DataSourceResolver[] getDataSourceResolvers()
65      {
66          // clone the internal array to prevent external modification (see EMAIL-116)
67          final DataSourceResolver[] resolvers = new DataSourceResolver[dataSourceResolvers.length];
68          System.arraycopy(dataSourceResolvers, 0, resolvers, 0, dataSourceResolvers.length);
69          return resolvers;
70      }
71  
72      /** {@inheritDoc} */
73      @Override
74      public DataSource resolve(final String resourceLocation) throws IOException
75      {
76          final DataSource result = resolve(resourceLocation, true);
77  
78          if (isLenient() || result != null)
79          {
80              return result;
81          }
82          throw new IOException("The following resource was not found : " + resourceLocation);
83  
84      }
85  
86      /** {@inheritDoc} */
87      @Override
88      public DataSource resolve(final String resourceLocation, final boolean isLenient) throws IOException
89      {
90          for (int i = 0; i < getDataSourceResolvers().length; i++)
91          {
92              final DataSourceResolver dataSourceResolver = getDataSourceResolvers()[i];
93              final DataSource dataSource = dataSourceResolver.resolve(resourceLocation, isLenient);
94  
95              if (dataSource != null)
96              {
97                  return dataSource;
98              }
99          }
100 
101         if (isLenient)
102         {
103             return null;
104         }
105         throw new IOException("The following resource was not found : " + resourceLocation);
106     }
107 }