com.openshift.internal.client.ApplicationResource Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2011 Red Hat, Inc.
* Distributed under license by Red Hat, Inc. All rights reserved.
* This program is made available under the terms of the
* Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Red Hat, Inc. - initial API and implementation
******************************************************************************/
package com.openshift.internal.client;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.MalformedURLException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.concurrent.Callable;
import java.util.concurrent.Future;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.xml.datatype.DatatypeConfigurationException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.jcraft.jsch.Channel;
import com.jcraft.jsch.ChannelExec;
import com.jcraft.jsch.JSchException;
import com.jcraft.jsch.Session;
import com.openshift.client.ApplicationScale;
import com.openshift.client.IApplication;
import com.openshift.client.IApplicationPortForwarding;
import com.openshift.client.IDomain;
import com.openshift.client.IGearGroup;
import com.openshift.client.IGearProfile;
import com.openshift.client.IOpenShiftConnection;
import com.openshift.client.Messages;
import com.openshift.client.OpenShiftException;
import com.openshift.client.OpenShiftSSHOperationException;
import com.openshift.client.cartridge.IEmbeddableCartridge;
import com.openshift.client.cartridge.IEmbeddedCartridge;
import com.openshift.client.cartridge.IStandaloneCartridge;
import com.openshift.client.utils.HostUtils;
import com.openshift.client.utils.RFC822DateUtils;
import com.openshift.internal.client.response.ApplicationResourceDTO;
import com.openshift.internal.client.response.CartridgeResourceDTO;
import com.openshift.internal.client.response.GearGroupResourceDTO;
import com.openshift.internal.client.response.Link;
import com.openshift.internal.client.ssh.ApplicationPortForwarding;
import com.openshift.internal.client.utils.Assert;
import com.openshift.internal.client.utils.CollectionUtils;
import com.openshift.internal.client.utils.IOpenShiftJsonConstants;
/**
* The Class Application.
*
* @author André Dietisheim
*/
public class ApplicationResource extends AbstractOpenShiftResource implements IApplication {
private static final Logger LOGGER = LoggerFactory.getLogger(ApplicationResource.class);
private static final long APPLICATION_WAIT_RETRY_DELAY = 2 * 1024;
private static final String LINK_GET_APPLICATION = "GET";
private static final String LINK_DELETE_APPLICATION = "DELETE";
private static final String LINK_START_APPLICATION = "START";
private static final String LINK_STOP_APPLICATION = "STOP";
private static final String LINK_FORCE_STOP_APPLICATION = "FORCE_STOP";
private static final String LINK_RESTART_APPLICATION = "RESTART";
private static final String LINK_SCALE_UP = "SCALE_UP";
private static final String LINK_SCALE_DOWN = "SCALE_DOWN";
private static final String LINK_ADD_ALIAS = "ADD_ALIAS";
private static final String LINK_REMOVE_ALIAS = "REMOVE_ALIAS";
private static final String LINK_ADD_CARTRIDGE = "ADD_CARTRIDGE";
private static final String LINK_LIST_CARTRIDGES = "LIST_CARTRIDGES";
private static final String LINK_GET_GEAR_GROUPS = "GET_GEAR_GROUPS";
private static final Pattern REGEX_FORWARDED_PORT = Pattern.compile("([^ ]+) -> ([^:]+):(\\d+)");
/** The (unique) uuid of this application. */
private final String uuid;
/** The name of this application. */
private final String name;
/** The time at which this application was created. */
private final Date creationTime;
/** The cartridge (application type/framework) of this application. */
private final IStandaloneCartridge cartridge;
/** The scalability enablement. */
private final ApplicationScale scale;
/** The application gear profile. */
private final IGearProfile gearProfile;
/** The domain this application belongs to. */
private final DomainResource domain;
/** The url of this application. */
private final String applicationUrl;
/** The url at which the git repo of this application may be reached. */
private final String gitUrl;
/** the git url for the initial code and configuration for the application */
private final String initialGitUrl;
/** The aliases of this application. */
private final List aliases;
/**
* List of configured embedded cartridges. null means list if
* not loaded yet.
*/
// TODO: replace by a map indexed by cartridge names ?
private List embeddedCartridges = null;
/**
* SSH Fowardable ports for the current application.
*/
private List ports = null;
/**
* SSH Session used to perform port-forwarding and other ssh-based
* operations.
*/
private Session session;
private Map embeddedCartridgesInfos;
private Collection gearGroups;
/**
* Constructor...
*
* @param dto
* @param cartridge
* @param domain
*/
protected ApplicationResource(ApplicationResourceDTO dto, IStandaloneCartridge cartridge, DomainResource domain) {
this(dto.getName(), dto.getUuid(), dto.getCreationTime(), dto.getMessages(), dto.getApplicationUrl(),
dto.getGitUrl(), dto.getInitialGitUrl(), dto.getGearProfile(), dto.getGearGroups(),
dto.getApplicationScale(), cartridge, dto.getAliases(), dto.getEmbeddedCartridgeInfos(),
dto.getLinks(), domain);
}
/**
* Instantiates a new application.
*
* @param name
* the name
* @param uuid
* the uuid
* @param creationTime
* the creation time
* @param messages
* the creation log
* @param applicationUrl
* the application url
* @param gitUrl
* the git url
* @param cartridge
* the cartridge (type/framework)
* @param aliases
* the aliases
* @param links
* the links
* @param domain
* the domain this application belongs to
* @throws DatatypeConfigurationException
*/
protected ApplicationResource(final String name, final String uuid, final String creationTime,
final Messages messages, final String applicationUrl, final String gitUrl,
final String initialGitUrl, final IGearProfile gearProfile, final List gearGroups,
final ApplicationScale scale, final IStandaloneCartridge cartridge, final List aliases,
final Map embeddedCartridgesInfos, final Map links,
final DomainResource domain) {
super(domain.getService(), links, messages);
this.name = name;
this.uuid = uuid;
this.creationTime = RFC822DateUtils.safeGetDate(creationTime);
this.scale = scale;
this.gearProfile = gearProfile;
this.gearGroups = gearGroups;
this.cartridge = cartridge;
this.applicationUrl = applicationUrl;
this.gitUrl = gitUrl;
this.initialGitUrl = initialGitUrl;
this.domain = domain;
this.aliases = aliases;
// TODO: fix this workaround once
// https://bugzilla.redhat.com/show_bug.cgi?id=812046 is fixed
this.embeddedCartridgesInfos = embeddedCartridgesInfos;
}
public String getName() {
return name;
}
@Override
public ApplicationScale getApplicationScale() {
return scale;
}
@Override
public IGearProfile getGearProfile() {
return gearProfile;
}
public String getUUID() {
return uuid;
}
public IStandaloneCartridge getCartridge() {
return cartridge;
}
public Date getCreationTime() {
return creationTime;
}
public IDomain getDomain() {
return this.domain;
}
public void destroy() throws OpenShiftException {
new DeleteApplicationRequest().execute();
domain.removeApplication(this);
}
public void start() throws OpenShiftException {
new StartApplicationRequest().execute();
}
public void restart() throws OpenShiftException {
new RestartApplicationRequest().execute();
}
public void stop() throws OpenShiftException {
stop(false);
}
public void stop(boolean force) throws OpenShiftException {
if (force) {
new ForceStopApplicationRequest().execute();
} else {
new StopApplicationRequest().execute();
}
}
public void getDescriptor() {
throw new UnsupportedOperationException();
}
public void scaleDown() throws OpenShiftException {
new ScaleDownRequest().execute();
}
public void scaleUp() throws OpenShiftException {
new ScaleUpRequest().execute();
}
public void addAlias(String alias) throws OpenShiftException {
Assert.notNull(alias);
ApplicationResourceDTO applicationDTO = new AddAliasRequest().execute(alias);
updateAliases(applicationDTO);
}
private void updateAliases(ApplicationResourceDTO applicationDTO) {
Assert.notNull(applicationDTO);
this.aliases.clear();
this.aliases.addAll(applicationDTO.getAliases());
}
public List getAliases() {
return Collections.unmodifiableList(this.aliases);
}
public boolean hasAlias(String name) {
Assert.notNull(name);
return aliases.contains(name);
}
public void removeAlias(String alias) throws OpenShiftException {
Assert.notNull(alias);
ApplicationResourceDTO applicationDTO = new RemoveAliasRequest().execute(alias);
updateAliases(applicationDTO);
}
public String getGitUrl() {
return gitUrl;
}
public String getInitialGitUrl() {
return initialGitUrl;
}
public String getApplicationUrl() {
return applicationUrl;
}
/**
* Adds the given embedded cartridge to this application.
*
* @param cartridge
* the embeddable cartridge that shall be added to this
* application
*/
public IEmbeddedCartridge addEmbeddableCartridge(IEmbeddableCartridge cartridge) throws OpenShiftException {
Assert.notNull(cartridge);
if (this.embeddedCartridges == null) {
loadEmbeddedCartridges();
}
final CartridgeResourceDTO embeddedCartridgeDTO =
new AddEmbeddedCartridgeRequest().execute(cartridge.getName());
final EmbeddedCartridgeResource embeddedCartridge =
new EmbeddedCartridgeResource(
embeddedCartridgesInfos.get(embeddedCartridgeDTO.getName()),
embeddedCartridgeDTO, this);
this.embeddedCartridges.add(embeddedCartridge);
return embeddedCartridge;
}
public List addEmbeddableCartridges(Collection cartridges)
throws OpenShiftException {
Assert.notNull(cartridges);
final List addedCartridge = new ArrayList();
for (IEmbeddableCartridge cartridge : cartridges) {
// TODO: catch exceptions when removing cartridges, contine removing
// and report the exceptions that occurred
addedCartridge.add(addEmbeddableCartridge(cartridge));
}
return addedCartridge;
}
/**
* "callback" from the embeddedCartridge once it has been destroyed.
*
* @param embeddedCartridge
* @throws OpenShiftException
*/
protected void removeEmbeddedCartridge(IEmbeddedCartridge embeddedCartridge) throws OpenShiftException {
Assert.notNull(embeddedCartridge);
this.embeddedCartridges.remove(embeddedCartridge);
}
private List loadEmbeddedCartridges() throws OpenShiftException {
// load collection if necessary
this.embeddedCartridges = new ArrayList();
List cartridgeDTOs = new ListEmbeddableCartridgesRequest().execute();
for (CartridgeResourceDTO cartridgeDTO : cartridgeDTOs) {
if (cartridgeDTO.getType() != CartridgeType.EMBEDDED) {
continue;
}
IEmbeddedCartridge embeddableCartridge =
new EmbeddedCartridgeResource(
embeddedCartridgesInfos.get(cartridgeDTO.getName()),
cartridgeDTO, this);
embeddedCartridges.add(embeddableCartridge);
}
return embeddedCartridges;
}
public List getEmbeddedCartridges() throws OpenShiftException {
if (this.embeddedCartridges == null) {
this.embeddedCartridges = loadEmbeddedCartridges();
}
return CollectionUtils.toUnmodifiableCopy(this.embeddedCartridges);
}
public boolean hasEmbeddedCartridge(String cartridgeName) throws OpenShiftException {
Assert.notNull(cartridgeName);
return getEmbeddedCartridge(cartridgeName) != null;
}
public boolean hasEmbeddedCartridge(IEmbeddableCartridge cartridge) throws OpenShiftException {
return getEmbeddedCartridge(cartridge) != null;
}
public IEmbeddedCartridge getEmbeddedCartridge(IEmbeddableCartridge cartridge) throws OpenShiftException {
Assert.notNull(cartridge);
return getEmbeddedCartridge(cartridge.getName());
}
public IEmbeddedCartridge getEmbeddedCartridge(String cartridgeName) throws OpenShiftException {
Assert.notNull(cartridgeName);
for (IEmbeddedCartridge embeddedCartridge : getEmbeddedCartridges()) {
if (cartridgeName.equals(embeddedCartridge.getName())) {
return embeddedCartridge;
}
}
return null;
}
public void removeEmbeddedCartridge(IEmbeddableCartridge cartridge) throws OpenShiftException {
Assert.notNull(cartridge);
IEmbeddedCartridge embeddedCartridge = getEmbeddedCartridge(cartridge);
if (embeddedCartridge != null) {
embeddedCartridge.destroy();
}
}
public void removeEmbeddedCartridges(Collection cartridges) throws OpenShiftException {
Assert.notNull(cartridges);
for(IEmbeddableCartridge cartridge : cartridges) {
// TODO: catch exceptions when removing cartridges, contine removing
// and report the exceptions that occurred
removeEmbeddedCartridge(cartridge);
}
}
public Collection getGearGroups() throws OpenShiftException {
if (gearGroups == null) {
loadGearGroups();
}
return gearGroups;
}
private Collection loadGearGroups() throws OpenShiftException {
List gearGroups = new ArrayList();
Collection dtos = new GetGearGroupsRequest().execute();
for(GearGroupResourceDTO dto : dtos) {
gearGroups.add(new GearGroupResource(dto, getService()));
}
return this.gearGroups = gearGroups;
}
public boolean waitForAccessible(long timeout) throws OpenShiftException {
try {
return waitForResolved(timeout, System.currentTimeMillis());
} catch (InterruptedException e) {
return false;
}
}
public Future waitForAccessibleAsync(final long timeout) throws OpenShiftException {
IOpenShiftConnection connection = getConnection();
return connection.getExecutorService().submit(new Callable() {
public Boolean call() throws Exception {
return waitForAccessible(timeout);
}
});
}
protected IOpenShiftConnection getConnection() {
return getDomain().getUser().getConnection();
}
private boolean waitForResolved(long timeout, long startTime) throws OpenShiftException, InterruptedException {
try {
while (!canResolv(applicationUrl)
&& !isTimeouted(timeout, startTime)) {
Thread.sleep(APPLICATION_WAIT_RETRY_DELAY);
}
return canResolv(applicationUrl);
} catch (MalformedURLException e) {
throw new OpenShiftException(e,
"Could not wait for application {0} to become accessible, it has an invalid URL \"{1}\": {2}",
name, applicationUrl, e.getMessage());
}
}
protected boolean canResolv(String url) throws MalformedURLException {
return HostUtils.canResolv(url);
}
private boolean isTimeouted(long timeout, long startTime) {
return !(System.currentTimeMillis() < (startTime + timeout));
}
public void refresh() throws OpenShiftException {
if (this.embeddedCartridges != null) {
this.embeddedCartridges = loadEmbeddedCartridges();
}
if (this.gearGroups != null) {
this.gearGroups = loadGearGroups();
}
if (this.ports != null) {
this.ports = loadPorts();
}
}
public void setSSHSession(final Session session) {
this.session = session;
}
public Session getSSHSession() {
return this.session;
}
public boolean hasSSHSession() {
return this.session != null && this.session.isConnected();
}
public boolean isPortFowardingStarted() throws OpenShiftSSHOperationException {
try {
return this.session != null && this.session.isConnected() && this.session.getPortForwardingL().length > 0;
} catch (JSchException e) {
throw new OpenShiftSSHOperationException(e,
"Unable to verify if port-forwarding has been started for application \"{0}\"", this.getName());
}
}
public List refreshForwardablePorts() throws OpenShiftSSHOperationException {
this.ports = loadPorts();
return this.ports;
}
public List getForwardablePorts() throws OpenShiftSSHOperationException {
if (ports == null) {
this.ports = loadPorts();
}
return ports;
}
@Override
public List getEnvironmentProperties() throws OpenShiftSSHOperationException {
List openshiftProps = new ArrayList();
List allEnvProps = sshExecCmd("set", SshStreams.INPUT);
for (String line : allEnvProps) {
if (line.startsWith("OPENSHIFT_") || line.startsWith("JENKINS_")) {
openshiftProps.add(line);
}
}
return openshiftProps;
}
/**
* List all forwardable ports for a given application.
*
* @param application
* @return the forwardable ports in an unmodifiable collection
* @throws JSchException
* @throws OpenShiftSSHOperationException
*/
private List loadPorts() throws OpenShiftSSHOperationException {
this.ports = new ArrayList();
List lines = sshExecCmd("rhc-list-ports", SshStreams.EXT_INPUT);
for (String line : lines) {
ApplicationPortForwarding port = extractForwardablePortFrom(line);
if (port != null) {
ports.add(port);
}
}
return ports;
}
/**
*
* @param command
* @return
* @throws OpenShiftSSHOperationException
*/
protected List sshExecCmd(final String command, final SshStreams sshStream)
throws OpenShiftSSHOperationException {
final Session session = getSSHSession();
if (session == null) {
throw new OpenShiftSSHOperationException("No SSH session available for application ''{0}''", this.getName());
}
Channel channel = null;
BufferedReader reader = null;
try {
session.openChannel("exec");
channel = session.openChannel("exec");
((ChannelExec) channel).setCommand(command);
channel.connect();
return sshStream.getLines(channel);
} catch (JSchException e) {
throw new OpenShiftSSHOperationException(e, "Failed to list forwardable ports for application \"{0}\"",
this.getName());
} catch (IOException e) {
throw new OpenShiftSSHOperationException(e, "Failed to list forwardable ports for application \"{0}\"",
this.getName());
} finally {
if (reader != null) {
try {
reader.close();
} catch (IOException e) {
LOGGER.error("Failed to close SSH error stream reader", e);
}
}
if (channel != null && channel.isConnected()) {
channel.disconnect();
}
}
}
/**
* Extract the named forwardable port from the 'rhc-list-ports' command
* result line, with the following format:
* java -> 127.10.187.1:4447.
*
* @param portValue
* @return the forwardable port.
*/
private ApplicationPortForwarding extractForwardablePortFrom(final String portValue) {
Matcher matcher = REGEX_FORWARDED_PORT.matcher(portValue);
if (!matcher.find()
|| matcher.groupCount() != 3) {
return null;
}
try {
final String name = matcher.group(1);
final String host = matcher.group(2);
final int remotePort = Integer.parseInt(matcher.group(3));
return new ApplicationPortForwarding(this, name, host, remotePort);
} catch(NumberFormatException e) {
throw new OpenShiftSSHOperationException(e,
"Couild not determine forwarded port in application {0}", getName());
}
}
public List startPortForwarding() throws OpenShiftSSHOperationException {
if (!hasSSHSession()) {
throw new OpenShiftSSHOperationException(
"SSH session for application \"{0}\" is closed or null. Cannot start port forwarding",
getName());
}
for (IApplicationPortForwarding port : ports) {
try {
port.start(session);
} catch (OpenShiftSSHOperationException oss) {
// ignore for now
// FIXME: should store this error on the forward to let user
// know why it could not start/stop
}
}
return ports;
}
public List stopPortForwarding() throws OpenShiftSSHOperationException {
for (IApplicationPortForwarding port : ports) {
try {
port.stop(session);
} catch (OpenShiftSSHOperationException oss) {
// ignore for now
// should store this error on the forward to let user know why
// it could not start/stop
}
}
// make sure port forwarding is stopped by closing session...
session.disconnect();
return ports;
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((name == null) ? 0 : name.hashCode());
return result;
}
@Override
public boolean equals(Object object) {
if (this == object)
return true;
if (object == null)
return false;
if (getClass() != object.getClass())
return false;
ApplicationResource other = (ApplicationResource) object;
if (name == null) {
if (other.name != null)
return false;
} else if (!name.equals(other.name))
return false;
return true;
}
@Override
public String toString() {
return name;
}
protected enum SshStreams {
EXT_INPUT {
protected InputStream getInputStream(Channel channel) throws IOException {
return channel.getExtInputStream();
}
}, INPUT {
protected InputStream getInputStream(Channel channel) throws IOException {
return channel.getInputStream();
}
};
public List getLines(Channel channel) throws IOException {
BufferedReader reader = new BufferedReader(new InputStreamReader(getInputStream(channel)));
List lines = new ArrayList();
String line = null;
// Read File Line By Line
while ((line = reader.readLine()) != null) {
lines.add(line);
}
return lines;
}
protected abstract InputStream getInputStream(Channel channel) throws IOException;
}
private class RefreshApplicationRequest extends ServiceRequest {
protected RefreshApplicationRequest() {
super(LINK_GET_APPLICATION);
}
}
private class DeleteApplicationRequest extends ServiceRequest {
protected DeleteApplicationRequest() {
super(LINK_DELETE_APPLICATION);
}
}
private class StartApplicationRequest extends ServiceRequest {
protected StartApplicationRequest() {
super(LINK_START_APPLICATION);
}
public DTO execute() throws OpenShiftException {
return super.execute(new ServiceParameter(IOpenShiftJsonConstants.PROPERTY_EVENT,
IOpenShiftJsonConstants.VALUE_START));
}
}
private class StopApplicationRequest extends ServiceRequest {
protected StopApplicationRequest() {
super(LINK_STOP_APPLICATION);
}
public DTO execute() throws OpenShiftException {
return super.execute(new ServiceParameter(IOpenShiftJsonConstants.PROPERTY_EVENT,
IOpenShiftJsonConstants.VALUE_STOP));
}
}
private class ForceStopApplicationRequest extends ServiceRequest {
protected ForceStopApplicationRequest() {
super(LINK_FORCE_STOP_APPLICATION);
}
public DTO execute() throws OpenShiftException {
return super.execute(new ServiceParameter(IOpenShiftJsonConstants.PROPERTY_EVENT,
IOpenShiftJsonConstants.VALUE_FORCESTOP));
}
}
private class RestartApplicationRequest extends ServiceRequest {
protected RestartApplicationRequest() {
super(LINK_RESTART_APPLICATION);
}
public DTO execute() throws OpenShiftException {
return super.execute(new ServiceParameter(IOpenShiftJsonConstants.PROPERTY_EVENT,
IOpenShiftJsonConstants.VALUE_RESTART));
}
}
private class ScaleUpRequest extends ServiceRequest {
protected ScaleUpRequest() {
super(LINK_SCALE_UP);
}
public DTO execute() throws OpenShiftException {
return super.execute(new ServiceParameter(IOpenShiftJsonConstants.PROPERTY_EVENT,
IOpenShiftJsonConstants.VALUE_SCALE_UP));
}
}
private class ScaleDownRequest extends ServiceRequest {
protected ScaleDownRequest() {
super(LINK_SCALE_DOWN);
}
public DTO execute() throws OpenShiftException {
return super.execute(new ServiceParameter(IOpenShiftJsonConstants.PROPERTY_EVENT,
IOpenShiftJsonConstants.VALUE_SCALE_DOWN));
}
}
private class AddAliasRequest extends ServiceRequest {
protected AddAliasRequest() {
super(LINK_ADD_ALIAS);
}
public DTO execute(String alias) throws OpenShiftException {
return super.execute(new ServiceParameter(IOpenShiftJsonConstants.PROPERTY_EVENT,
IOpenShiftJsonConstants.VALUE_ADD_ALIAS), new ServiceParameter(
IOpenShiftJsonConstants.PROPERTY_ALIAS, alias));
}
}
private class RemoveAliasRequest extends ServiceRequest {
protected RemoveAliasRequest() {
super(LINK_REMOVE_ALIAS);
}
public DTO execute(String alias) throws OpenShiftException {
return super.execute(new ServiceParameter(IOpenShiftJsonConstants.PROPERTY_EVENT,
IOpenShiftJsonConstants.VALUE_REMOVE_ALIAS), new ServiceParameter(
IOpenShiftJsonConstants.PROPERTY_ALIAS, alias));
}
}
private class AddEmbeddedCartridgeRequest extends ServiceRequest {
protected AddEmbeddedCartridgeRequest() {
super(LINK_ADD_CARTRIDGE);
}
public DTO execute(String embeddedCartridgeName) throws OpenShiftException {
return super
.execute(new ServiceParameter(IOpenShiftJsonConstants.PROPERTY_NAME, embeddedCartridgeName));
}
}
private class ListEmbeddableCartridgesRequest extends ServiceRequest {
protected ListEmbeddableCartridgesRequest() {
super(LINK_LIST_CARTRIDGES);
}
}
private class GetGearGroupsRequest extends ServiceRequest {
protected GetGearGroupsRequest() {
super(LINK_GET_GEAR_GROUPS);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy