/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.enterprise.instance;
import java.io.IOException;
import java.io.OutputStream;
import java.io.File;
import java.util.Iterator;
import javax.enterprise.deploy.shared.ModuleType;
import com.sun.enterprise.deployment.Application;
import com.sun.enterprise.deployment.archivist.ApplicationArchivist;
import com.sun.enterprise.deployment.archivist.Archivist;
import com.sun.enterprise.deployment.archivist.ArchivistFactory;
import com.sun.enterprise.deployment.BundleDescriptor;
import com.sun.enterprise.deployment.deploy.shared.AbstractArchive;
import com.sun.enterprise.deployment.deploy.shared.FileArchive;
import com.sun.enterprise.deployment.io.DeploymentDescriptorFile;
import com.sun.enterprise.deployment.util.ModuleDescriptor;
import com.sun.enterprise.deployment.WebBundleDescriptor;
import com.sun.enterprise.deployment.WebServicesDescriptor;
import com.sun.enterprise.deployment.WebService;
/**
* This class is responsible for writing deployment descriptors
* after a deployment action has occured to a abstract archive instance.
*
* @author Jerome Dochez
*/
public class DescriptorArchivist {
/** Creates a new instance of DescriptorArchivist */
public DescriptorArchivist() {
}
/**
* writes an application deployment descriptors
* @param the application object
* @param the abstract archive
*/
public void write(Application application, AbstractArchive in,
AbstractArchive out) throws IOException {
if (application.isVirtual()) {
ModuleDescriptor aModule = (ModuleDescriptor) application.getModules().next();
Archivist moduleArchivist = ArchivistFactory.getArchivistForType(aModule.getModuleType());
write(aModule.getDescriptor(), moduleArchivist, in, out);
} else {
// this is a real application.
// let's start by writing out all submodules deployment descriptors
for (Iterator modules = application.getModules();modules.hasNext();) {
ModuleDescriptor aModule = (ModuleDescriptor) modules.next();
Archivist moduleArchivist = ArchivistFactory.getArchivistForType(aModule.getModuleType());
if (aModule.getAlternateDescriptor()!=null) {
// the application is using alternate deployment descriptors
// write or copy standard deployment descriptor
String ddPath = aModule.getAlternateDescriptor();
DeploymentDescriptorFile ddFile =
moduleArchivist.getStandardDDFile();
BundleDescriptor bundle =
(BundleDescriptor)aModule.getDescriptor();
if (!bundle.isFullFlag()) {
if (ddFile != null) {
OutputStream os = out.putNextEntry(ddPath);
ddFile.write(bundle, os);
out.closeEntry();
}
} else {
if (aModule.getModuleType().equals(ModuleType.WAR)) {
WebBundleDescriptor webBundle =
(WebBundleDescriptor) aModule.getDescriptor();
if (webBundle.hasWebServices()) {
if (ddFile != null) {
OutputStream os = out.putNextEntry(ddPath);
ddFile.write(webBundle, os);
out.closeEntry();
}
} else {
Archivist.copyAnEntry(in, out, ddPath);
}
} else {
Archivist.copyAnEntry(in, out, ddPath);
}
}
String runtimeDDPath = "sun-" + ddPath;
DeploymentDescriptorFile confDDFile = moduleArchivist.getConfigurationDDFile();
if (confDDFile!=null) {
OutputStream os = out.putNextEntry(runtimeDDPath);
confDDFile.write(aModule.getDescriptor(), os);
out.closeEntry();
}
} else {
String archiveUri = in.getArchiveUri();
String moduleUri = aModule.getArchiveUri();
AbstractArchive moduleArchive;
AbstractArchive moduleArchive2 = in.getEmbeddedArchive(archiveUri);
if (new File(archiveUri).isDirectory() &&
archiveUri.endsWith(".ear") &&
new File(archiveUri, moduleUri).isDirectory() &&
(moduleUri.endsWith(".war") ||
moduleUri.endsWith(".rar") ||
moduleUri.endsWith(".jar")) ) {
// this is the case where we support the directory deployment
// of directory names ending with module type suffix.
File subDir = new File(out.getArchiveUri(), moduleUri);
if (!subDir.exists()) {
subDir.mkdirs();
}
moduleArchive = new FileArchive();
((FileArchive)moduleArchive).open(subDir.getPath());
} else {
moduleArchive = out.getEmbeddedArchive(moduleUri);
}
write(aModule.getDescriptor(), moduleArchivist, moduleArchive2, moduleArchive);
}
}
// now let's write the application descriptor
ApplicationArchivist archivist = new ApplicationArchivist();
archivist.setDescriptor(application);
archivist.writeRuntimeDeploymentDescriptors(out);
if (application.isLoadedFromApplicationXml()) {
archivist.copyStandardDeploymentDescriptors(in, out);
} else {
archivist.writeStandardDeploymentDescriptors(out);
}
}
}
/**
* writes a bundle descriptor
* @param the bundle descriptor
* @param the abstract archive
*/
public void write(BundleDescriptor bundle, AbstractArchive in, AbstractArchive out)
throws IOException
{
Archivist archivist = ArchivistFactory.getArchivistForArchive(out);
write(bundle, archivist, in, out);
}
/**
* writes a bundle descriptor
* @param the bundle descriptor
* @param the archivist responsible for writing such bundle type
* @param the archive to write to
*/
protected void write(BundleDescriptor bundle, Archivist archivist, AbstractArchive in, AbstractArchive out)
throws IOException
{
archivist.setDescriptor(bundle);
archivist.writeRuntimeDeploymentDescriptors(out);
// this path is only called through dynamic deployment
// i.e from EJBCompiler.preDeployApp -> BaseManager.saveAppDescriptor
// so write out deployment descriptors if it's not a full DD
if (!bundle.isFullFlag()) {
archivist.writeStandardDeploymentDescriptors(out);
} else {
// Also if this is a web bundle descriptor, we always want to
// rewrite the standard deployment descriptors if we have web
// services since the servlet implementation has been switched
if (bundle.getModuleType().equals(ModuleType.WAR)) {
WebBundleDescriptor webBundle = (WebBundleDescriptor) bundle;
if (webBundle.hasWebServices()) {
archivist.writeStandardDeploymentDescriptors(out);
} else {
archivist.copyStandardDeploymentDescriptors(in, out);
}
} else {
archivist.copyStandardDeploymentDescriptors(in, out);
}
}
// copy mapping files if it's not ended with .xml
// all xml files will be copied later in BaseManager
// (Archivist.copyExtraElements)
if (bundle.hasWebServices()) {
WebServicesDescriptor webServices = bundle.getWebServices();
for (WebService webService : webServices.getWebServices()) {
if (webService.hasMappingFile() &&
!webService.getMappingFileUri().endsWith(".xml")) {
Archivist.copyAnEntry(in, out,
webService.getMappingFileUri());
}
}
}
}
}