com.redhat.rhn.domain.config

Class ConfigurationFactory

java.lang.Object

com.redhat.rhn.common.hibernate.HibernateFactory

com.redhat.rhn.domain.config.ConfigurationFactory

public class ConfigurationFactory
extends HibernateFactory

ConfigurationFactory. For use when dealing with ConfigChannel, ConfigChannelType, ConfigFile, ConfigRevision, ConfigFileState, ConfigContent, and ConfigInfo. When saving config channels, config files, and config revisions: please use the commitConfigBlah methods.

Method Summary

Modifier and Type	Method and Description
static byte[]	bytesFromStream(java.io.InputStream stream, java.lang.Long size) Convert input stream to byte array
static void	commit(ConfigChannel channel) Save or update a config channel.
static ConfigFile	commit(ConfigFile file) Save or update a config file.
static ConfigRevision	commit(ConfigRevision revision) Save or update a config revision.
static void	copyRevisionToChannel(User usr, ConfigRevision revision, ConfigChannel channel) Copies the given config revision to the given channel.
static ConfigContent	createNewContentFromStream(java.io.InputStream stream, java.lang.Long size, boolean isBinary, java.lang.String delimStart, java.lang.String delimEnd) Creates a ConfigContent object whose BLOB is filled with the bytes from the specified stream
static ConfigChannel	createNewLocalChannel(Server server, ConfigChannelType type) Create a local config channel for the given server.
static ConfigRevision	createNewRevisionFromStream(User usr, java.io.InputStream stream, java.lang.Long size, ConfigFile file) Creates a new revision object from the give input stream.
static java.lang.String	getChannelNameDisplay(java.lang.String type, java.lang.String channel) Returns a localized string for the name of a config channel.
protected org.apache.log4j.Logger	getLogger() Get the Logger for the derived class so log messages show up on the correct class
static java.lang.Long	getNextRevisionForFile(ConfigFile file) Returns new revision number for config file
static ConfigChannel	lookupConfigChannelById(java.lang.Long id) Lookup a ConfigChannel by its id
static ConfigChannel	lookupConfigChannelByLabel(java.lang.String label, Org org, ConfigChannelType cct) Lookup a ConfigChannel by its label.
static ConfigFile	lookupConfigFileByChannelAndName(java.lang.Long channel, java.lang.Long name) Lookup a ConfigFile by its channel's id and config file name's id
static ConfigFile	lookupConfigFileById(java.lang.Long id) Lookup a ConfigFile by its id
static ConfigFileName	lookupConfigFileNameById(java.lang.Long id) Finds a ConfigFileName from the database with a given id.
static ConfigInfo	lookupConfigInfoById(java.lang.Long id) Finds a ConfigInfo from the database with a given id.
static ConfigRevision	lookupConfigRevisionById(java.lang.Long id) Finds a ConfigRevision from the database with a given id.
static ConfigRevision	lookupConfigRevisionByRevId(ConfigFile cf, java.lang.Long revId) Finds a ConfigRevision for a given ConfigFile and given revision id
static java.util.List	lookupConfigRevisions(ConfigFile cf) Finds configuration revisions for a given configuration file
static ConfigFileName	lookupOrInsertConfigFileName(java.lang.String path) Return a ConfigFileName for the path given.
static ConfigInfo	lookupOrInsertConfigInfo(java.lang.String username, java.lang.String groupname, java.lang.Long filemode, java.lang.String selinuxCtx, java.lang.String symlinkTargetPath) Return a ConfigInfo from the username, groupname, file mode, and selinux context.
static ConfigChannel	newConfigChannel() Create a new ConfigChannel object.
static ConfigContent	newConfigContent() Create a new ConfigContent object.
static ConfigFile	newConfigFile() Create a new ConfigFile object.
static ConfigRevision	newConfigRevision() Create a new ConfigRevision object.
static void	removeConfigChannel(ConfigChannel channel) Remove a ConfigChannel.
static void	removeConfigFile(ConfigFile file) Remove a ConfigFile.
static boolean	removeConfigRevision(ConfigRevision revision, java.lang.Long orgId) Remove a ConfigRevision.
static void	saveNewConfigChannel(ConfigChannel channel) Save a new configuration channel.
static ConfigChannel	saveNewConfigChannel(Org org, ConfigChannelType type, java.lang.String name, java.lang.String label, java.lang.String description) Create and save a new configuration channel.
static java.lang.Long	saveNewConfigFile(ConfigFile file) Save a new configuration file.
static java.lang.Long	saveNewConfigRevision(ConfigRevision revision) Save a new ConfigRevision.

