| /* |
| * Copyright (c) 2010, 2018 Oracle and/or its affiliates. All rights reserved. |
| * |
| * This program and the accompanying materials are made available under the |
| * terms of the Eclipse Public License v. 2.0, which is available at |
| * http://www.eclipse.org/legal/epl-2.0. |
| * |
| * This Source Code may also be made available under the following Secondary |
| * Licenses when the conditions for such availability set forth in the |
| * Eclipse Public License v. 2.0 are satisfied: GNU General Public License, |
| * version 2 with the GNU Classpath Exception, which is available at |
| * https://www.gnu.org/software/classpath/license.html. |
| * |
| * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 |
| */ |
| |
| package org.glassfish.embeddable.archive; |
| |
| import java.io.File; |
| import java.io.FileNotFoundException; |
| import java.io.IOException; |
| import java.net.URI; |
| import java.util.ArrayList; |
| import java.util.HashMap; |
| import java.util.List; |
| import java.util.Map; |
| |
| /** |
| * Abstraction for a Scattered Java EE Application. |
| * <p/> |
| * <p/> |
| * Usage example : |
| * <p/> |
| * <style type="text/css"> |
| * .ln { color: rgb(0,0,0); font-weight: normal; font-style: normal; } |
| * .s0 { color: rgb(128,128,128); } |
| * .s1 { } |
| * .s2 { color: rgb(0,0,255); } |
| * .s3 { color: rgb(128,128,128); font-weight: bold; } |
| * .s4 { color: rgb(255,0,255); } |
| * </style> |
| * <pre> |
| * <a name="l56"> GlassFish glassfish = GlassFishRuntime.bootstrap().newGlassFish(); |
| * <a name="l57"> glassfish.start(); |
| * <a name="l58"> |
| * <a name="l59"> </span><span class="s0">// Create a scattered web application.</span><span class="s1"> |
| * <a name="l60"> ScatteredArchive webmodule = </span><span class="s2">new </span><span class="s1">ScatteredArchive(</span><span class="s4">"testweb"</span><span class="s1">, ScatteredArchive.Type.WAR); |
| * <a name="l61"> </span><span class="s0">// target/classes directory contains my complied servlets</span><span class="s1"> |
| * <a name="l62"> webmodule.addClassPath(</span><span class="s2">new </span><span class="s1">File(</span><span class="s4">"target"</span><span class="s1">, </span><span class="s4">"classes"</span><span class="s1">)); |
| * <a name="l63"> </span><span class="s0">// resources/sun-web.xml is my WEB-INF/sun-web.xml</span><span class="s1"> |
| * <a name="l64"> webmodule.addMetadata(</span><span class="s2">new </span><span class="s1">File(</span><span class="s4">"resources"</span><span class="s1">, </span><span class="s4">"sun-web.xml"</span><span class="s1">)); |
| * <a name="l65"> |
| * <a name="l66"> </span><span class="s0">// Create a scattered enterprise archive.</span><span class="s1"> |
| * <a name="l67"> ScatteredEnterpriseArchive archive = </span><span class="s2">new </span><span class="s1">ScatteredEnterpriseArchive(</span><span class="s4">"testapp"</span><span class="s1">); |
| * <a name="l68"> </span><span class="s0">// src/application.xml is my META-INF/application.xml</span><span class="s1"> |
| * <a name="l69"> archive.addMetadata(</span><span class="s2">new </span><span class="s1">File(</span><span class="s4">"src"</span><span class="s1">, </span><span class="s4">"application.xml"</span><span class="s1">)); |
| * <a name="l70"> </span><span class="s0">// Add scattered web module to the scattered enterprise archive.</span><span class="s1"> |
| * <a name="l71"> </span><span class="s0">// src/application.xml references Web module as "scattered.war". Hence specify the name while adding the archive.</span><span class="s1"> |
| * <a name="l72"> archive.addArchive(webmodule.toURI(), </span><span class="s4">"scattered.war"</span><span class="s1">); |
| * <a name="l73"> </span><span class="s0">// lib/mylibrary.jar is a library JAR file.</span><span class="s1"> |
| * <a name="l74"> archive.addArchive(</span><span class="s2">new </span><span class="s1">File(</span><span class="s4">"lib"</span><span class="s1">, </span><span class="s4">"mylibrary.jar"</span><span class="s1">)); |
| * <a name="l75"> </span><span class="s0">// target/ejbclasses contain my compiled EJB module.</span><span class="s1"> |
| * <a name="l76"> </span><span class="s0">// src/application.xml references EJB module as "ejb.jar". Hence specify the name while adding the archive.</span><span class="s1"> |
| * <a name="l77"> archive.addArchive(</span><span class="s2">new </span><span class="s1">File(</span><span class="s4">"target"</span><span class="s1">, </span><span class="s4">"ejbclasses"</span><span class="s1">), </span><span class="s4">"ejb.jar"</span><span class="s1">); |
| * <a name="l78"> |
| * <a name="l79"> Deployer deployer = glassfish.getDeployer(); |
| * <a name="l80"> </span><span class="s0">// Deploy my scattered web application</span><span class="s1"> |
| * <a name="l81"> deployer.deploy(webmodule.toURI()); |
| * </pre> |
| * |
| * @author bhavanishankar@java.net |
| */ |
| public class ScatteredEnterpriseArchive { |
| |
| String name; |
| static final String type = "ear"; |
| Map<String, File> archives = new HashMap<String, File>(); |
| Map<String, File> metadatas = new HashMap<String, File>(); |
| |
| /** |
| * Construct a new scattered enterprise archive. |
| * |
| * @param name Name of the enterprise archive. |
| * @throws NullPointerException if name is null. |
| */ |
| public ScatteredEnterpriseArchive(String name) { |
| if (name == null) { |
| throw new NullPointerException("name must not be null."); |
| } |
| this.name = name; |
| } |
| |
| /** |
| * Add a module or a library to this scattered enterprise archive. |
| * <p/> |
| * The addArchive(archiveURI) method has the same effect as: |
| * <pre> |
| * addMetadata(archiveURI, null) |
| * </pre> |
| * Follows the same semantics as {@link #addArchive(URI, String)} method. |
| */ |
| public void addArchive(URI archiveURI) throws IOException { |
| addArchive(archiveURI, null); |
| } |
| |
| /** |
| * Add a module or a library to this scattered enterprise archive. |
| * <p/> |
| * The specified archiveURI must be one of the following: |
| * <pre> |
| * ScatteredArchive URI obtained via {@link ScatteredArchive#toURI()}. |
| * Location of a library JAR file. Must be a File URI. |
| * Location of a Java EE module. Must be a File URI. |
| * </pre> |
| * If the specified name is null, then the name is computed as the name of the |
| * File as located by archiveURI. |
| * |
| * @param archiveURI Module or library archive URI. |
| * @param name name of the module/library as specified in META-INF/application.xml |
| * @throws NullPointerException if archiveURI is null |
| * @throws IOException if the archiveURI location is not found. |
| */ |
| public void addArchive(URI archiveURI, String name) throws IOException { |
| addArchive(archiveURI != null ? new File(archiveURI) : null, name); |
| } |
| |
| /** |
| * Add a module or a library to this scattered enterprise archive. |
| * <p/> |
| * The addArchive(archive) method has the same effect as: |
| * <pre> |
| * addArchive(archive, null) |
| * </pre> |
| * Follows the same semantics as {@link #addArchive(File, String)} method. |
| * archive must be a file location. |
| */ |
| // public void addArchive(String archive) { |
| // addArchive(archive, null); |
| // } |
| |
| /** |
| * Add a module or a library to this scattered enterprise archive. |
| * <p/> |
| * Follows the same semantics as {@link #addArchive(File, String)} method. |
| * archive must be a file location. |
| */ |
| // public void addArchive(String archive, String name) { |
| // addArchive(archive != null ? new File(archive) : null, name); |
| // } |
| |
| /** |
| * Add a module or a library to this scattered enterprise archive. |
| * <p/> |
| * The addArchive(archive) method has the same effect as: |
| * <pre> |
| * addArchive(archive, null) |
| * </pre> |
| * Follows the same semantics as {@link #addArchive(File, String)} method. |
| */ |
| public void addArchive(File archive) throws IOException { |
| addArchive(archive, null); |
| } |
| |
| /** |
| * Add a module or a library to this scattered enterprise archive. |
| * <p/> |
| * The specified archive location should be one of the following: |
| * <pre> |
| * Location of a library JAR file. |
| * Location of a Java EE module. |
| * </pre> |
| * If the specified name is null, then the name is computed as archive.getName() |
| * |
| * @param archive Location of module or library archive. |
| * @param name name of the module/library as specified in META-INF/application.xml |
| * @throws NullPointerException if archive is null |
| * @throws IOException if the archive file is not found |
| */ |
| public void addArchive(File archive, String name) throws IOException { |
| if (archive == null) { |
| throw new NullPointerException("archive must not be null."); |
| } |
| if (!archive.exists()) { |
| throw new FileNotFoundException(archive + " does not exist."); |
| } |
| // if (archive.isDirectory()) { |
| // throw new IllegalArgumentException(archive + " is a directory."); |
| // } |
| if (name == null) { |
| name = archive.getName(); |
| } |
| this.archives.put(name, archive); |
| } |
| |
| /** |
| * Add a new metadata to this scattered enterprise archive. |
| * <p/> |
| * The addMetadata(metadata) method has the same effect as: |
| * <pre> |
| * addMetadata(metadata, null) |
| * </pre> |
| * Follows the same semantics as {@link #addMetadata(String, String)} method. |
| */ |
| // public void addMetadata(String metadata) { |
| // addMetadata(metadata, null); |
| // } |
| |
| /** |
| * Add a new metadata to this scattered enterprise archive. |
| * <p/> |
| * The addMetadata(metadata) method has the same effect as: |
| * <pre> |
| * addMetadata(metadata, null) |
| * </pre> |
| * Follows the same semantics as {@link #addMetadata(File, String)} method. |
| */ |
| public void addMetadata(File metadata) throws IOException { |
| addMetadata(metadata, null); |
| } |
| |
| /** |
| * Add a new metadata to this enterprise archive. |
| * <p/> |
| * Follows the same semantics as {@link #addMetadata(File, String)} method. |
| * metatdata must be a file location. |
| */ |
| // public void addMetadata(String metadata, String name) { |
| // addMetadata(metadata != null ? new File(metadata) : null, name); |
| // } |
| |
| /** |
| * Add a new metadata to this enterprise archive. |
| * <p/> |
| * A metadata is identified by its name (e.g., META-INF/application.xml) |
| * If the specified name is null, then the name is computed as |
| * "META-INF/" + metadata.getName() |
| * <p/> |
| * If the scattered enterprise archive already contains the metadata with |
| * the same name, the old value is replaced. |
| * |
| * @param metadata location of metdata. |
| * @param name name of the metadata (e.g., META-INF/application.xml) |
| * @throws NullPointerException if metadata is null |
| * @throws IOException if metadata is not found |
| * @throws IllegalArgumentException if metadata is a directory. |
| */ |
| |
| public void addMetadata(File metadata, String name) throws IOException { |
| if (metadata == null) { |
| throw new NullPointerException("metadata must not be null."); |
| } |
| if (!metadata.exists()) { |
| throw new IOException(metadata + " does not exist."); |
| } |
| if (metadata.isDirectory()) { |
| throw new IllegalArgumentException(metadata + " is a directory."); |
| } |
| if (name == null) { |
| name = "META-INF/" + metadata.getName(); |
| } |
| this.metadatas.put(name, metadata); |
| } |
| |
| /** |
| * Get the deployable URI for this scattered enterprise archive. |
| * <p/> |
| * <i>Note : java.io.tmpdir is used while building the URI.</i> |
| * |
| * @return Deployable scattered enterprise Archive URI. |
| * @throws IOException if any I/O error happens while building the URI |
| * or while reading metadata, archives. |
| */ |
| public URI toURI() throws IOException { |
| return new Assembler().assemble(this); |
| } |
| } |
