com.redhat.rhn.manager.configuration.file

Class ConfigFileData

java.lang.Object

com.redhat.rhn.manager.configuration.file.ConfigFileData

Direct Known Subclasses:

BinaryFileData, DirectoryData, TextFileData

public abstract class ConfigFileData
extends java.lang.Object

ConfigFileData

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_CONFIG_DELIM_END
static java.lang.String	DEFAULT_CONFIG_DELIM_START
static long	MAX_FILE_SIZE

Constructor Summary

Constructors

Constructor and Description
ConfigFileData() Constructor for COnfigFIleData

Method Summary

Modifier and Type	Method and Description
ConfigInfo	extractInfo()
abstract long	getContentSize()
abstract java.io.InputStream	getContentStream()
java.lang.String	getGroup()
java.lang.String	getMacroEnd()
java.lang.String	getMacroStart()
java.lang.String	getOwner()
java.lang.String	getPath()
java.lang.String	getPermissions()
java.lang.String	getRevNumber()
java.lang.String	getSelinuxCtx()
ConfigFileType	getType()
boolean	isBinary()
boolean	isFile()
protected java.util.Map	makeValidationMap() Basically returns a map equating ConfigFileForm's form fieldnames to values from config file data..
boolean	matchesRevision(ConfigRevision cRevision)
abstract void	processRevisedContentFrom(ConfigRevision rev) Basically Extension point to update the relevant in this data file with the content provided in the revision param.
void	setGroup(java.lang.String groupIn)
void	setMacroEnd(java.lang.String macroEndDelimiter)
void	setMacroStart(java.lang.String macroStartDelimiter)
void	setOwner(java.lang.String ownerName)
void	setPath(java.lang.String filePath)
void	setPermissions(java.lang.String perms)
void	setRevNumber(java.lang.String revNumberIn)
void	setSelinuxCtx(java.lang.String context)
void	setType(ConfigFileType fileType)
java.lang.String	toString()
void	validate(boolean onCreate) Entry point to validate the contents of this form..
protected abstract void	validateContents(ValidatorResult result, boolean onCreate)
void	validatePath() Validates the path explicatily ensuring it follows Linux/Unix path conventions.
protected ValidatorError	validateSELinux()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONFIG_DELIM_START

public static final java.lang.String DEFAULT_CONFIG_DELIM_START

See Also:

Constant Field Values

DEFAULT_CONFIG_DELIM_END

public static final java.lang.String DEFAULT_CONFIG_DELIM_END

See Also:

Constant Field Values

MAX_FILE_SIZE

public static final long MAX_FILE_SIZE

Constructor Detail

ConfigFileData

public ConfigFileData()

Constructor for COnfigFIleData

Method Detail

getPath

public java.lang.String getPath()

Returns:

the path

setPath

public void setPath(java.lang.String filePath)

Parameters:

filePath - the path to set

getOwner

public java.lang.String getOwner()

Returns:

the owner

setOwner

public void setOwner(java.lang.String ownerName)

Parameters:

ownerName - the owner to set

getGroup

public java.lang.String getGroup()

Returns:

the group

setGroup

public void setGroup(java.lang.String groupIn)

Parameters:

groupIn - the group to set

getPermissions

public java.lang.String getPermissions()

Returns:

the permissions

setPermissions

public void setPermissions(java.lang.String perms)

Parameters:

perms - the permissions to set

getSelinuxCtx

public java.lang.String getSelinuxCtx()

Returns:

the SELinux context

setSelinuxCtx

public void setSelinuxCtx(java.lang.String context)

Parameters:

context - the SELinux context to set

getMacroStart

public java.lang.String getMacroStart()

Returns:

the macroStart

setMacroStart

public void setMacroStart(java.lang.String macroStartDelimiter)

Parameters:

macroStartDelimiter - the macroStart to set

getMacroEnd

public java.lang.String getMacroEnd()

Returns:

the macroEnd

setMacroEnd

public void setMacroEnd(java.lang.String macroEndDelimiter)

Parameters:

macroEndDelimiter - the macroEnd to set

isBinary

public boolean isBinary()

Returns:

the binary

getType

public ConfigFileType getType()

Returns:

the type

setType

public void setType(ConfigFileType fileType)

Parameters:

fileType - the type to set

extractInfo

public ConfigInfo extractInfo()

Returns:

info pertaining to this form.

validateSELinux

protected ValidatorError validateSELinux()

validateContents

protected abstract void validateContents(ValidatorResult result,
                                         boolean onCreate)

getContentStream

public abstract java.io.InputStream getContentStream()

Returns:

the contentStream

getContentSize

public abstract long getContentSize()

Returns:

the contentSize

isFile

public boolean isFile()

Returns:

true if the data in this Calass is a directory

validate

public void validate(boolean onCreate)
              throws ValidatorException

Entry point to validate the contents of this form..

Parameters:

onCreate - true if we're creating a config-file, false if we're only updating

Throws:

ValidatorException - if there are any validation errors.

validatePath

public void validatePath()
                  throws ValidatorException

Validates the path explicatily ensuring it follows Linux/Unix path conventions. This is separate form the regular validate method because there was code that needed to check for things like path existence that had to be run after ensuring the path looked ok...

Throws:

ValidatorException - if there are any validation errors.

makeValidationMap

protected java.util.Map makeValidationMap()

Basically returns a map equating ConfigFileForm's form fieldnames to values from config file data.. This is needed by the RHnValidationHelper while matching values against xsds..

Returns:

a map with key = ConfigFIleForms keys, and value = ConfigFIleData values..

processRevisedContentFrom

public abstract void processRevisedContentFrom(ConfigRevision rev)

Basically Extension point to update the relevant in this data file with the content provided in the revision param. This is mainly used to update things like BinaryFiles/Directories where we want the contents of the previous version copied over to the new content ...

Parameters:

rev - the revision to copy stuff from..

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getRevNumber

public java.lang.String getRevNumber()

Returns:

Returns the revNumber.

setRevNumber

public void setRevNumber(java.lang.String revNumberIn)

Parameters:

revNumberIn - The revNumber to set.

matchesRevision

public boolean matchesRevision(ConfigRevision cRevision)

Parameters:

cRevision - config revision

Returns:

true if mathces the config revision