org.wso2.carbon.lcm.sql.dao

Class LifecycleMgtDAO

java.lang.Object

org.wso2.carbon.lcm.sql.dao.LifecycleMgtDAO

public class LifecycleMgtDAO
extends Object

This class represent the DAO layer for lifecycle related operations.

Method Summary

Modifier and Type	Method and Description
String	addLifecycleState(String initialState, String lcName, String user) Set initial lifecycle state.
void	addLifecycleState(String initialState, String uuid, String lcName, String user) Set initial lifecycle state with lifecycle id as input.
void	changeCheckListItemData(String uuid, String lcState, String checkListName, boolean value) Method used to update data related to check list item operation.
void	changeLifecycleState(LifecycleStateBean lifecycleStateBean, String user) Change lifecycle state.
static LifecycleMgtDAO	getInstance() Method to get the instance of the LCMgtDAO.
LifecycleStateBean	getLifecycleCheckListDataFromState(String uuid, String lcState) Get lifecycle check list data for a particular uuid and state.
List<LifecycleHistoryBean>	getLifecycleHistoryFromId(String uuid) Method used to get lifecycle history related to particular uuid.
List<String>	getLifecycleIdsFromState(String state, String lcName) This method provides set of lifecycle ids in a particular state.
LifecycleStateBean	getLifecycleStateDataFromId(String uuid) Get lifecycle state data for a particular uuid.
void	removeLifecycleState(String uuid) Method used to remove lifecycle state data for a given id.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static LifecycleMgtDAO getInstance()

Method to get the instance of the LCMgtDAO.

Returns:

LifecycleMgtDAO instance

addLifecycleState

public String addLifecycleState(String initialState,
                                String lcName,
                                String user)
                         throws LifecycleManagerDatabaseException

Set initial lifecycle state.

Parameters:

initialState - Initial state provided in lifecycle config.

lcName - Name of the lifecycle

user - The user who invoked the action. This will be used for auditing purposes.

Returns:

UUID generated by framework which is stored as reference by external systems.

Throws:

LifecycleManagerDatabaseException - If failed to add initial lifecycle state.

addLifecycleState

public void addLifecycleState(String initialState,
                              String uuid,
                              String lcName,
                              String user)
                       throws LifecycleManagerDatabaseException

Set initial lifecycle state with lifecycle id as input.

Parameters:

initialState - Initial state provided in lifecycle config.

uuid - Lifecycle Id;

lcName - Name of the lifecycle

user - The user who invoked the action. This will be used for auditing purposes. external systems.

Throws:

LifecycleManagerDatabaseException - If failed to add initial lifecycle state.

changeLifecycleState

public void changeLifecycleState(LifecycleStateBean lifecycleStateBean,
                                 String user)
                          throws LifecycleManagerDatabaseException

Change lifecycle state.

Parameters:

lifecycleStateBean - Bean containing lifecycle id and required state.

user - The user who invoked the action. This will be used for auditing purposes.

Throws:

LifecycleManagerDatabaseException - If failed to change lifecycle state.

getLifecycleStateDataFromId

public LifecycleStateBean getLifecycleStateDataFromId(String uuid)
                                               throws LifecycleManagerDatabaseException

Get lifecycle state data for a particular uuid.

Parameters:

uuid - Reference variable that maps lc data with external system.

Returns:

Life cycle state bean with all the required information

Throws:

LifecycleManagerDatabaseException - If failed to get lifecycle state data.

getLifecycleCheckListDataFromState

public LifecycleStateBean getLifecycleCheckListDataFromState(String uuid,
                                                             String lcState)
                                                      throws LifecycleManagerDatabaseException

Get lifecycle check list data for a particular uuid and state.

Parameters:

uuid - Reference variable that maps lc data with external system.

lcState - State in which checklist date required.

Returns:

Life cycle state bean with all the required information

Throws:

LifecycleManagerDatabaseException - If failed to get lifecycle state data.

getLifecycleHistoryFromId

public List<LifecycleHistoryBean> getLifecycleHistoryFromId(String uuid)
                                                     throws LifecycleManagerDatabaseException

Method used to get lifecycle history related to particular uuid.

Parameters:

uuid - UUID of the lifecycle state. (Associates with asset)

Returns:

List of state transitions for given uuid.

Throws:

LifecycleManagerDatabaseException - If failed to get lifecycle history from db.

removeLifecycleState

public void removeLifecycleState(String uuid)
                          throws LifecycleManagerDatabaseException

Method used to remove lifecycle state data for a given id.

Parameters:

uuid - UUID of the lifecycle state. (Associates with asset)

Throws:

LifecycleManagerDatabaseException - If failed to delete lifecycle state.

changeCheckListItemData

public void changeCheckListItemData(String uuid,
                                    String lcState,
                                    String checkListName,
                                    boolean value)
                             throws LifecycleManagerDatabaseException

Method used to update data related to check list item operation.

Parameters:

uuid - UUID of the lifecycle state. (Associates with asset)

lcState - State in which the checklist is associated with.

checkListName - Name of the check list in which operation was performed

value - Value of the check list item. (Selected or not selected)

Throws:

LifecycleManagerDatabaseException - If failed to change check list item data.

getLifecycleIdsFromState

public List<String> getLifecycleIdsFromState(String state,
                                             String lcName)
                                      throws LifecycleManagerDatabaseException

This method provides set of lifecycle ids in a particular state.

Parameters:

state` -

lcName -

Returns:

List of lifecycle ids in the given state.

Throws:

LifecycleManagerDatabaseException - If failed to get lifecycle ids from database.