| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| */ |
| package org.apache.brooklyn.entity.webapp; |
| |
| import static com.google.common.base.Preconditions.checkNotNull; |
| |
| import java.io.File; |
| import java.net.URI; |
| import java.util.Set; |
| |
| import com.google.common.net.HostAndPort; |
| import org.apache.brooklyn.core.entity.Attributes; |
| import org.apache.brooklyn.core.location.access.BrooklynAccessUtils; |
| import org.apache.brooklyn.entity.java.JavaSoftwareProcessSshDriver; |
| import org.apache.brooklyn.location.ssh.SshMachineLocation; |
| import org.apache.brooklyn.util.core.task.DynamicTasks; |
| import org.apache.brooklyn.util.core.task.Tasks; |
| import org.apache.brooklyn.util.core.task.ssh.SshTasks; |
| import org.apache.brooklyn.util.text.Strings; |
| |
| import com.google.common.collect.ImmutableList; |
| |
| public abstract class JavaWebAppSshDriver extends JavaSoftwareProcessSshDriver implements JavaWebAppDriver { |
| |
| public JavaWebAppSshDriver(JavaWebAppSoftwareProcessImpl entity, SshMachineLocation machine) { |
| super(entity, machine); |
| } |
| |
| public JavaWebAppSoftwareProcessImpl getEntity() { |
| return (JavaWebAppSoftwareProcessImpl) super.getEntity(); |
| } |
| |
| protected boolean isProtocolEnabled(String protocol) { |
| Set<String> protocols = getEnabledProtocols(); |
| for (String contender : protocols) { |
| if (protocol.equalsIgnoreCase(contender)) { |
| return true; |
| } |
| } |
| return false; |
| } |
| |
| @Override |
| public Set<String> getEnabledProtocols() { |
| return entity.getAttribute(JavaWebAppSoftwareProcess.ENABLED_PROTOCOLS); |
| } |
| |
| @Override |
| public Integer getHttpPort() { |
| return entity.getAttribute(Attributes.HTTP_PORT); |
| } |
| |
| @Override |
| public Integer getHttpsPort() { |
| return entity.getAttribute(Attributes.HTTPS_PORT); |
| } |
| |
| @Override |
| public HttpsSslConfig getHttpsSslConfig() { |
| return entity.getAttribute(WebAppServiceConstants.HTTPS_SSL_CONFIG); |
| } |
| |
| protected String getSslKeystoreUrl() { |
| HttpsSslConfig ssl = getHttpsSslConfig(); |
| return (ssl == null) ? null : ssl.getKeystoreUrl(); |
| } |
| |
| protected String getSslKeystorePassword() { |
| HttpsSslConfig ssl = getHttpsSslConfig(); |
| return (ssl == null) ? null : ssl.getKeystorePassword(); |
| } |
| |
| protected String getSslKeyAlias() { |
| HttpsSslConfig ssl = getHttpsSslConfig(); |
| return (ssl == null) ? null : ssl.getKeyAlias(); |
| } |
| |
| protected String inferRootUrl() { |
| if (isProtocolEnabled("https")) { |
| Integer port = getHttpsPort(); |
| checkNotNull(port, "HTTPS_PORT sensors not set; is an acceptable port available?"); |
| HostAndPort accessibleAddress = BrooklynAccessUtils.getBrooklynAccessibleAddress(getEntity(), port); |
| return String.format("https://%s:%s/", accessibleAddress.getHostText(), accessibleAddress.getPort()); |
| } else if (isProtocolEnabled("http")) { |
| Integer port = getHttpPort(); |
| checkNotNull(port, "HTTP_PORT sensors not set; is an acceptable port available?"); |
| HostAndPort accessibleAddress = BrooklynAccessUtils.getBrooklynAccessibleAddress(getEntity(), port); |
| return String.format("http://%s:%s/", accessibleAddress.getHostText(), accessibleAddress.getPort()); |
| } else { |
| throw new IllegalStateException("HTTP and HTTPS protocols not enabled for "+entity+"; enabled protocols are "+getEnabledProtocols()); |
| } |
| } |
| |
| @Override |
| public void postLaunch() { |
| String rootUrl = inferRootUrl(); |
| entity.sensors().set(Attributes.MAIN_URI, URI.create(rootUrl)); |
| entity.sensors().set(WebAppService.ROOT_URL, rootUrl); |
| } |
| |
| /** |
| * if files should be placed on the server for deployment, |
| * override this to be the sub-directory of the runDir where they should be stored |
| * (or override getDeployDir() if they should be copied somewhere else, |
| * and set this null); |
| * if files are not copied to the server, but injected (e.g. JMX or uploaded) |
| * then override {@link #deploy(String, String)} as appropriate, |
| * using getContextFromDeploymentTargetName(targetName) |
| * and override this to return null |
| */ |
| protected abstract String getDeploySubdir(); |
| |
| protected String getDeployDir() { |
| if (getDeploySubdir()==null) |
| throw new IllegalStateException("no deployment directory available for "+this); |
| return getRunDir() + "/" + getDeploySubdir(); |
| } |
| |
| @Override |
| public void deploy(File file) { |
| deploy(file, null); |
| } |
| |
| @Override |
| public void deploy(File f, String targetName) { |
| if (targetName == null) { |
| targetName = f.getName(); |
| } |
| deploy(f.toURI().toASCIIString(), targetName); |
| } |
| |
| /** |
| * Deploys a URL as a webapp at the appserver. |
| * |
| * Returns a token which can be used as an argument to undeploy, |
| * typically the web context with leading slash where the app can be reached (just "/" for ROOT) |
| * |
| * @see JavaWebAppSoftwareProcess#deploy(String, String) for details of how input filenames are handled |
| */ |
| @Override |
| public String deploy(final String url, final String targetName) { |
| final String canonicalTargetName = getFilenameContextMapper().convertDeploymentTargetNameToFilename(targetName); |
| final String dest = getDeployDir() + "/" + canonicalTargetName; |
| //write to a .tmp so autodeploy is not triggered during upload |
| final String tmpDest = dest + "." + Strings.makeRandomId(8) + ".tmp"; |
| final String msg = String.format("deploying %s to %s:%s", new Object[]{url, getHostname(), dest}); |
| log.info(entity + " " + msg); |
| Tasks.setBlockingDetails(msg); |
| try { |
| final String copyTaskMsg = String.format("copying %s to %s:%s", new Object[]{url, getHostname(), tmpDest}); |
| DynamicTasks.queue(copyTaskMsg, new Runnable() { |
| @Override |
| public void run() { |
| int result = copyResource(url, tmpDest); |
| if (result != 0) { |
| throw new IllegalStateException("Invalid result " + result + " while " + copyTaskMsg); |
| } |
| } |
| }); |
| |
| // create a backup |
| DynamicTasks.queue(SshTasks.newSshExecTaskFactory(getMachine(), String.format("mv -f %s %s.bak", dest, dest)) |
| .allowingNonZeroExitCode()); |
| |
| //rename temporary upload file to .war to be picked up for deployment |
| DynamicTasks.queue(SshTasks.newSshExecTaskFactory(getMachine(), String.format("mv -f %s %s", tmpDest, dest)) |
| .requiringExitCodeZero()); |
| log.debug("{} deployed {} to {}:{}", new Object[]{entity, url, getHostname(), dest}); |
| |
| DynamicTasks.waitForLast(); |
| } finally { |
| Tasks.resetBlockingDetails(); |
| } |
| return getFilenameContextMapper().convertDeploymentTargetNameToContext(canonicalTargetName); |
| } |
| |
| @Override |
| public void undeploy(String targetName) { |
| String dest = getDeployDir() + "/" + getFilenameContextMapper().convertDeploymentTargetNameToFilename(targetName); |
| log.info("{} undeploying {}:{}", new Object[]{entity, getHostname(), dest}); |
| int result = getMachine().execCommands("removing war on undeploy", ImmutableList.of(String.format("rm -f %s", dest))); |
| log.debug("{} undeployed {}:{}: result {}", new Object[]{entity, getHostname(), dest, result}); |
| } |
| |
| @Override |
| public FilenameToWebContextMapper getFilenameContextMapper() { |
| return new FilenameToWebContextMapper(); |
| } |
| } |