Methods inherited from class com.redhat.rhn.common.hibernate.HibernateFactory

addConfigurator, blobToByteArray, byteArrayToBlob, closeSession, closeSessionFactory, commitTransaction, createSessionFactory, createSessionFactory, executeCallableMode, executeSelectMode, getBlobContents, getByteArrayContents, getObject, getSession, initialize, inTransaction, isClosed, isInitialized, listObjectsByNamedQuery, listObjectsByNamedQuery, listObjectsByNamedQuery, lockObject, lookupObjectByNamedQuery, lookupObjectByNamedQuery, reload, removeObject, rollbackTransaction, saveObject, saveObject, stringToByteArray

Methods inherited from class java.lang.Object

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

Method Detail

getLogger

protected org.apache.log4j.Logger getLogger()

Description copied from class: HibernateFactory

Get the Logger for the derived class so log messages show up on the correct class

Specified by:

getLogger in class HibernateFactory

Returns:

Logger for this class.

newConfigFile

public static ConfigFile newConfigFile()

Create a new ConfigFile object.

Returns:

new ConfigFile object

newConfigRevision

public static ConfigRevision newConfigRevision()

Create a new ConfigRevision object.

Returns:

new ConfigRevision object

newConfigChannel

public static ConfigChannel newConfigChannel()

Create a new ConfigChannel object.

Returns:

new ConfigChannel object

newConfigContent

public static ConfigContent newConfigContent()

Create a new ConfigContent object.

Returns:

new ConfigContent object

saveNewConfigChannel

public static ConfigChannel saveNewConfigChannel(Org org,
                                                 ConfigChannelType type,
                                                 java.lang.String name,
                                                 java.lang.String label,
                                                 java.lang.String description)

Create and save a new configuration channel. This method creates a configuration channel and then uses the saveNewConfigChannel(ConfigChannel) method to save it.

Parameters:

org - The org for this configuration channel.

type - The type. Please use the constants located in this class.

name - The name of this configuration channel.

label - The label for this configuration channel.

description - The description of this configuration channel.

Returns:

The newly saved configuration channel.

saveNewConfigChannel

public static void saveNewConfigChannel(ConfigChannel channel)

Save a new configuration channel. Note, this method uses a stored procedure, so it must be used for all newly created configuration channels.

Parameters:

channel - The channel object to persist.

saveNewConfigFile

public static java.lang.Long saveNewConfigFile(ConfigFile file)

Save a new configuration file. Note, this method uses a stored procedure, so it must be used for all newly created configuration files. NOTE: This configuration file must have a persisted configuration channel attached to it. config channels also used stored procedures for insertions, so we can't simply ask hibernate to save it for us.

Parameters:

file - The configuration file to persist

Returns:

config file id

saveNewConfigRevision

public static java.lang.Long saveNewConfigRevision(ConfigRevision revision)

Save a new ConfigRevision. Note, this method uses a stored procedure, so it must be used for all newly created configuration revisions. NOTE: This configuration revision must have a persisted config file attached to it. config files also used stored procedures for insertions, so we can't simply ask hibernate to save it for us.

Parameters:

revision - the new ConfigRevision we want to store.

Returns:

returns revision id

commit

public static void commit(ConfigChannel channel)

Save or update a config channel. Since config channels use a stored procedure for inserting, we have to decide whether to insert or update here. If the channel's id is null, we insert.

Parameters:

channel - The channel to save or update

commit

public static ConfigFile commit(ConfigFile file)

Save or update a config file. Since config files use a stored procedure for inserting, we have to decide whether to insert or update here. If the file's id is null, we insert.

Parameters:

file - The file to save or update

Returns:

config file

commit

public static ConfigRevision commit(ConfigRevision revision)

Save or update a config revision. Since config revisions use a stored procedure for inserting, we have to decide whether to insert or update here. If the revision's id is null, we insert.

Parameters:

