net.sourceforge.javadpkg.impl

Class DebianPackageBuilderImpl

java.lang.Object

net.sourceforge.javadpkg.impl.DebianPackageBuilderImpl

All Implemented Interfaces:

DebianPackageBuilder, DebianPackageConstants, GlobalConstants

public class DebianPackageBuilderImpl
extends Object
implements DebianPackageBuilder, DebianPackageConstants

A DebianPackageBuilder implementation.

Version:

1.0, 25.04.2016 by Gerrit Hohl

Author:

Gerrit Hohl (gerrit-hohl@users.sourceforge.net)

Field Summary

Fields inherited from interface net.sourceforge.javadpkg.DebianPackageConstants

CONFFILES_ENTRY, CONFIG_ENTRY, CONTROL_ENTRY, CONTROL_NAME, CONTROL_TAR_PREFIX, DATA_NAME, DATA_TAR_PREFIX, DEBIAN_BINARY, DIRECTORY_MODE, DOC_BASE_PATH, FILE_MODE, MD5SUMS_ENTRY, POSTINST_ENTRY, POSTRM_ENTRY, PREINST_ENTRY, PRERM_ENTRY, ROOT_GROUP_ID, ROOT_GROUP_NAME, ROOT_USER_ID, ROOT_USER_NAME, SCRIPT_MODE, SHLIBS_ENTRY, SYMBOLS_ENTRY, TAR_BZIP2_SUFFIX, TAR_GZIP_SUFFIX, TAR_XZ_SUFFIX, TEMPLATES_ENTRY, TRIGGERS_ENTRY, USR_PATH, USR_SHARE_PATH

Fields inherited from interface net.sourceforge.javadpkg.GlobalConstants

UTF_8, UTF_8_CHARSET

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DebianPackageBuilderImpl(Script defaultPreInstall, Script defaultPostInstall, Script defaultPreRemove, Script defaultPostRemove) Creates a builder.

Method Summary

Modifier and Type	Method and Description
void	addDataDirectory(String path) Adds a directory to the data of the package.
void	addDataDirectory(String path, FileOwner owner, FileMode mode) Adds a directory to the data of the package.
void	addDataFile(DataSource source, String path) Adds a file to the data of the package.
void	addDataFile(DataSource source, String path, FileOwner owner, FileMode mode) Adds a file to the data of the package.
void	addDataSymLink(String path, String target, FileOwner owner, FileMode mode) Adds a symbolic link to the data of the package.
void	buildDebianPackage(DataTarget target, Context context) Builds a Debian package by writing it to the specified target.
void	setChangeLog(ChangeLog changeLog) Sets the change log.
void	setControl(Control control) Sets the control information.
void	setCopyright(Copyright copyright) Sets the copyright.
void	setInstalledSizeOverhead(Size installedSizeOverhead) Sets the overhead which will be added to the specified installed size.
void	setPostInstall(Script postInstall) Sets the script which will be executed after the package is installed.
void	setPostRemove(Script postRemove) Sets the script which will be executed after the package is removed.
void	setPreInstall(Script preInstall) Sets the script which will be executed before the package is installed.
void	setPreRemove(Script preRemove) Sets the script which will be executed before the package is removed.

Methods inherited from class java.lang.Object

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

Constructor Detail

DebianPackageBuilderImpl

protected DebianPackageBuilderImpl(Script defaultPreInstall,
                                   Script defaultPostInstall,
                                   Script defaultPreRemove,
                                   Script defaultPostRemove)

Creates a builder.

Parameters:

defaultPreInstall - The default script which will be executed before the package is installed.

defaultPostInstall - The default script which will be executed after the package is installed.

defaultPreRemove - The default script which will be executed before the package is removed.

defaultPostRemove - The default script which will be executed after the package is removed.

Throws:

IllegalArgumentException - If any of the parameters are null.

Method Detail

setControl

public void setControl(Control control)

Description copied from interface: DebianPackageBuilder

Sets the control information.

If no installed size is specified in the control information the builder will sum up the sizes of the specified files and use that value as installed size.

Specified by:

setControl in interface DebianPackageBuilder

Parameters:

control - The control information.

setInstalledSizeOverhead

public void setInstalledSizeOverhead(Size installedSizeOverhead)

Description copied from interface: DebianPackageBuilder

Sets the overhead which will be added to the specified installed size.

