com.redhat.rhn.domain.action

Class ActionChainFactory

java.lang.Object

com.redhat.rhn.common.hibernate.HibernateFactory

com.redhat.rhn.domain.action.ActionChainFactory

public class ActionChainFactory
extends HibernateFactory

Creates Action Chain related objects.

Method Summary

Modifier and Type	Method and Description
static ActionChain	createActionChain(java.lang.String label, User user) Creates a new ActionChain object.
static void	delete(ActionChain actionChain) Deletes an Action Chain and all associated objects.
static ActionChain	getActionChain(User requestor, java.lang.Long id) Gets an Action Chain by id.
static ActionChain	getActionChain(User requestor, java.lang.String label) Gets an action chain by label.
static java.util.List<ActionChainEntry>	getActionChainEntries(ActionChain actionChain, java.lang.Integer sortOrder) Returns entries from a chain having a certain sort order number
static ActionChainEntry	getActionChainEntry(User requestor, java.lang.Long id) Gets an Action Chain Entry by id.
static java.util.List<ActionChainEntryGroup>	getActionChainEntryGroups(ActionChain actionChain) Returns ActionChainEntryGroupDto objects corresponding to groups of Action Chain entries with the same sort order and action type.
static java.util.List<ActionChain>	getActionChains(User requestor) Gets all action chains for a user.
static java.util.List<ActionChain>	getActionChainsByModificationDate(User requestor) Gets all action chains, by modification date.
protected org.apache.log4j.Logger	getLogger() Get the Logger for the derived class so log messages show up on the correct class
static int	getNextSortOrderValue(ActionChain actionChain) Gets the next sort order value.
static ActionChain	getOrCreateActionChain(java.lang.String label, User user) Looks for an action chain by label, and creates one if not found.
static ActionChainEntry	queueActionChainEntry(Action action, ActionChain actionChain, java.lang.Long serverId) Creates a new entry in an Action Chain object.
static ActionChainEntry	queueActionChainEntry(Action action, ActionChain actionChain, java.lang.Long serverId, int sortOrder) Creates a new entry in an Action Chain object.
static ActionChainEntry	queueActionChainEntry(Action action, ActionChain actionChain, Server server) Creates a new entry in an Action Chain object, sort order will be incremented.
static ActionChainEntry	queueActionChainEntry(Action action, ActionChain actionChain, Server server, int sortOrder) Creates a new entry in an Action Chain object.
static ActionChainEntry	queueActionChainEntry(Action action, ActionChain actionChain, SystemOverview systemOverview) Creates a new entry in an Action Chain object.
static void	removeActionChainEntry(ActionChain actionChain, ActionChainEntry entry) Remove an entry from the action chain
static void	removeActionChainEntrySortGaps(ActionChain actionChain, int removedOrder) Remove gaps from entries in an action chain
static void	schedule(ActionChain actionChain, java.util.Date date) Schedules an Action Chain for execution.

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

getActionChain

public static ActionChain getActionChain(User requestor,
                                         java.lang.String label)

Gets an action chain by label.

Parameters:

requestor - the user whose chain we're looking for

label - the label

Returns:

the Action Chain or null if not found

getActionChain

public static ActionChain getActionChain(User requestor,
                                         java.lang.Long id)
                                  throws org.hibernate.ObjectNotFoundException

Gets an Action Chain by id.

Parameters:

requestor - the user whose chain we're looking for

id - the id

Returns:

the Action Chain

Throws:

org.hibernate.ObjectNotFoundException - if there is no such id accessible to the requestor

getActionChainEntry

public static ActionChainEntry getActionChainEntry(User requestor,
                                                   java.lang.Long id)
                                            throws org.hibernate.ObjectNotFoundException

Gets an Action Chain Entry by id.

Parameters:

requestor - the user whose entry we're looking for

id - the action chain entry id

Returns:

the Action Chain Entry

Throws:

org.hibernate.ObjectNotFoundException - if there is no such id accessible to the requestor

createActionChain

public static ActionChain createActionChain(java.lang.String label,
                                            User user)

Creates a new ActionChain object.

Parameters:

label - the label

user - the user