revision - The revision to save or update

Returns:

returns config revision (with set id)

lookupConfigChannelById

public static ConfigChannel lookupConfigChannelById(java.lang.Long id)

Lookup a ConfigChannel by its id

Parameters:

id - The identifier for the ConfigChannel

Returns:

the ConfigChannel found or null if not found.

lookupConfigChannelByLabel

public static ConfigChannel lookupConfigChannelByLabel(java.lang.String label,
                                                       Org org,
                                                       ConfigChannelType cct)

Lookup a ConfigChannel by its label. A config channel is uniquely identified by label, org id and channel type

Parameters:

label - The label for the ConfigChannel

org - the org to which the config channel belongs.

cct - the config channel type of the config channel.

Returns:

the ConfigChannel found or null if not found.

lookupConfigFileById

public static ConfigFile lookupConfigFileById(java.lang.Long id)

Lookup a ConfigFile by its id

Parameters:

id - The identifier for the ConfigFile

Returns:

the ConfigFile found or null if not found.

lookupConfigFileByChannelAndName

public static ConfigFile lookupConfigFileByChannelAndName(java.lang.Long channel,
                                                          java.lang.Long name)

Lookup a ConfigFile by its channel's id and config file name's id

Parameters:

channel - The file's config channel id

name - The file's config file name id

Returns:

the ConfigFile found or null if not found.

lookupConfigRevisionById

public static ConfigRevision lookupConfigRevisionById(java.lang.Long id)

Finds a ConfigRevision from the database with a given id.

Parameters:

id - The identifier for the ConfigRevision

Returns:

The sought for ConfigRevision or null if not found.

lookupConfigRevisionByRevId

public static ConfigRevision lookupConfigRevisionByRevId(ConfigFile cf,
                                                         java.lang.Long revId)

Finds a ConfigRevision for a given ConfigFile and given revision id

Parameters:

cf - The ConfigFile to look for.

revId - The ConfigFile revision to look for.

Returns:

ConfigRevision The sought for ConfigRevision.

lookupConfigRevisions

public static java.util.List lookupConfigRevisions(ConfigFile cf)

Finds configuration revisions for a given configuration file

Parameters:

cf - The ConfigFile to look for.

Returns:

List of configuration revisions for given configuration file.

lookupConfigInfoById

public static ConfigInfo lookupConfigInfoById(java.lang.Long id)

Finds a ConfigInfo from the database with a given id.

Parameters:

id - The identifier for the ConfigInfo

Returns:

The sought for ConfigInfo or null if not found.

lookupConfigFileNameById

public static ConfigFileName lookupConfigFileNameById(java.lang.Long id)

Finds a ConfigFileName from the database with a given id.

Parameters:

id - The identifier for the ConfigFileName

Returns:

The sought for ConfigFileName or null if not found.

lookupOrInsertConfigInfo

public static ConfigInfo lookupOrInsertConfigInfo(java.lang.String username,
                                                  java.lang.String groupname,
                                                  java.lang.Long filemode,
                                                  java.lang.String selinuxCtx,
                                                  java.lang.String symlinkTargetPath)

Return a ConfigInfo from the username, groupname, file mode, and selinux context. If no corresponding entry exists yet in the database, one will be created. Uses the stored procedure lookup_config_info to get the id of the ConfigInfo and then uses hibernate to lookup using that id. Note: we should use the stored procedure because it is autonomous and avoids race conditions. However, we also need to make sure that hibernate knows that the object already exists in the database. Therefore after storing it, instead of simply creating the object in java, we ask hibernate to look it up (which will find the correct created and modified dates as well). ConfigInfo's have a unique constraint around username, groupname, and filemode so we can't just create them willy nilly.

Parameters:

username - The linux username associated with a file

groupname - The linux groupname associated with a file

filemode - The three digit file mode (ex: 655)

selinuxCtx - The SELinux context

symlinkTargetPath - a target path for symlink or null for a non symlink path

Returns:

The ConfigInfo found or inserted.

lookupOrInsertConfigFileName

public static ConfigFileName lookupOrInsertConfigFileName(java.lang.String path)

Return a ConfigFileName for the path given. If no corresponding entry exists yet in the database, one will be created. Uses the stored procedure lookup_config_filename to get the id of the ConfigFileName and then uses hibernate to lookup using that id. Note: we should use the stored procedure because it is autonomous and avoids race conditions. However, we also need to make sure that hibernate knows that the object already exists in the database. Therefore after storing it, instead of simply creating the object in java, we ask hibernate to look it up (which will find the correct created and modified dates as well). ConfigFileName's have a unique constraint around path so we can't just create them willy nilly.

Parameters:

path - the path for the ConfigFileName

Returns:

The ConfigFileName found

removeConfigChannel

public static void removeConfigChannel(ConfigChannel channel)

Remove a ConfigChannel. This uses a stored procedure and the stored procedure is required as it performs logic to determine the amount of org quota is now used and appropriately updates those tables.

Parameters:

channel - Channel to remove

removeConfigFile

public static void removeConfigFile(ConfigFile file)

Remove a ConfigFile. This uses a stored procedure and the stored procedure is required as it performs logic to determine the amount of org quota is now used and appropriately updates those tables.

Parameters:

file - Config File to remove

removeConfigRevision

public static boolean removeConfigRevision(ConfigRevision revision,
                                           java.lang.Long orgId)

Remove a ConfigRevision. This uses a stored procedure and the stored procedure is required as it performs logic to determine the amount of org quota is now used and appropriately updates those tables.

Parameters:

revision - Revision to remove

orgId - The id for the org in which this revision is located.

Returns:

whether the parent file was deleted too.

createNewLocalChannel

public static ConfigChannel createNewLocalChannel(Server server,
                                                  ConfigChannelType type)

Create a local config channel for the given server. Fills in the necessary fields with standard information.

Parameters:

server - The server used to help populate required fields

type - The type of the config channel. Either sandbox or local override.

Returns:

The new local config channel.

createNewRevisionFromStream

public static ConfigRevision createNewRevisionFromStream(User usr,
                                                         java.io.InputStream stream,
                                                         java.lang.Long size,
                                                         ConfigFile file)

Creates a new revision object from the give input stream. The size is set to be the given size. The revision object is placed into the given config file and uses the meta-data from the latest revision in that file.

Parameters:

usr - The user that is making the new revision

stream - The input stream containing the content for this revision.

size - The size of the input stream to be read.

file - The parent object for this config revision.

Returns:

The newly created config revision.

createNewContentFromStream

public static ConfigContent createNewContentFromStream(java.io.InputStream stream,
                                                       java.lang.Long size,
                                                       boolean isBinary,
                                                       java.lang.String delimStart,
                                                       java.lang.String delimEnd)

Creates a ConfigContent object whose BLOB is filled with the bytes from the specified stream

Parameters:

stream - stream containing the content

size - number of bytes to read

isBinary - true if the content is to be treated as binary (which means we won't expand macros, morph EOL, or let you edit it from the web UI)

delimStart - start delimeter or null for binary

delimEnd - end delimeter or null for binary

Returns:

filled-in ConfigContent

bytesFromStream

public static byte[] bytesFromStream(java.io.InputStream stream,
                                     java.lang.Long size)

Convert input stream to byte array

Parameters:

stream - input stream

size - stream size

Returns:

byte array

getNextRevisionForFile

public static java.lang.Long getNextRevisionForFile(ConfigFile file)

Returns new revision number for config file

Parameters:

file - config file

Returns:

next revision number

copyRevisionToChannel

public static void copyRevisionToChannel(User usr,
                                         ConfigRevision revision,
                                         ConfigChannel channel)

Copies the given config revision to the given channel. If there is a candidate config file that exists in that channel, this revision gets set as the newest revision there. Otherwise, a new config file is created with this as its only revision.

Parameters:

usr - The user asking for the new revision

revision - The revision to be copied

channel - The channel to be copied into

getChannelNameDisplay

public static java.lang.String getChannelNameDisplay(java.lang.String type,
                                                     java.lang.String channel)

Returns a localized string for the name of a config channel. This is here because local and sandbox config channels are created automatically and therefore have english names. This is located in this file to be a central location for the logic.

Parameters:

type - The type of the channel (one of the labels for CONFIG_CHANNEL_TYPE_* constants)

channel - The name of the channel, the system name for local channels.

Returns:

A localized string for channel name