net.sf.sshapi.util

Class Util

java.lang.Object

net.sf.sshapi.util.Util

public class Util
extends java.lang.Object

Various utilities

Field Summary

Fields

Modifier and Type	Field and Description
static int	S_IFMT Permissions flag: Format mask constant can be used to mask off a file type from the mode.
static int	S_ISGID Permissions flag: Bit to determine whether a file is executed as the group owner
static int	S_ISUID Permissions flag: Bit to determine whether a file is executed as the owner

Constructor Summary

Constructors

Constructor and Description
Util()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	basename(java.lang.String path) Get the file portion of a path, i.e the part after the last /.
static void	checkKnownHostsFile(SshConfiguration configuration) Check the Known Hosts File parent directory exists, creating it if it does.
static java.lang.String	concatenatePaths(java.lang.String path, java.lang.String filename) Concatenate two paths, removing any additional leading/trailing slashes.
static boolean	delTree(java.io.File file) Recursively delete a file and all of it's children.
static java.lang.String	dirname(java.lang.String remotePath) Get the directory portion of a file path.
static java.lang.String	escape(java.lang.String string, char what, java.lang.String with) Process a string, replacing a specified character with another string.
static java.lang.String	formatAsHexString(byte[] arr) Format a byte array as a hex string.
static java.lang.String	getConfigurationValue(SshConfiguration configuration, java.lang.String name, java.lang.String defaultValue) Get a value from a configuration object, returning a default value if it does not exist.
static java.io.File	getKnownHostsFile(SshConfiguration configuration) Get the file to load known host keys from given an SshConfiguration.
static java.lang.String	getMaskString(int permissions) Return the UNIX style mode mask
static java.lang.String	getPermissionsString(int type, long permissions) Returns a formatted permissions string.
static java.lang.String	guessKeyType(byte[] key) Guess the type of
static void	joinStreams(java.io.InputStream in, java.io.OutputStream out) Copy bytes read from an input stream to an output stream, until the end of the input stream is reached.
static boolean	nullOrTrimmedBlank(java.lang.String string) Return an empty string if null, or a string with spaces trimmed from the beginning and end if not null.
static byte[]	parseHexString(java.lang.String string) Parse a string of bytes encoded as hexadecimal values.
static long[]	parsePermissionsString(java.lang.String perm) Parse a formatted permissions string.
static java.lang.String	prompt(java.lang.String message) Prompt for an answer on the console
static java.lang.String	prompt(java.lang.String message, java.lang.String defaultValue) Display a prompt on the console and wait for an answer.
static boolean	promptYesNo(java.lang.String message) Prompt for a yes / no answer on the console
static java.lang.String	toDelimited(java.lang.String[] arr, char delimiter) Convert a string array into a delimited string.

Methods inherited from class java.lang.Object

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

Field Detail

S_IFMT

public static final int S_IFMT

Permissions flag: Format mask constant can be used to mask off a file type from the mode.

See Also:

Constant Field Values

S_ISUID

public static final int S_ISUID

Permissions flag: Bit to determine whether a file is executed as the owner

See Also:

Constant Field Values

S_ISGID

public static final int S_ISGID

Permissions flag: Bit to determine whether a file is executed as the group owner

See Also:

Constant Field Values

Constructor Detail

Util

public Util()

Method Detail

toDelimited

public static java.lang.String toDelimited(java.lang.String[] arr,
                                           char delimiter)

Convert a string array into a delimited string.

Parameters:

arr - array of strings

delimiter - delimiter

Returns:

delimited string

promptYesNo

public static boolean promptYesNo(java.lang.String message)

Prompt for a yes / no answer on the console

Parameters:

message - message to display

Returns:

answer (true for yes)

prompt

public static java.lang.String prompt(java.lang.String message)

Prompt for an answer on the console

Parameters:

message - message to display

Returns:

answer

formatAsHexString

public static java.lang.String formatAsHexString(byte[] arr)

Format a byte array as a hex string.

