View Javadoc
1   /*
2    * Copyright (c) 2012-2022, jcabi.com
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions
7    * are met: 1) Redistributions of source code must retain the above
8    * copyright notice, this list of conditions and the following
9    * disclaimer. 2) Redistributions in binary form must reproduce the above
10   * copyright notice, this list of conditions and the following
11   * disclaimer in the documentation and/or other materials provided
12   * with the distribution. 3) Neither the name of the jcabi.com nor
13   * the names of its contributors may be used to endorse or promote
14   * products derived from this software without specific prior written
15   * permission.
16   *
17   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18   * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
19   * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
20   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
21   * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
22   * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25   * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
28   * OF THE POSSIBILITY OF SUCH DAMAGE.
29   */
30  package com.jcabi.manifests;
31  
32  import com.jcabi.log.Logger;
33  import java.io.IOException;
34  import java.io.InputStream;
35  import java.net.URL;
36  import java.util.ArrayList;
37  import java.util.Collection;
38  import javax.servlet.ServletContext;
39  
40  /**
41   * Manifests in servlet context.
42   *
43   * Append attributes from the web application {@code MANIFEST.MF}.
44   *
45   * <p>You can use this class in your own
46   * {@link javax.servlet.Filter} or
47   * {@link javax.servlet.ServletContextListener},
48   * in order to inject {@code MANIFEST.MF} attributes to the class:
49   *
50   * <pre> Manifests.append(new ServletMfs(context));</pre>
51   *
52   * <p>The class is thread-safe.
53   *
54   * @since 1.0
55   */
56  public final class ServletMfs implements Mfs {
57  
58      /**
59       * Servlet context.
60       */
61      private final transient ServletContext ctx;
62  
63      /**
64       * Ctor.
65       * @param context Context
66       */
67      public ServletMfs(final ServletContext context) {
68          this.ctx = context;
69      }
70  
71      @Override
72      public Collection<InputStream> fetch() throws IOException {
73          final URL main = this.ctx.getResource("/META-INF/MANIFEST.MF");
74          final Collection<InputStream> streams = new ArrayList<>(1);
75          if (main == null) {
76              Logger.warn(this, "MANIFEST.MF not found in WAR package");
77          } else {
78              streams.add(main.openStream());
79          }
80          return streams;
81      }
82  
83  }