org.eclipse.scada.configuration.world.lib.deployment

Interface DeploymentContext

All Known Implementing Classes:

CommonPackageDeploymentContext

public interface DeploymentContext

Allow access to the context of the deployment
Note: The script interpreter is part of the target deployment mechanism (e.g. deb, rpm). In most Unix cases a plain "bourne shell" (not bash) will most likely work. Also is it not a complete shell script but a script fragment. Which means that a wrong syntax can cause the whole setup to fail.

Method Summary

Modifier and Type	Method and Description
void	addDirectory(String targetDirectory, FileInformation fileInformation)
void	addFile(org.eclipse.scada.utils.pkg.deb.ContentProvider content, String targetFile, FileInformation fileInformation) Add a file to the deployment package Add the content of the input stream as a file in the target system
void	addInstallDependency(String packageName)
void	addPostInstallationScript(Reader reader) Add a script as post installation script
void	addPostRemovalScript(Reader reader) Add a script as post removal script
void	addPreInstallationScript(Reader reader) Add a script as pre installation script
void	addPreRemovalScript(Reader reader) Add a script as pre removal script
String	getPackageName() Get the name of the package that will be built This is the name, not the file name, of the package.
void	runAfterInstallation(String script) Run a shell script fragment after the installation or upgrade of the package
void	runAfterRemoval(String script) Run a shell script fragment after package was completely removed

Method Detail

getPackageName

String getPackageName()

Get the name of the package that will be built
This is the name, not the file name, of the package.

Returns:

the package name

addInstallDependency

void addInstallDependency(String packageName)

addPreInstallationScript

void addPreInstallationScript(Reader reader)
                       throws IOException

Add a script as pre installation script

The method has to close the reader before it returns. Even in the case of an exception.

Parameters:

reader - the content to add

Throws:

IOException - if anything goes wrong

addPostInstallationScript

void addPostInstallationScript(Reader reader)
                        throws IOException

Add a script as post installation script

The method has to close the reader before it returns. Even in the case of an exception.

Parameters:

reader - the content to add

Throws:

IOException - if anything goes wrong

addPreRemovalScript

void addPreRemovalScript(Reader reader)
                  throws IOException

Add a script as pre removal script

The method has to close the reader before it returns. Even in the case of an exception.

Parameters:

reader - the content to add

Throws:

IOException - if anything goes wrong

addPostRemovalScript

void addPostRemovalScript(Reader reader)
                   throws IOException

Add a script as post removal script

The method has to close the reader before it returns. Even in the case of an exception.

Parameters:

reader - the content to add

Throws:

IOException - if anything goes wrong

runAfterInstallation

void runAfterInstallation(String script)

Run a shell script fragment after the installation or upgrade of the package

Parameters:

script - the script fragment to run

runAfterRemoval

void runAfterRemoval(String script)

Run a shell script fragment after package was completely removed

Parameters:

script - the script fragment to run

addFile

void addFile(org.eclipse.scada.utils.pkg.deb.ContentProvider content,
             String targetFile,
             FileInformation fileInformation)
      throws IOException

Add a file to the deployment package
Add the content of the input stream as a file in the target system

The method has to close the input stream before it returns. Even in the case of an exception.

Parameters:

content - the content to add

targetFile - the name of the file in the target system

options - a list of options

Throws:

IOException - if anything goes wrong

addDirectory

void addDirectory(String targetDirectory,
                  FileInformation fileInformation)