com.openshift.internal.client

Class ApplicationSSHSession

java.lang.Object

com.openshift.internal.client.ApplicationSSHSession

All Implemented Interfaces:

IApplicationSSHSession

public class ApplicationSSHSession
extends Object
implements IApplicationSSHSession

Author:

Xavier Coulon, André Dietisheim, Corey Daley

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ApplicationSSHSession.AbstractSnapshotSshCommand
class	ApplicationSSHSession.AbstractSnapshotType
protected static class	ApplicationSSHSession.SshCommandResponse

Constructor Summary

Constructors

Constructor and Description
ApplicationSSHSession(IApplication application, com.jcraft.jsch.Session session) Sets the SSH session that this application will use to connect to OpenShift to perform some operations.

Method Summary

Modifier and Type	Method and Description
protected void	assertLiveSSHSession()
boolean	equals(Object object)
protected InputStream	execCommand(String command, com.openshift.internal.client.ApplicationSSHSession.ChannelInputStreams factory, com.jcraft.jsch.Session session)
protected InputStream	execCommand(String command, InputStream forStdIn, com.openshift.internal.client.ApplicationSSHSession.ChannelInputStreams channelInputStream, com.jcraft.jsch.Session session)
IApplication	getApplication() Get the application associated with this ApplicationSSHSession
List<String>	getEnvironmentProperties() Get a list of properties from your OpenShift Application
List<IApplicationPortForwarding>	getForwardablePorts() Gets a list of forwardable ports for your application
boolean	isConnected() Check if the current SSH session is connected
boolean	isPortFowardingStarted() Check if port forwarding has been started
void	refresh() Refreshes the list of forwardable ports
List<IApplicationPortForwarding>	refreshForwardablePorts() Refresh the list of forwardable ports for an application
InputStream	restoreDeploymentSnapshot(InputStream inputStream, boolean hotDeploy) Restores the given snapshot to the application that this session is bound to.
InputStream	restoreFullSnapshot(InputStream inputStream)
InputStream	restoreFullSnapshot(InputStream inputStream, boolean includeGit) Restores the given full snapshot to the application that this session is bound to.
InputStream	saveDeploymentSnapshot()
InputStream	saveFullSnapshot()
void	setSSHSession(com.jcraft.jsch.Session session) Set the current SSH session
List<IApplicationPortForwarding>	startPortForwarding() Start forwarding available ports to this application
List<IApplicationPortForwarding>	stopPortForwarding() Stop forwarding of all ports to this application
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ApplicationSSHSession

public ApplicationSSHSession(IApplication application,
                             com.jcraft.jsch.Session session)

Sets the SSH session that this application will use to connect to OpenShift to perform some operations. This SSH session must be initialized out of the library, since the user's SSH settings may depend on the runtime environment (Eclipse, etc.).

Parameters:

application - The application that this SSH session is connecting to

session - The SSH session that is connected to the application

Method Detail

setSSHSession

public void setSSHSession(com.jcraft.jsch.Session session)

Set the current SSH session

Specified by:

setSSHSession in interface IApplicationSSHSession

Parameters:

session - A new SSH session to use for the ApplicationSSHSession object

getApplication

public IApplication getApplication()

Get the application associated with this ApplicationSSHSession

Returns:

The application associated with this ssh session

isConnected

public boolean isConnected()

Check if the current SSH session is connected

Specified by:

isConnected in interface IApplicationSSHSession

Returns:

True if the SSH session is connected

isPortFowardingStarted

public boolean isPortFowardingStarted()
                               throws OpenShiftSSHOperationException

Check if port forwarding has been started

Specified by:

isPortFowardingStarted in interface IApplicationSSHSession

Returns:

true if port forwarding is started, false otherwise

Throws:

OpenShiftSSHOperationException

startPortForwarding

public List<IApplicationPortForwarding> startPortForwarding()
                                                     throws OpenShiftSSHOperationException

Start forwarding available ports to this application

Specified by:

startPortForwarding in interface IApplicationSSHSession

Returns:

Current list of ports

Throws:

OpenShiftSSHOperationException

stopPortForwarding

public List<IApplicationPortForwarding> stopPortForwarding()
                                                    throws OpenShiftSSHOperationException

Stop forwarding of all ports to this application

Specified by:

stopPortForwarding in interface IApplicationSSHSession

Returns:

The current list of ports

Throws:

OpenShiftSSHOperationException

refreshForwardablePorts

public List<IApplicationPortForwarding> refreshForwardablePorts()
                                                         throws OpenShiftSSHOperationException

Refresh the list of forwardable ports for an application

Specified by:

refreshForwardablePorts in interface IApplicationSSHSession

Returns:

List of forwardable ports for your application

Throws:

OpenShiftSSHOperationException

getForwardablePorts

public List<IApplicationPortForwarding> getForwardablePorts()
                                                     throws OpenShiftSSHOperationException

Gets a list of forwardable ports for your application

Specified by:

getForwardablePorts in interface IApplicationSSHSession

Returns:

List of forwardable ports for your application

Throws:

OpenShiftSSHOperationException

getEnvironmentProperties

public List<String> getEnvironmentProperties()
                                      throws OpenShiftSSHOperationException

Get a list of properties from your OpenShift Application

Specified by:

getEnvironmentProperties in interface IApplicationSSHSession

Returns:

List of properties from your OpenShift application

Throws:

OpenShiftSSHOperationException

saveFullSnapshot

public InputStream saveFullSnapshot()

restoreFullSnapshot

public InputStream restoreFullSnapshot(InputStream inputStream)

restoreFullSnapshot

public InputStream restoreFullSnapshot(InputStream inputStream,
                                       boolean includeGit)

Restores the given full snapshot to the application that this session is bound to. Providing true for includeGit will also activate the snapshot (and having the page reflecting the changes in the snapshot). It only works though if the snapshot has a /git/ folder with content.

Parameters:

inputStream - the snapshot

includeGit - will activate the new snapshot given the snapshot includes a /git folder

Returns:

See Also:

TarFileUtils.hasGitFolder(InputStream), saveFullSnapshot()

saveDeploymentSnapshot

public InputStream saveDeploymentSnapshot()

restoreDeploymentSnapshot

public InputStream restoreDeploymentSnapshot(InputStream inputStream,
                                             boolean hotDeploy)
                                      throws OpenShiftException

Restores the given snapshot to the application that this session is bound to.

Parameters:

inputStream - the snapshot

hotDeploy - will not restart the application if true

Returns:

Throws:

OpenShiftException

See Also:

saveDeploymentSnapshot()

refresh

public void refresh()
             throws OpenShiftException

Refreshes the list of forwardable ports

Throws:

OpenShiftException

equals

public boolean equals(Object object)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

assertLiveSSHSession

protected void assertLiveSSHSession()

execCommand

protected InputStream execCommand(String command,
                                  com.openshift.internal.client.ApplicationSSHSession.ChannelInputStreams factory,
                                  com.jcraft.jsch.Session session)
                           throws OpenShiftSSHOperationException

Throws:

OpenShiftSSHOperationException

execCommand

protected InputStream execCommand(String command,
                                  InputStream forStdIn,
                                  com.openshift.internal.client.ApplicationSSHSession.ChannelInputStreams channelInputStream,
                                  com.jcraft.jsch.Session session)
                           throws OpenShiftSSHOperationException

Parameters:

command - The remote command to run on the server

sshMsgChannelData -

sshStream - The ssh stream to use

Returns:

The output of the command that is run on the server

Throws:

OpenShiftSSHOperationException