com.sun.enterprise.admin.cli.embeddable.DeployerImpl Maven / Gradle / Ivy
/*
* Copyright (c) 2009, 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 com.sun.enterprise.admin.cli.embeddable;
import org.glassfish.admin.payload.PayloadFilesManager;
import org.glassfish.admin.payload.PayloadImpl;
import org.glassfish.api.ActionReport;
import org.glassfish.api.admin.CommandException;
import org.glassfish.api.admin.ParameterMap;
import org.glassfish.api.admin.Payload;
import org.glassfish.embeddable.Deployer;
import org.glassfish.embeddable.GlassFishException;
import org.jvnet.hk2.annotations.ContractsProvided;
import org.jvnet.hk2.annotations.Service;
import org.glassfish.hk2.api.PerLookup;
import org.glassfish.hk2.api.ServiceLocator;
import jakarta.inject.Inject;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.URI;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Properties;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.glassfish.internal.api.InternalSystemAdministrator;
/**
* This is an implementation of {@link Deployer}. Unlike the other EmbeddedDeployer, this deployer uses admin command
* execution framework to execute the underlying command, as a result we don't by-pass things like command replication
* code.
*
* @author [email protected]
*/
@Service()
@PerLookup
@ContractsProvided({ DeployerImpl.class, Deployer.class }) // bcos Deployer interface can't depend on HK2, we need ContractProvided here.
public class DeployerImpl implements Deployer {
private static final Logger logger = Logger.getLogger(DeployerImpl.class.getPackage().getName());
/*
* This class currently copies generic URIs to a file before processing. Once deployment backend
* supports URI, we should be able to use URIs directly.
*/
@Inject
ServiceLocator habitat;
@Inject
private InternalSystemAdministrator kernelIdentity;
@Override
public String deploy(URI archive, String... params) throws GlassFishException {
File file;
try {
file = convertToFile(archive);
} catch (IOException e) {
throw new GlassFishException("Unable to make a file out of " + archive, e);
}
return deploy(file, params);
}
@Override
public String deploy(File file, String... params) throws GlassFishException {
String[] newParams = new String[params.length + 1];
System.arraycopy(params, 0, newParams, 0, params.length);
newParams[params.length] = file.getAbsolutePath();
CommandExecutorImpl executer = habitat.getService(CommandExecutorImpl.class);
try {
String command = "deploy";
ActionReport actionReport = executer.createActionReport();
ParameterMap commandParams = executer.getParameters(command, newParams);
org.glassfish.api.admin.CommandRunner.CommandInvocation inv = executer.getCommandRunner().getCommandInvocation(command,
actionReport, kernelIdentity.getSubject());
inv.parameters(commandParams);
// set outputbound payload if --retrieve option is specified.
Payload.Outbound outboundPayload = null;
String retrieveOpt = commandParams.getOne("retrieve");
File retrieve = retrieveOpt != null ? new File(retrieveOpt) : null;
if (retrieve != null && retrieve.exists()) {
outboundPayload = PayloadImpl.Outbound.newInstance();
inv.outbound(outboundPayload);
}
inv.execute();
// extract the outbound payload.
if (outboundPayload != null) {
extractPayload(outboundPayload, actionReport, retrieve);
}
return actionReport.getResultType(String.class);
} catch (CommandException e) {
throw new GlassFishException(e);
}
}
@Override
public String deploy(InputStream is, String... params) throws GlassFishException {
try {
return deploy(createFile(is), params);
} catch (IOException e) {
throw new GlassFishException(e);
}
}
@Override
public void undeploy(String appName, String... params) throws GlassFishException {
String[] newParams = new String[params.length + 1];
System.arraycopy(params, 0, newParams, 0, params.length);
newParams[params.length] = appName;
CommandExecutorImpl executer = habitat.getService(CommandExecutorImpl.class);
try {
ActionReport actionReport = executer.executeCommand("undeploy", newParams);
actionReport.writeReport(System.out);
} catch (CommandException e) {
throw new GlassFishException(e);
} catch (IOException e) {
throw new GlassFishException(e);
}
}
@Override
public Collection getDeployedApplications() throws GlassFishException {
try {
CommandExecutorImpl executer = habitat.getService(CommandExecutorImpl.class);
ActionReport report = executer.executeCommand("list-components");
Properties props = report.getTopMessagePart().getProps();
return new ArrayList(props.stringPropertyNames());
} catch (Exception e) {
throw new GlassFishException(e);
}
}
private File convertToFile(URI archive) throws IOException {
File file;
if ("file".equalsIgnoreCase(archive.getScheme())) {
file = new File(archive);
} else {
file = createFile(archive.toURL().openStream());
}
return file;
}
private File createFile(InputStream in) throws IOException {
File file;
file = File.createTempFile("app", "tmp");
file.deleteOnExit();
OutputStream out = null;
try {
out = new FileOutputStream(file);
copyStream(in, out);
} finally {
if (in != null) {
try {
in.close();
} catch (IOException e) {
// ignore
}
}
if (out != null) {
try {
out.close();
} finally {
// ignore
}
}
}
return file;
}
private void copyStream(InputStream in, OutputStream out) throws IOException {
byte[] buf = new byte[4096];
int len;
while ((len = in.read(buf)) >= 0) {
out.write(buf, 0, len);
}
}
/**
* Extract the payload (client side stub jar files) to the directory specified via --retrieve option.
*
* @param outboundPayload Payload to be extracted
* @param actionReport ActionReport of the deploy command.
* @param retrieveDir Directory where the payload should be extracted to.
*/
private void extractPayload(Payload.Outbound outboundPayload, ActionReport actionReport, File retrieveDir) {
File payloadZip = null;
FileOutputStream payloadOutputStream = null;
FileInputStream payloadInputStream = null;
try {
/*
* Add the report to the payload to mimic what the normal
* non-embedded server does.
*/
final ByteArrayOutputStream baos = new ByteArrayOutputStream(1024);
actionReport.writeReport(baos);
final ByteArrayInputStream bais = new ByteArrayInputStream(baos.toByteArray());
final Properties reportProps = new Properties();
reportProps.setProperty("data-request-type", "report");
outboundPayload.addPart(0, actionReport.getContentType(), "report", reportProps, bais);
/*
* Now process the payload as an *inbound* payload as the non-embedded
* admin client does, by writing the *outbound* payload to a temporary file
* then reading from that file.
*/
payloadZip = File.createTempFile("appclient", ".zip");
payloadOutputStream = new FileOutputStream(payloadZip);
outboundPayload.writeTo(payloadOutputStream);
payloadOutputStream.flush();
payloadOutputStream.close();
/*
* Use the temp file's contents as the inbound payload to
* correctly process the downloaded files.
*/
final PayloadFilesManager pfm = new PayloadFilesManager.Perm(retrieveDir,
null /* no action report to record extraction results */, logger);
payloadInputStream = new FileInputStream(payloadZip);
final PayloadImpl.Inbound inboundPayload = PayloadImpl.Inbound.newInstance("application/zip", payloadInputStream);
pfm.processParts(inboundPayload); // explodes the payloadZip.
} catch (Exception ex) {
// Log error and ignore exception.
logger.log(Level.WARNING, ex.getMessage(), ex);
} finally {
if (payloadOutputStream != null) {
try {
payloadOutputStream.close();
} catch (IOException ioex) {
logger.warning(ioex.getMessage());
}
}
if (payloadInputStream != null) {
try {
payloadInputStream.close();
} catch (IOException ioex) {
logger.warning(ioex.getMessage());
}
}
if (payloadZip != null) {
if (payloadZip.delete() == false) {
logger.log(Level.WARNING, "Cannot delete payload: {0}", payloadZip.toString());
}
}
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy