ShellScript (IzPack util module 5.2.4 API)

java.lang.Object
- com.izforge.izpack.util.unix.ShellScript

```
public class ShellScript
extends Object
```
A Generator, Wrapper and Executor for Unix ShellScripts

Author:

marc.eppelmann@reddot.de

Field Summary

Fields
Modifier and Type Field and Description

static String BASH

static String BOURNE_AGAIN_SHELL

static String BOURNE_SHELL

static String SH

Fields
Modifier and Type	Field and Description
`static String`	`BASH`
`static String`	`BOURNE_AGAIN_SHELL`
`static String`	`BOURNE_SHELL`
`static String`	`SH`

Constructor Summary

Constructors
Constructor and Description
`ShellScript()` Creates and initializes the ShellScript for running on the bourne shell: "sh".
`ShellScript(String aShell)` Creates and initializes the ShellScript for running on the given shell.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`append(char aChar)` Appends a Char to this ShellScript.
`void`	`append(Object anObject)` Appends an Object or String to this ShellScript.
`void`	`append(String[] anArray)` Appends the Array as one Commandline Space Separated This is usefull with our FileExecutor
`void`	`appendln()` Appends an unix linefeed to this script ("\n").
`void`	`appendln(char aChar)` Appends a Char Object or String to this ShellScript with unix linefeed ("\n").
`void`	`appendln(Object anObject)` Appends an Object or String to this ShellScript with unix linefeed ("\n").
`void`	`appendln(String[] anArray)` Appends the Array as ONE!
`void`	`delete()` Deletes only if Location is not null.
`String`	`exec()` Execute this ShellScript.
`String`	`exec(String itsParams)` Executes this ShellScript with the given Params.
`static String`	`execAndDelete(StringBuffer lines, String aLocation)` Executes and removes the script.
`static String`	`execAndDelete(String aShell, StringBuffer lines, String aLocation, String itsParams)` Executes and removes the script.
`static String`	`execute(StringBuffer lines, String aLocation)` Executes ths given lines in the created default shell (sh) stored on location.
`static String`	`execute(String aShell, StringBuffer lines, String aLocation, String itsParams)` Execs ths given lines in the creted shell stored on location.
`StringBuffer`	`getContent()` gets the Content of this Script.
`String`	`getContentAsString()` Gets the Content of this Script as String
`String`	`getShell()` Gets the current used shell.
`static void`	`main(String[] args)` Test Main Method Run test with: java -cp .jar com.izforge.izpack.util.unix.ShellScript
`void`	`setShell(String aShell)` Sets the current used shell
`String`	`toString()` Dumps the ShellScript Content, and Location.
`void`	`write(String aDestination)` write this to the given Destination FileName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - SH
```
public static final String SH
```
    See Also:
    
    Constant Field Values
  - BOURNE_SHELL
```
public static final String BOURNE_SHELL
```
    See Also:
    
    Constant Field Values
  - BASH
```
public static final String BASH
```
    See Also:
    
    Constant Field Values
  - BOURNE_AGAIN_SHELL
