edu.illinois.ncsa.isda.softwareserver

Class SoftwareServerUtility

java.lang.Object

edu.illinois.ncsa.isda.softwareserver.SoftwareServerUtility

public class SoftwareServerUtility
extends Object

Utility functions.

Author:

Kenton McHenry

Constructor Summary

Constructors

Constructor and Description
SoftwareServerUtility()

Method Summary

Methods

Modifier and Type	Method and Description
static String	addAuthentication(String url, String authentication) Add authentication to a URL.
static void	deleteStoreFiles(String parent_folder, int session, String logfilename) Delete temporary files for a session under parent_folder session temporary files' names start with "sessionid_" session log is ".session_" + session + ".log"
static String	executeAndWait(String command, int max_runtime) Execute the given command.
static String	executeAndWait(String command, int max_runtime, boolean HANDLE_OUTPUT, boolean SHOW_OUTPUT) Execute the given command.
static boolean	existsURL_bak(String url) Deprecated.
static boolean	existsURL(String url) Check if the specified URL exists.
static long	getFileSize(String filename) Get the size of a local or remote file.
static String	getFileSizeHR(String filename) Get the size of a local or remote file in a human readable form.
static String	getTimeStamp() Get the current date and time (useful for logs, is thread safe).
static String	humanReadableBytes(long bytes) Get bytes in human readable form.
static void	main(String[] args) A main for debug purposes.
static String	postFile(String url, String filename) Post a file to a URL.
static String	postFile(String url, String filename, String type, String auth) Post a file to a URL.
static void	print(String string, String filename) Append a string to a file.
static void	println(String string, String filename) Append a line to a file.
static String	readURL(String url) Read the contents of the specified URL and store it in a string.
static String	readURL(String url, String type) Read the contents of the specified URL and store it in a string.
static String	removeCredentials(String url_str) Remove credentials in the url string, like username:passwd
static void	setDefaultAuthentication(String authentication) Set default authentication for HTTP requests.
static void	unzip(String path, String filename) Unzip a zip file into the given path.
static void	zip(String output, String file) Zip a file or directory.
static void	zip(String output, Vector<String> files) Zip a given set of files.
static void	zip(ZipOutputStream outs, String path, String filename) Add a file to the given zip file output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

SoftwareServerUtility

public SoftwareServerUtility()

Method Detail

removeCredentials

public static String removeCredentials(String url_str)

Remove credentials in the url string, like username:passwd

Parameters:

url_str - url string

Returns:

url string without username:passwd

deleteStoreFiles

public static void deleteStoreFiles(String parent_folder,
                    int session,
                    String logfilename)

Delete temporary files for a session under parent_folder session temporary files' names start with "sessionid_" session log is ".session_" + session + ".log"

Parameters:

parent_folder - folder contains session generated temporary files

session - session id

logfilename - associated log filename

existsURL_bak

@Deprecated
public static boolean existsURL_bak(String url)

Deprecated.

Check if the specified URL exists.

Parameters:

url - the URL to check

Returns:

true if the URL exists

existsURL

public static boolean existsURL(String url)

Check if the specified URL exists.

Parameters:

url - the URL to check

Returns:

true if the URL exists

readURL

public static String readURL(String url,
             String type)

Read the contents of the specified URL and store it in a string.

Parameters:

url - the URL to read

type - the accepted content type

Returns:

a string containing the URL contents

readURL

public static String readURL(String url)

Read the contents of the specified URL and store it in a string.

Parameters:

url - the URL to read

Returns:

a string containing the URL contents

postFile

public static String postFile(String url,
              String filename,
              String type,
              String auth)

Post a file to a URL.

Parameters:

url - the URL to post to

filename - the name of the file to post

type - the accepted content type

auth - the authentication to use (e.g. user:password, null)

Returns:

a string the resulting URL contents

postFile

public static String postFile(String url,
              String filename)

Post a file to a URL.

Parameters:

url - the URL to post to

filename - the name of the file to post

Returns:

a string the resulting URL contents

getFileSize

public static long getFileSize(String filename)

Get the size of a local or remote file.

Parameters:

filename - the file name or URL

Returns:

the size of the file

humanReadableBytes

public static String humanReadableBytes(long bytes)

Get bytes in human readable form.

Parameters:

bytes - the number of bytes

Returns:

the human readable string representation

getFileSizeHR

public static String getFileSizeHR(String filename)

Get the size of a local or remote file in a human readable form.

Parameters:

filename - the file name or URL

Returns:

the size of the file

executeAndWait

public static String executeAndWait(String command,
                    int max_runtime,
                    boolean HANDLE_OUTPUT,
                    boolean SHOW_OUTPUT)

Execute the given command.

Parameters:

command - the command

max_runtime - the maximum allowed time to run (in milli-seconds, -1 indicates forever)

HANDLE_OUTPUT - true if the process output should be handled

SHOW_OUTPUT - true if the process output should be shown

Returns:

the command output, null if the operation did not complete within the given time frame

executeAndWait

public static String executeAndWait(String command,
                    int max_runtime)

Execute the given command.

Parameters:

command - the command

max_runtime - the maximum allowed time to run (in milli-seconds, -1 indicates forever)

Returns:

the command output, null if the operation did not complete within the given time frame

addAuthentication

public static String addAuthentication(String url,
                       String authentication)

Add authentication to a URL.

Parameters:

url - a URL

authentication - the "username:password"

Returns:

the URL with the authentication included

setDefaultAuthentication

public static void setDefaultAuthentication(String authentication)

Set default authentication for HTTP requests.

Parameters:

authentication - the "username:password"

print

public static void print(String string,
         String filename)

Append a string to a file.

Parameters:

string - the text to append to the file

filename - the file to append to

println

public static void println(String string,
           String filename)

Append a line to a file.

Parameters:

string - the line to append to the file

filename - the file to append to

getTimeStamp

public static String getTimeStamp()

Get the current date and time (useful for logs, is thread safe).

Returns:

a string containing the current date and time

unzip

public static void unzip(String path,
         String filename)

Unzip a zip file into the given path.

Parameters:

path - the path to unzip to

filename - the name of the zip file

zip

public static void zip(String output,
       String file)

Zip a file or directory.

Parameters:

output - the output zip file

files - a file

zip

public static void zip(String output,
       Vector<String> files)

Zip a given set of files.

Parameters:

output - the output zip file

files - a vector of files

zip

public static void zip(ZipOutputStream outs,
       String path,
       String filename)

Add a file to the given zip file output stream.

Parameters:

outs - the zip file output stream

path - the path to the file (minus the portion of the path that should be stored in the zip file)

filename - the name of the file to add (plus the portion of the path that should be stored in the zip file)

main

public static void main(String[] args)

A main for debug purposes.

Parameters:

args - the command line arguments