AutoClientJar (NetPhantom® 8.0 Java API Specification)

java.lang.Object
- se.entra.phantom.server.phed.project.AutoClientJar

```
public class AutoClientJar
extends Object
```
Class used for Auto-Client Jar routines.
Author:
Christopher Mindus

Field Summary
Fields
Modifier and Type Field and Description
static String FILENAME
The file name "auto-client.jar".

Fields
Modifier and Type	Field and Description
`static String`	`FILENAME` The file name "auto-client.jar".

Constructor Summary
Constructors
Constructor and Description
AutoClientJar(File dir)
Constructor used when only directory is available.
AutoClientJar(PhantomRuntime runtime)
Creates the instance for a runtime.

Constructors
Constructor and Description
`AutoClientJar(File dir)` Constructor used when only directory is available.
`AutoClientJar(PhantomRuntime runtime)` Creates the instance for a runtime.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addDefaultSettings(IniFile ini, boolean on, LinkedHashSet<String> dirSpec)` Adds default settings to an INI file.
`boolean`	`builderCreateJarIfRequired(IProgressMonitor monitor)` Creates the Jar file if required.
`void`	`createJar(LinkedHashMap<String,File> files, IProgressMonitor monitor)` Creates the Jar file with the specified files.
`File`	`findDirectoryForImage(String path)` From the path specification of an image file, find a file directory.
`File`	`getClientJarFile()` Gets the file for the Client Jar.
`String[]`	`getDirSpecs()` Gets the directory specification entries.
`static String[]`	`getDirSpecs(IniFile ini)` Gets the directory specification entries.
`LinkedHashMap<String,File>`	`getFiles(String[] dirSpecs)` Gets the list of required files in the Jar.
`boolean`	`isEnabled()` Checks if the "auto-client.jar" file is enabled.
`static boolean`	`isEnabled(IniFile ini)` Checks if the "auto-client.jar" file is enabled.
`boolean`	`needsCreate(LinkedHashMap<String,File> files, IProgressMonitor monitor)` Checks for requirement to create the Jar file.
`static void`	`replaceJarWithAutoClientJar(File jarFile, File destDir, boolean deleteOrRenameAfterExtract, File newName, LinkedHashSet<String> autoJarDirSpecs, IProgressMonitor monitor)` Replaces a Jar file with Auto-Client Jar.

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

- Field Detail
  - FILENAME
```
public static final String FILENAME
```
    The file name "auto-client.jar".
    See Also:
    Constant Field Values
- Constructor Detail
  - AutoClientJar
```
public AutoClientJar(PhantomRuntime runtime)
```
    Creates the instance for a runtime.
  - AutoClientJar
```
public AutoClientJar(File dir)
```
    Constructor used when only directory is available.
- Method Detail
  - addDefaultSettings
```
public static void addDefaultSettings(IniFile ini,
                                      boolean on,
                                      LinkedHashSet<String> dirSpec)
```
    Adds default settings to an INI file.
    Parameters:
    ini - The INI file.
    on - Flag for enablement.
    dirSpec - Directory specification or null for default: each item as SRC=DEST, DEST=/ means root (empty strings not allowed). An item could also be just SRC, meaning SRC=DEST where DEST and SRC are equal (will be converted to SRC=SRC).
  - isEnabled
```
public boolean isEnabled()
```
    Checks if the "auto-client.jar" file is enabled.
  - isEnabled
```
public static boolean isEnabled(IniFile ini)
```
    Checks if the "auto-client.jar" file is enabled.
  - getDirSpecs
```
public String[] getDirSpecs()
                     throws IOException
```
    Gets the directory specification entries.
    Returns:
    The specification as array of strings of type SRC=DEST (always), DEST=/ for root.
    Throws:
    IOException - for invalid entries.
  - getDirSpecs
```
public static String[] getDirSpecs(IniFile ini)
                            throws IOException
```
    Gets the directory specification entries.
    Returns:
    The specification as array of strings of type SRC=DEST (always), DEST=/ for root.
    Throws:
    IOException - for invalid entries.
  - getClientJarFile
```
public File getClientJarFile()
```
    Gets the file for the Client Jar.
  - getFiles
```
public LinkedHashMap<String,File> getFiles(String[] dirSpecs)
                                    throws IOException
```
    Gets the list of required files in the Jar.
    Parameters:
    dirSpecs - The directory specification array. Each entry MUST contain a '='.
    Throws:
    IOException - In case of file structure mismatch.
  - needsCreate
```
public boolean needsCreate(LinkedHashMap<String,File> files,
                           IProgressMonitor monitor)
```
    Checks for requirement to create the Jar file. No CRC/contents checking is done, it's too slow.
    Parameters:
    files - The files that should be in the Jar.
    monitor - A progress monitor, or null for none.
  - builderCreateJarIfRequired
```
public boolean builderCreateJarIfRequired(IProgressMonitor monitor)
                                   throws IOException,
                                          CancelException
```
    Creates the Jar file if required. Calling this method assumes that "isEnabled" has been checked. This method is used by the automatic builder system, NOT distribution.
    Returns:
    true if the auto-client.jar file was created.
    Throws:
    IOException
    CancelException
  - createJar
```
public void createJar(LinkedHashMap<String,File> files,
                      IProgressMonitor monitor)
               throws IOException,
                      CancelException
```
    Creates the Jar file with the specified files.
    Throws:
    IOException
    CancelException
  - findDirectoryForImage
```
public File findDirectoryForImage(String path)
```
    From the path specification of an image file, find a file directory.
    Returns:
    The directory or null if not found.
  - replaceJarWithAutoClientJar
```
public static void replaceJarWithAutoClientJar(File jarFile,
                                               File destDir,
                                               boolean deleteOrRenameAfterExtract,
                                               File newName,
                                               LinkedHashSet<String> autoJarDirSpecs,
                                               IProgressMonitor monitor)
                                        throws IOException
```
    Replaces a Jar file with Auto-Client Jar.
    Parameters:
    jarFile - The Jar file to process.
    destDir - Destination directory for extracted files.
    deleteOrRenameAfterExtract - Deletes or renames the Jar file after extraction.
    newName - The new name of the Jar file, null will delete the file.
    autoJarDirSpecs - The current directory specifications.
    monitor - The progress monitor.
    Throws:
    IOException - For Jar file errors.

Class AutoClientJar

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FILENAME

Constructor Detail

AutoClientJar

AutoClientJar

Method Detail

addDefaultSettings

isEnabled

isEnabled

getDirSpecs

getDirSpecs

getClientJarFile

getFiles

needsCreate

builderCreateJarIfRequired

createJar

findDirectoryForImage

replaceJarWithAutoClientJar