com.redhat.rhn.manager.ssm

Class SsmOperationManager

java.lang.Object

com.redhat.rhn.manager.BaseManager

com.redhat.rhn.manager.ssm.SsmOperationManager

public class SsmOperationManager
extends BaseManager

Handles the tracking of SSM asynchronous operations, providing functionality for the creation, update, and retrieval of the data.

Method Summary

Modifier and Type	Method and Description
static void	addNoteToOperationOnServer(long operationId, long serverId, java.lang.String note) Updates an association between an operation and a server adding a note.
static DataResult<OperationDetailsDto>	allOperations(User user) Returns a list of all operations for the given user, regardless of their status.
static void	associateServersWithOperation(long operationId, long userId, java.util.List<java.lang.Long> sidsIn) Associates an operation with a group of servers against which it was run, where a list of server ids are passed in
static void	associateServersWithOperation(long operationId, long userId, java.lang.String setLabel) Associates an operation with a group of servers against which it was run, where the servers are found in an RhnSet.
static DataResult<OperationDetailsDto>	completedOperations(User user) Returns a list of all operations for the given user that have completed.
static void	completeOperation(User user, long operationId) Indicates the operation has completed, updating its status to indicate this.
static long	createOperation(User user, java.lang.String messageId, java.lang.String rhnSetLabel) Creates a new operation, defaulting the status to "in progress".
static OperationDetailsDto	findOperationById(User user, long operationId) Returns the details of the given operation.
static DataResult	findServerDataForOperation(long operationId) Returns a list of servers that took part in the given SSM operation.
static DataResult<OperationDetailsDto>	inProgressOperations(User user) Returns a list of all operations for the given user that are currently executing.

Methods inherited from class com.redhat.rhn.manager.BaseManager

makeDataResult, makeDataResult, makeDataResult, makeDataResult, makeDataResultNoPagination, makeDataResultNoPagination, processListControl, processPageControl

Methods inherited from class java.lang.Object

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

Method Detail

allOperations

public static DataResult<OperationDetailsDto> allOperations(User user)

Returns a list of all operations for the given user, regardless of their status.

Parameters:

user - operations returned only for this user; cannot be null

Returns:

list of maps containing the data describing each operation

inProgressOperations

public static DataResult<OperationDetailsDto> inProgressOperations(User user)

Returns a list of all operations for the given user that are currently executing.

Parameters:

user - operations returned only for this user; cannot be null

Returns:

list of maps containing the data describing each matching operation

completedOperations

public static DataResult<OperationDetailsDto> completedOperations(User user)

Returns a list of all operations for the given user that have completed.

Parameters:

user - operations returned only for this user; cannot be null

Returns:

list of maps containing the data describing each matching operation

findOperationById

public static OperationDetailsDto findOperationById(User user,
                                                    long operationId)

Returns the details of the given operation.

Parameters:

user - verifies that the user isn't trying to load someone else's operation; cannot be null

operationId - database ID of the operation to load

Returns:

OperationsDto given an operation id or null.

createOperation

public static long createOperation(User user,
                                   java.lang.String messageId,
                                   java.lang.String rhnSetLabel)

Creates a new operation, defaulting the status to "in progress".

For efficiency, this call assumes the following:

• The set of servers that are taking place in the operation are already in the database as an RhnSet (the name of set is passed into this call).
• The server ID is stored in the first element (i.e. "element" in the set table).

This should be a safe assumption since, at very least, if all servers are taking place in the operation they are already in the SSM RhnSet. If only a subset is needed, a nested select can be used to drop them into a new set, preventing the need to have another insert per server for this call.

Parameters:

user - user under which to associate the operation; cannot be null

messageId - message id of operation description; cannot be null

rhnSetLabel - references a RhnSet with the server IDs to associate with the new operation; if this is null no mappings will be created at this time

Returns:

the id of the created operation

completeOperation

public static void completeOperation(User user,
                                     long operationId)

Indicates the operation has completed, updating its status to indicate this.

Parameters:

user - verifies that the user isn't trying to load someone else's operation; cannot be null

operationId - database ID of the operation to update

findServerDataForOperation

public static DataResult findServerDataForOperation(long operationId)

Returns a list of servers that took part in the given SSM operation.

Parameters:

operationId - operation for which to return the server IDs

Returns:

list of maps, one per server ID, where each map contains a single entry (key: server_id) containing the server ID

associateServersWithOperation

public static void associateServersWithOperation(long operationId,
                                                 long userId,
                                                 java.lang.String setLabel)

Associates an operation with a group of servers against which it was run, where the servers are found in an RhnSet. The IDs for these servers must be stored in the "element" field of the RhnSet.

Parameters:

operationId - identifies an existing operation to associate with servers

userId - identifies the user performing the operation

setLabel - identifies the set in which to find server IDs

associateServersWithOperation

public static void associateServersWithOperation(long operationId,
                                                 long userId,
                                                 java.util.List<java.lang.Long> sidsIn)

Associates an operation with a group of servers against which it was run, where a list of server ids are passed in

Parameters:

operationId - identifies an existing operation to associate with servers

userId - identifies the user performing the operation

sidsIn - the list server ids

addNoteToOperationOnServer

public static void addNoteToOperationOnServer(long operationId,
                                              long serverId,
                                              java.lang.String note)

Updates an association between an operation and a server adding a note.

Parameters:

operationId - identifies an existing operation

serverId - identifies the server on which the operation failed

note - note to be added