Parameters:

arr - byte array

Returns:

hex string

prompt

public static java.lang.String prompt(java.lang.String message,
                                      java.lang.String defaultValue)

Display a prompt on the console and wait for an answer.

Parameters:

message - message to display to use

defaultValue - value to return if user just presses RETURN

Returns:

user input

basename

public static java.lang.String basename(java.lang.String path)

Get the file portion of a path, i.e the part after the last /. If the provided path ends with a /, this is stripped first.

Parameters:

path - path

Returns:

file basename

concatenatePaths

public static java.lang.String concatenatePaths(java.lang.String path,
                                                java.lang.String filename)

Concatenate two paths, removing any additional leading/trailing slashes.

Parameters:

path - first path portion

filename - path to append

Returns:

concatenated path

parseHexString

public static byte[] parseHexString(java.lang.String string)

Parse a string of bytes encoded as hexadecimal values. Each byte is represented by two characters.

Parameters:

string - hex string

Returns:

data

joinStreams

public static void joinStreams(java.io.InputStream in,
                               java.io.OutputStream out)
                        throws java.io.IOException

Copy bytes read from an input stream to an output stream, until the end of the input stream is reached.

Parameters:

in - input stream

out - output stream

Throws:

java.io.IOException

nullOrTrimmedBlank

public static boolean nullOrTrimmedBlank(java.lang.String string)

Return an empty string if null, or a string with spaces trimmed from the beginning and end if not null.

Parameters:

string -

Returns:

null or trimmed blank string

getConfigurationValue

public static java.lang.String getConfigurationValue(SshConfiguration configuration,
                                                     java.lang.String name,
                                                     java.lang.String defaultValue)

Get a value from a configuration object, returning a default value if it does not exist. This method will also look for the same property in the current system properties.

Parameters:

configuration - configuration object

name - name of configuration

defaultValue -

Returns:

value

getKnownHostsFile

public static java.io.File getKnownHostsFile(SshConfiguration configuration)
                                      throws SshException

Get the file to load known host keys from given an SshConfiguration.

Parameters:

configuration -

Returns:

file to load known hosts from

Throws:

SshException

delTree

public static boolean delTree(java.io.File file)

Recursively delete a file and all of it's children. It should go without saying, use with care!

Parameters:

file - file to delete

Returns:

file deleted OK.

escape

public static java.lang.String escape(java.lang.String string,
                                      char what,
                                      java.lang.String with)

Process a string, replacing a specified character with another string.

Parameters:

string - string to replace

what - character to replace

with - string to replace character with

Returns:

escaped string

dirname

public static java.lang.String dirname(java.lang.String remotePath)

Get the directory portion of a file path. The path should NOT contain a trailing slash, and root ("/") will return an empty string.

Parameters:

remotePath - path

Returns:

directory portion of path.

getPermissionsString

public static java.lang.String getPermissionsString(int type,
                                                    long permissions)

Returns a formatted permissions string. The file type is one of SftpFile.TYPES.

Parameters:

type -

permissions - permissions

Returns:

permissions string

parsePermissionsString

public static long[] parsePermissionsString(java.lang.String perm)

Parse a formatted permissions string. The file type is one of SftpFile.TYPES.

Parameters:

permissions - permissions string

Returns:

type in first element, permissions in secon

getMaskString

public static java.lang.String getMaskString(int permissions)

Return the UNIX style mode mask

Parameters:

permissions - permissions

Returns:

mask

guessKeyType

public static java.lang.String guessKeyType(byte[] key)

Guess the type of

Parameters:

key -

key - type

Returns:

one of @SshConfiguration.PUBLIC_KEY_SSHDSA or @ SshConfiguration.PUBLIC_KEY_SSHRSA

checkKnownHostsFile

public static void checkKnownHostsFile(SshConfiguration configuration)
                                throws SshException

Check the Known Hosts File parent directory exists, creating it if it does.

Parameters:

configuration -

Throws:

SshException