Returns:

the action chain

getOrCreateActionChain

public static ActionChain getOrCreateActionChain(java.lang.String label,
                                                 User user)

Looks for an action chain by label, and creates one if not found.

Parameters:

label - the label

user - the currently logged in user

Returns:

the action chain

queueActionChainEntry

public static ActionChainEntry queueActionChainEntry(Action action,
                                                     ActionChain actionChain,
                                                     Server server)

Creates a new entry in an Action Chain object, sort order will be incremented.

Parameters:

action - the action

actionChain - the action chain

server - the server

Returns:

the action chain entry

queueActionChainEntry

public static ActionChainEntry queueActionChainEntry(Action action,
                                                     ActionChain actionChain,
                                                     Server server,
                                                     int sortOrder)

Creates a new entry in an Action Chain object.

Parameters:

action - the action

actionChain - the action chain

server - the server

sortOrder - the required sort order

Returns:

the action chain entry

queueActionChainEntry

public static ActionChainEntry queueActionChainEntry(Action action,
                                                     ActionChain actionChain,
                                                     java.lang.Long serverId)

Creates a new entry in an Action Chain object.

Parameters:

action - the action

actionChain - the action chain

serverId - the server id

Returns:

the action chain entry

queueActionChainEntry

public static ActionChainEntry queueActionChainEntry(Action action,
                                                     ActionChain actionChain,
                                                     java.lang.Long serverId,
                                                     int sortOrder)

Creates a new entry in an Action Chain object.

Parameters:

action - the action

actionChain - the action chain

serverId - the server id

sortOrder - the required sort order

Returns:

the action chain entry

queueActionChainEntry

public static ActionChainEntry queueActionChainEntry(Action action,
                                                     ActionChain actionChain,
                                                     SystemOverview systemOverview)

Creates a new entry in an Action Chain object.

Parameters:

action - the action

actionChain - the action chain

systemOverview - the server overview object

Returns:

the action chain entry

getActionChains

public static java.util.List<ActionChain> getActionChains(User requestor)

Gets all action chains for a user.

Parameters:

requestor - the user whose chains we're looking for

Returns:

action chains

getActionChainsByModificationDate

public static java.util.List<ActionChain> getActionChainsByModificationDate(User requestor)

Gets all action chains, by modification date.

Parameters:

requestor - the user whose chain we're looking for

Returns:

action chains

getActionChainEntryGroups

public static java.util.List<ActionChainEntryGroup> getActionChainEntryGroups(ActionChain actionChain)

Returns ActionChainEntryGroupDto objects corresponding to groups of Action Chain entries with the same sort order and action type.

Parameters:

actionChain - an Action Chain

Returns:

a list of corresponding groups

getActionChainEntries

public static java.util.List<ActionChainEntry> getActionChainEntries(ActionChain actionChain,
                                                                     java.lang.Integer sortOrder)

Returns entries from a chain having a certain sort order number

Parameters:

actionChain - the chain

sortOrder - the sort order

Returns:

an entry list

getNextSortOrderValue

public static int getNextSortOrderValue(ActionChain actionChain)

Gets the next sort order value.

Parameters:

actionChain - the action chain

Returns:

the next sort order value

delete

public static void delete(ActionChain actionChain)

Deletes an Action Chain and all associated objects.

Parameters:

actionChain - the action chain to delete

schedule

public static void schedule(ActionChain actionChain,
                            java.util.Date date)

Schedules an Action Chain for execution.

Parameters:

actionChain - the action chain to execute

date - first action's minimum timestamp

getLogger

protected org.apache.log4j.Logger getLogger()

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.

removeActionChainEntrySortGaps

public static void removeActionChainEntrySortGaps(ActionChain actionChain,
                                                  int removedOrder)

Remove gaps from entries in an action chain

Parameters:

actionChain - An ActionChain from which to be removed.

removedOrder - sort order of the (already) removed entry

removeActionChainEntry

public static void removeActionChainEntry(ActionChain actionChain,
                                          ActionChainEntry entry)

Remove an entry from the action chain

Parameters:

actionChain - An ActionChain from which to be removed.

entry - entry to remove