```
public static final String BOURNE_AGAIN_SHELL
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ShellScript
```
public ShellScript(String aShell)
```
    Creates and initializes the ShellScript for running on the given shell.
    
    Parameters:
    
    aShell - "sh", "bash", "ksh", "csh" and so an...
  - ShellScript
```
public ShellScript()
```
    Creates and initializes the ShellScript for running on the bourne shell: "sh".
- Method Detail
  - setShell
```
public void setShell(String aShell)
```
    Sets the current used shell
    
    Parameters:
    
    aShell - The Shell which should set and used.
  - getShell
```
public String getShell()
```
    Gets the current used shell. Can be null.
    
    Returns:
    
    the Shell
  - append
```
public void append(Object anObject)
```
    Appends an Object or String to this ShellScript.
    
    Parameters:
    
    anObject - the Object to append
  - append
```
public void append(char aChar)
```
    Appends a Char to this ShellScript.
    
    Parameters:
    
    aChar - a char to append
  - append
```
public void append(String[] anArray)
```
    Appends the Array as one Commandline Space Separated This is usefull with our FileExecutor
    
    Parameters:
    
    anArray -
  - appendln
```
public void appendln(String[] anArray)
```
    Appends the Array as ONE! Commandline Space Separated And additionionally append an linefeed "\n" This is usefull with our FileExecutor
    
    Parameters:
    
    anArray -
  - appendln
```
public void appendln(Object anObject)
```
    Appends an Object or String to this ShellScript with unix linefeed ("\n").
    
    Parameters:
    
    anObject - the Object to append
  - appendln
```
public void appendln(char aChar)
```
    Appends a Char Object or String to this ShellScript with unix linefeed ("\n").
    
    Parameters:
    
    aChar - a char to append
  - appendln
```
public void appendln()
```
    Appends an unix linefeed to this script ("\n").
  - getContent
```
public StringBuffer getContent()
```
    gets the Content of this Script.
    
    Returns:
    
    the Content
  - getContentAsString
```
public String getContentAsString()
```
    Gets the Content of this Script as String
    
    Returns:
    
    the script as String
  - toString
```
public String toString()
```
    Dumps the ShellScript Content, and Location. Use getContentAsString() to get this ShellScripts Content
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    The ShellScript as Object dump.
  - write
```
public void write(String aDestination)
```
    write this to the given Destination FileName
    
    Parameters:
    
    aDestination - a destination filename
  - exec
```
public String exec(String itsParams)
```
    Executes this ShellScript with the given Params.
    NOTE: the params cannot be contain whitespaces.
    This (su -c <br>"cp from to"</br>) would not work:
    because the underlaying java.runtime.exec("command") does not handle balanced or unbalanced (") correctly.
    else just whitespace separate tokens.
    This means for the sample. runtime.exec() would ever execute such as: su "-c" "\"cp" "fromFile" "toFile\""
    But this his hidden in Sun's native code ;-(
    This was the reason to write this class to have a Workaround :-)
    
    Parameters:
    
    itsParams -
    
    Returns:
    
    the output from stdout of the execution.
  - exec
```
public String exec()
```
    Execute this ShellScript.
    
    Returns:
    
    the output from stdout of the execution.
  - execute
```
public static String execute(String aShell,
                             StringBuffer lines,
                             String aLocation,
                             String itsParams)
```
    Execs ths given lines in the creted shell stored on location.
    
    Parameters:
    
    aShell - A Shell which will be eexecute the script.
    
    lines - The content of the script.
    
    aLocation - The location where to store.
    
    itsParams - Th eoptional params of the script.
    
    Returns:
    
    the exec result
  - execute
```
public static String execute(StringBuffer lines,
                             String aLocation)
```
    Executes ths given lines in the created default shell (sh) stored on location.
    
    Parameters:
    
    lines - the lines of the script to exec.s
    
    aLocation - where to store
    
    Returns:
    
    the stdout of the script.
  - execAndDelete
```
public static String execAndDelete(String aShell,
                                   StringBuffer lines,
                                   String aLocation,
                                   String itsParams)
```
    Executes and removes the script.
    The Lines be also written in python or perl,
    In this case, the Shell must be python or perl or so.
    
    Parameters:
    
    aShell - The Shell which should exec the script. Can be also be python or perl, if the shellcontent is given in this language.
    
    lines - of the script.
    
    aLocation - where to store.
    
    itsParams - which should be pass to the script.
    
    Returns:
    
    the stdout.
  - execAndDelete
```
public static String execAndDelete(StringBuffer lines,
                                   String aLocation)
```
    Executes and removes the script.
    
    Parameters:
    
    lines - of the script.
    
    aLocation - where to store.
    
    Returns:
    
    the sdtout.
  - main
```
public static void main(String[] args)
```
    Test Main Method Run test with: java -cp .jar com.izforge.izpack.util.unix.ShellScript
    
    Parameters:
    
    args - Arguments from Commandline
  - delete
```
public void delete()
```
    Deletes only if Location is not null.

Class ShellScript

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SH

BOURNE_SHELL

BASH

BOURNE_AGAIN_SHELL

Constructor Detail

ShellScript

ShellScript

Method Detail

setShell

getShell

append

append

append

appendln

appendln

appendln

appendln

getContent

getContentAsString

toString

write

exec

exec

execute

execute

execAndDelete

execAndDelete

main

delete