If a installed size is specified in the control information passed to the DebianPackageBuilder.setControl(Control) method this size will be added. If no installed size is specified the builder will sum up the sizes of the specified files and add the overhead.

The overhead can be used for files which will be created after the installation. This way space can be "reserved".

Specified by:

setInstalledSizeOverhead in interface DebianPackageBuilder

Parameters:

installedSizeOverhead - The overhead.

setPreInstall

public void setPreInstall(Script preInstall)

Description copied from interface: DebianPackageBuilder

Sets the script which will be executed before the package is installed.

Specified by:

setPreInstall in interface DebianPackageBuilder

Parameters:

preInstall - The script or null, if the standard script should be used.

setPostInstall

public void setPostInstall(Script postInstall)

Description copied from interface: DebianPackageBuilder

Sets the script which will be executed after the package is installed.

Specified by:

setPostInstall in interface DebianPackageBuilder

Parameters:

postInstall - The script or null, if the standard script should be used.

setPreRemove

public void setPreRemove(Script preRemove)

Description copied from interface: DebianPackageBuilder

Sets the script which will be executed before the package is removed.

Specified by:

setPreRemove in interface DebianPackageBuilder

Parameters:

preRemove - The script or null, if the standard script should be used.

setPostRemove

public void setPostRemove(Script postRemove)

Description copied from interface: DebianPackageBuilder

Sets the script which will be executed after the package is removed.

Specified by:

setPostRemove in interface DebianPackageBuilder

Parameters:

postRemove - The script or null, if the standard script should be used.

addDataDirectory

public void addDataDirectory(String path)

Description copied from interface: DebianPackageBuilder

Adds a directory to the data of the package.

This method is equal to the method DebianPackageBuilder.addDataDirectory(String, FileOwner, FileMode) using the following values:

group ID	group name	user ID	user name	mode (octal)
0	root	0	root	0755

Specified by:

addDataDirectory in interface DebianPackageBuilder

Parameters:

path - The installation path.

addDataDirectory

public void addDataDirectory(String path,
                             FileOwner owner,
                             FileMode mode)

Description copied from interface: DebianPackageBuilder

Adds a directory to the data of the package.

Specified by:

addDataDirectory in interface DebianPackageBuilder

Parameters:

path - The installation path.

owner - The owner.

mode - The mode.

addDataFile

public void addDataFile(DataSource source,
                        String path)

Description copied from interface: DebianPackageBuilder

Adds a file to the data of the package.

This method is equal to the method DebianPackageBuilder.addDataFile(DataSource, String, FileOwner, FileMode) using the following values:

group ID	group name	user ID	user name	mode (octal)
0	root	0	root	0644

Specified by:

addDataFile in interface DebianPackageBuilder

Parameters:

source - The source for the context of the file.

path - The installation path.

addDataFile

public void addDataFile(DataSource source,
                        String path,
                        FileOwner owner,
                        FileMode mode)

Description copied from interface: DebianPackageBuilder

Adds a file to the data of the package.

Specified by:

addDataFile in interface DebianPackageBuilder

Parameters:

source - The source for the context of the file.

path - The installation path.

owner - The owner.

mode - The mode.

addDataSymLink

public void addDataSymLink(String path,
                           String target,
                           FileOwner owner,
                           FileMode mode)

Description copied from interface: DebianPackageBuilder

Adds a symbolic link to the data of the package.

Specified by:

addDataSymLink in interface DebianPackageBuilder

Parameters:

path - The installation path.

target - The target path.

owner - The owner.

mode - The mode.

setCopyright

public void setCopyright(Copyright copyright)

Description copied from interface: DebianPackageBuilder

Sets the copyright.

Specified by:

setCopyright in interface DebianPackageBuilder

Parameters:

copyright - The copyright.

setChangeLog

public void setChangeLog(ChangeLog changeLog)

Description copied from interface: DebianPackageBuilder

Sets the change log.

Specified by:

setChangeLog in interface DebianPackageBuilder

Parameters:

changeLog - The change log.

buildDebianPackage

public void buildDebianPackage(DataTarget target,
                               Context context)
                        throws IOException,
                               BuildException

Description copied from interface: DebianPackageBuilder

Builds a Debian package by writing it to the specified target.

Specified by:

buildDebianPackage in interface DebianPackageBuilder

Parameters:

target - The target

context - The context.

Throws:

IOException - If an I/O error occurs while writing the file.

BuildException - If an error occurs during the building.

See Also:

DebianPackageBuilder.setControl(Control)