brooklyn.util.internal.ssh
[Java] Class SshjTool

java.lang.Object
  brooklyn.util.internal.ssh.SshjTool

All Implemented Interfaces:

SshTool

public class SshjTool

Licensed to jclouds, Inc. (jclouds) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. jclouds 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.

SshjTool

public java.lang.Object SshjTool(java.util.Map map)

acquire

protected java.lang.Object acquire(C connection)

allocatePTY

protected void allocatePTY(Session s)

builder

public static SshjTool.Builder builder()

connect

@Override
public void connect()

connect

@Override
public void connect(int maxAttempts)

copyToServer

@Override
public int copyToServer(java.util.Map props, java.io.File f, java.lang.String pathAndFileOnRemoteServer)

createFile

@Override
public int createFile(java.util.Map props, java.lang.String pathAndFileOnRemoteServer, java.io.InputStream input, long size)

createFile

@Override
public int createFile(java.util.Map props, java.lang.String pathAndFileOnRemoteServer, java.lang.String contents)

Creates the given file with the given contents. Permissions specified using 'permissions:0755'.

createFile

@Override
public int createFile(java.util.Map props, java.lang.String pathAndFileOnRemoteServer, byte[] contents)

Creates the given file with the given contents. Permissions specified using 'permissions:0755'.

disconnect

@Override
public void disconnect()

execCommands

@Override
public int execCommands(java.util.Map props, java.util.List commands)

execCommands

@Override
public int execCommands(java.util.Map props, java.util.List commands, java.util.Map env)

execScript

@Override
public int execScript(java.util.Map props, java.util.List commands)

execScript

@Override
public int execScript(java.util.Map props, java.util.List commands, java.util.Map env)

This creates a script containing the user's commands, copies it to the remote server, and executes the script. The script is then deleted.

Executing commands directly is fraught with dangers! Here are other options, and their problems:

• Use execCommands, rather than shell. The user's environment will not be setup normally (e.g. ~/.bash_profile will not have been sourced) so things like wget may not be on the PATH.
• Send the stream of commands to the shell. But characters being sent can be lost. Try the following (e.g. in an OS X terminal): - sleep 5 - Only the first 1024 characters appear. The rest are lost. If sending a stream of commands, you need to be careful not send the next (big) command while the previous one is still executing.
• Send a stream to the shell, but spot when the previous command has completed. e.g. by looking for the prompt (but what if the commands being executed change the prompt?) e.g. by putting every second command as "echo ", and waiting for the stdout. This gets fiddly...

So on balance, the script-based approach seems most reliable, even if there is an overhead of separate message(s) for copying the file!

execShell

public int execShell(java.util.Map props, java.util.List commands)

execShell

public int execShell(java.util.Map props, java.util.List commands, java.util.Map env)

execShellDirect

public int execShellDirect(java.util.Map props, java.util.List commands, java.util.Map env)

getHostAddress

public java.lang.String getHostAddress()

getUsername

public java.lang.String getUsername()

isConnected

@Override
public boolean isConnected()

newSessionAction

protected SshjTool.SshAction newSessionAction()

toString

@Override
public java.lang.String toString()

transferFileFrom

@Override
public int transferFileFrom(java.util.Map props, java.lang.String pathAndFileOnRemoteServer, java.lang.String pathAndFileOnLocalServer)

transferFileTo

@Override
public int transferFileTo(java.util.Map props, java.io.InputStream input, java.lang.String pathAndFileOnRemoteServer)

Brooklyn Multi-Cloud Application Management Platform
brooklyncentral.github.com. Apache License. © 2012.