org.redline_rpm.payload

Class Contents

java.lang.Object

org.redline_rpm.payload.Contents

public class Contents
extends Object

The contents of an RPM archive. These entries define the files and links that the RPM contains as well as headers those files require. Note that the RPM format requires that files in the archive be naturally ordered.

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<String>	builtins
protected Set<String>	files
protected Set<CpioHeader>	headers
protected Map<CpioHeader,Object>	sources

Constructor Summary

Constructors

Constructor and Description
Contents()

Method Summary

Modifier and Type	Method and Description
static void	addBuiltinDirectory(String directory) Add additional directory that is assumed to already exist on system where the RPM will be installed (e.g.
void	addDirectory(String path) Adds a directory entry to the archive with the default permissions of 644.
void	addDirectory(String path, Directive directive) Adds a directory entry to the archive with the default permissions of 644.
void	addDirectory(String path, int permissions) Adds a directory entry to the archive with the specified permissions.
void	addDirectory(String path, int permissions, Directive directive, String uname, String gname) Adds a directory entry to the archive with the specified permissions.
void	addDirectory(String path, int permissions, Directive directive, String uname, String gname, boolean addParents) Adds a directory entry to the archive with the specified permissions.
void	addFile(String path, File source) Adds a file entry to the archive with the default permissions of 644.
void	addFile(String path, File source, int permissions) Adds a file entry to the archive with the specified permissions.
void	addFile(String path, File source, int permissions, Directive directive) Adds a file entry to the archive with the specified permissions.
void	addFile(String path, File source, int permissions, Directive directive, String uname, String gname) Adds a file entry to the archive with the specified permissions.
void	addFile(String path, File source, int permissions, Directive directive, String uname, String gname, int dirmode) Adds a file entry to the archive with the specified permissions.
void	addFile(String path, File source, int permissions, Directive directive, String uname, String gname, int dirmode, boolean addParents) Adds a file entry to the archive with the specified permissions.
void	addFile(String path, File source, int permissions, Directive directive, String uname, String gname, int dirmode, boolean addParents, int verifyFlags) Adds a file entry to the archive with the specified permissions.
void	addFile(String path, File source, int permissions, int dirmode) Adds a file entry to the archive with the specified permissions.
void	addLink(String path, String target) Adds a directory entry to the archive with the default permissions of 644.
void	addLink(String path, String target, int permissions) Adds a directory entry to the archive with the specified permissions.
void	addLink(String path, String target, int permissions, String uname, String gname) Adds a directory entry to the archive with the specified permissions.
void	addLocalBuiltinDirectory(String directory) Add additional directory that is assumed to already exist on system where the RPM will be installed (e.g.
protected void	addParents(File file, int permissions, String uname, String gname) Adds entries for parent directories of this file, so that they may be cleaned up when removing the package.
void	addURL(String path, URL source, int permissions, Directive directive, String uname, String gname, int dirmode) Adds a URL entry to the archive with the specified permissions.
String[]	getBaseNames() Gets the basenames header values.
int[]	getClasses() Gets the classes header values.
int[]	getColors() Gets the colors header values.
String[]	getContexts() Gets the contexts header values.
int[]	getDependsN() Gets the dependsn header values.
int[]	getDependsX() Gets the dependsx header values.
int[]	getDevices() Gets the devices header values.
int[]	getDirIndexes() Gets the dirindexes headers values.
String[]	getDirNames() Gets the dirnames headers values.
String[]	getFileChecksums() Caclulates an MD5 hash for each file in the archive.
int[]	getFlags() Gets the flags header values.
String[]	getGroups() Gets the groups header values.
int[]	getInodes() Gets the inodes header values.
String[]	getLangs() Gets the langs header values.
String[]	getLinkTos() Gets the linktos header values.
short[]	getModes() Gets the modes header values.
int[]	getMtimes() Gets the mtimes header values.
short[]	getRdevs() Gets the rdevs header values.
int[]	getSizes() Gets the sizes header values.
Object	getSource(CpioHeader header) Retrieves the content for this archive entry, which may be a File if the entry is a regular file or a CharSequence containing the name of the target path if the entry is a link.
int	getTotalSize() Accumulated size of all files included in the archive.
String[]	getUsers() Gets the users header values.
int[]	getVerifyFlags() Gets the verifyflags header values.
Iterable<CpioHeader>	headers() Retrieve the archive headers.
protected void	listParents(List<String> parents, File file) Generates a list of parent paths given a starting path.
int	size() Retrieve the size of this archive in number of files.

Methods inherited from class java.lang.Object

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

Field Detail

headers

protected final Set<CpioHeader> headers

files

protected final Set<String> files

sources

protected final Map<CpioHeader,Object> sources

builtins

protected final Set<String> builtins

Constructor Detail

Contents

public Contents()

Method Detail

addLink

public void addLink(String path,
                    String target)

Adds a directory entry to the archive with the default permissions of 644.

Parameters:

path - the destination path for the installed file.

target - the target string

addLink

public void addLink(String path,
                    String target,
                    int permissions)

Adds a directory entry to the archive with the specified permissions.

Parameters:

path - the destination path for the installed file.

target - the target string

permissions - the permissions flags.

addLink

public void addLink(String path,
                    String target,
                    int permissions,
                    String uname,
                    String gname)

Adds a directory entry to the archive with the specified permissions.

Parameters:

path - the destination path for the installed file.

target - the target string

permissions - the permissions flags.

uname - user owner for the given link

gname - group owner for the given link

addDirectory

public void addDirectory(String path)

Adds a directory entry to the archive with the default permissions of 644.

Parameters:

path - the destination path for the installed file.

addDirectory

public void addDirectory(String path,
                         Directive directive)

Adds a directory entry to the archive with the default permissions of 644.

Parameters:

path - the destination path for the installed file.

directive - directive indicating special handling for this directory.

addDirectory

public void addDirectory(String path,
                         int permissions)

Adds a directory entry to the archive with the specified permissions.

Parameters:

path - the destination path for the installed file.

permissions - the permissions flags.

addDirectory

public void addDirectory(String path,
                         int permissions,
                         Directive directive,
                         String uname,
                         String gname)

Adds a directory entry to the archive with the specified permissions.

Parameters:

path - the destination path for the installed file.

permissions - the permissions flags.

directive - directive indicating special handling for this directory.

uname - user owner for the given file

gname - group owner for the given file

addDirectory

public void addDirectory(String path,
                         int permissions,
                         Directive directive,
                         String uname,
                         String gname,
                         boolean addParents)

Adds a directory entry to the archive with the specified permissions.

Parameters:

path - the destination path for the installed file.

permissions - the permissions flags.

directive - directive indicating special handling for this directory.

uname - user owner for the given file

gname - group owner for the given file

addParents - whether to add parent directories to the rpm

addFile

public void addFile(String path,
                    File source)
             throws FileNotFoundException

Adds a file entry to the archive with the default permissions of 644.

Parameters:

path - the destination path for the installed file.

source - the local file to be included in the package.

Throws:

FileNotFoundException - file wasn't found

addFile

public void addFile(String path,
                    File source,
                    int permissions)
             throws FileNotFoundException

Adds a file entry to the archive with the specified permissions.

Parameters:

path - the destination path for the installed file.

source - the local file to be included in the package.

permissions - the permissions flags.

Throws:

FileNotFoundException - file wasn't found

addFile

public void addFile(String path,
                    File source,
                    int permissions,
                    int dirmode)
             throws FileNotFoundException

Adds a file entry to the archive with the specified permissions.

Parameters:

path - the destination path for the installed file.

source - the local file to be included in the package.

permissions - the permissions flags.

dirmode - permission flags for parent directories, use -1 to leave as default.

Throws:

FileNotFoundException - file wasn't found

addFile

public void addFile(String path,
                    File source,
                    int permissions,
                    Directive directive)
             throws FileNotFoundException

Adds a file entry to the archive with the specified permissions.

Parameters:

path - the destination path for the installed file.

source - the local file to be included in the package.

permissions - the permissions flags.

directive - directive indicating special handling for this file.

Throws:

FileNotFoundException - file wasn't found

addFile

public void addFile(String path,
                    File source,
                    int permissions,
                    Directive directive,
                    String uname,
                    String gname)
             throws FileNotFoundException

Adds a file entry to the archive with the specified permissions.

Parameters:

path - the destination path for the installed file.

source - the local file to be included in the package.

permissions - the permissions flags.

directive - directive indicating special handling for this file.

uname - user owner for the given file

gname - group owner for the given file

Throws:

FileNotFoundException - file wasn't found

addFile

public void addFile(String path,
                    File source,
                    int permissions,
                    Directive directive,
                    String uname,
                    String gname,
                    int dirmode)
             throws FileNotFoundException

Adds a file entry to the archive with the specified permissions.

Parameters:

path - the destination path for the installed file.

source - the local file to be included in the package.

permissions - the permissions flags.

directive - directive indicating special handling for this file.

uname - user owner for the given file

gname - group owner for the given file

dirmode - permission flags for parent directories, use -1 to leave as default.

Throws:

FileNotFoundException - file wasn't found

addFile

public void addFile(String path,
                    File source,
                    int permissions,
                    Directive directive,
                    String uname,
                    String gname,
                    int dirmode,
                    boolean addParents)
             throws FileNotFoundException

Adds a file entry to the archive with the specified permissions.

Parameters:

path - the destination path for the installed file.

source - the local file to be included in the package.

permissions - the permissions flags, use -1 to leave as default.

directive - directive indicating special handling for this file, use null to ignore.

uname - user owner for the given file, use null for default user.

gname - group owner for the given file, use null for default group.

dirmode - permission flags for parent directories, use -1 to leave as default.

addParents - whether to create parent directories for the file, defaults to true for other methods.

Throws:

FileNotFoundException - file wasn't found

addFile

public void addFile(String path,
                    File source,
                    int permissions,
                    Directive directive,
                    String uname,
                    String gname,
                    int dirmode,
                    boolean addParents,
                    int verifyFlags)
             throws FileNotFoundException

Adds a file entry to the archive with the specified permissions.

Parameters:

path - the destination path for the installed file.

source - the local file to be included in the package.

permissions - the permissions flags, use -1 to leave as default.

directive - directive indicating special handling for this file, use null to ignore.

uname - user owner for the given file, use null for default user.

gname - group owner for the given file, use null for default group.

dirmode - permission flags for parent directories, use -1 to leave as default.

addParents - whether to create parent directories for the file, defaults to true for other methods.

verifyFlags - verify flags

Throws:

FileNotFoundException - file wasn't found

addURL

public void addURL(String path,
                   URL source,
                   int permissions,
                   Directive directive,
                   String uname,
                   String gname,
                   int dirmode)
            throws FileNotFoundException

Adds a URL entry to the archive with the specified permissions.

Parameters:

path - the destination path for the installed file.

source - the URL with the data to be added

permissions - the permissions flags.

directive - directive indicating special handling for this file.

uname - user owner for the given file

gname - group owner for the given file

dirmode - permission flags for parent directories, use -1 to leave as default.

Throws:

FileNotFoundException - file wasn't found

addParents

protected void addParents(File file,
                          int permissions,
                          String uname,
                          String gname)

Adds entries for parent directories of this file, so that they may be cleaned up when removing the package.

Parameters:

file - the file to add parent directories of

permissions - the permissions flags

uname - user owner for the given file

gname - group owner for the given file

addBuiltinDirectory

public static void addBuiltinDirectory(String directory)

Add additional directory that is assumed to already exist on system where the RPM will be installed (e.g. /etc) and should not have an entry in the RPM. The directory will be added to all instance of Contents created after this method is called.

Parameters:

directory - the directory to add

addLocalBuiltinDirectory

public void addLocalBuiltinDirectory(String directory)

Add additional directory that is assumed to already exist on system where the RPM will be installed (e.g. /etc) and should not have an entry in the RPM. The builtin will only be added to this instance of Contents.

Parameters:

directory - the directory to add

size

public int size()

Retrieve the size of this archive in number of files. This count includes both directory entries and soft links.

Returns:

the number of files in this archive

headers

public Iterable<CpioHeader> headers()

Retrieve the archive headers. The returned Iterable will iterate in the correct order for the final archive.

Returns:

the headers

getSource

public Object getSource(CpioHeader header)

Retrieves the content for this archive entry, which may be a File if the entry is a regular file or a CharSequence containing the name of the target path if the entry is a link. This is the value to be written to the archive as the body of the entry.

Parameters:

header - the header to get the content from

Returns:

the content

getTotalSize

public int getTotalSize()

Accumulated size of all files included in the archive.

Returns:

the size of all files included in the archive

getDirNames

public String[] getDirNames()

Gets the dirnames headers values.

Returns:

the dirnames headers values

getDirIndexes

public int[] getDirIndexes()

Gets the dirindexes headers values.

Returns:

the dirindexes

getBaseNames

public String[] getBaseNames()

Gets the basenames header values.

Returns:

the basename header values

getSizes

public int[] getSizes()

Gets the sizes header values.

Returns:

the sizes header values

getModes

public short[] getModes()

Gets the modes header values.

Returns:

the modes header values

getRdevs

public short[] getRdevs()

Gets the rdevs header values.

Returns:

the rdevs header values

getMtimes

public int[] getMtimes()

Gets the mtimes header values.

Returns:

the mtimes header values

getFileChecksums

public String[] getFileChecksums()
                          throws NoSuchAlgorithmException,
                                 IOException

Caclulates an MD5 hash for each file in the archive.

Returns:

the MD5 hashes

Throws:

NoSuchAlgorithmException - if the algorithm isn't supported

IOException - there was an IO error

getLinkTos

public String[] getLinkTos()

Gets the linktos header values.

Returns:

the linktos header values

getFlags

public int[] getFlags()

Gets the flags header values.

Returns:

the flags header values

getUsers

public String[] getUsers()

Gets the users header values.

Returns:

the users header values

getGroups

public String[] getGroups()

Gets the groups header values.

Returns:

the groups header values

getColors

public int[] getColors()

Gets the colors header values.

Returns:

the colors header values

getVerifyFlags

public int[] getVerifyFlags()

Gets the verifyflags header values.

Returns:

the verifyflags header values

getClasses

public int[] getClasses()

Gets the classes header values.

Returns:

the classes header values

getDevices

public int[] getDevices()

Gets the devices header values.

Returns:

the devices header values

getInodes

public int[] getInodes()

Gets the inodes header values.

Returns:

the iNodes header values

getLangs

public String[] getLangs()

Gets the langs header values.

Returns:

the langs header values

getDependsX

public int[] getDependsX()

Gets the dependsx header values.

Returns:

the dependsx header values

getDependsN

public int[] getDependsN()

Gets the dependsn header values.

Returns:

the dependsn header values

getContexts

public String[] getContexts()

Gets the contexts header values.

Returns:

the contexts header values

listParents

protected void listParents(List<String> parents,
                           File file)

Generates a list of parent paths given a starting path.

Parameters:

parents - the list to add the parents to

file - the file to search for parents of