alma.acs.commandcenter.serviceshelper

Class StartServicesHelper

java.lang.Object

alma.acs.commandcenter.serviceshelper.StartServicesHelper

public class StartServicesHelper
extends java.lang.Object

An helper to start the ACS services defined in the TMCDB with the services daemon.

The reference to the services daemon is acquired before starting/stopping services and released when the operation terminates.

Author:

acaproni

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	StartServicesHelper.AlarmServicesDefinitionHolder An object to hold the definitions of the services to start.
class	StartServicesHelper.DaemonException Encapsulate the exception returned by the daemon
class	StartServicesHelper.DaemonSequenceCallbackImpl The callback to notify the listeners about the progress of the async start/stop of services.
class	StartServicesHelper.GettingDaemonException The exception returned when an error happens getting the services daemon.
static interface	StartServicesHelper.ServicesListener The listener of events generated starting and stopping the services.
class	StartServicesHelper.TMCDBException The exception in case of error from the TMCDB

Constructor Summary

Constructors

Constructor and Description
StartServicesHelper(Session session, java.lang.String configurationName, AcsCorba acsCorba, AcsLogger logger, java.lang.String daemonHost, int instance) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addServiceListener(StartServicesHelper.ServicesListener listener) Add a listener to be notified about the progress of the start/stop of services.
StartServicesHelper.AlarmServicesDefinitionHolder	getServicesDescription() Reads from the TMCDB the list of ACS services to start.
boolean	removeServiceListener(StartServicesHelper.ServicesListener listener) Remove the passed listener of the start/stop of services.
StartServicesHelper.AlarmServicesDefinitionHolder	startACSServices() Starts the services as they are defined in the TMCDB.
void	startACSServices(java.lang.String xmlListOfServices) Starts the services whose XML definition is in the parameter.
void	stopServices(java.lang.String xmlListOfServices) Stops the services whose definition is in the passed parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

StartServicesHelper

public StartServicesHelper(Session session,
                           java.lang.String configurationName,
                           AcsCorba acsCorba,
                           AcsLogger logger,
                           java.lang.String daemonHost,
                           int instance)

Constructor.

Parameters:

Session - The hibernate session to read data from the TMCDB

configurationName - The name of the configuration

acsCorba - The AcsCorba

logger - The logger

daemonHost - The host where the service daemon runs

instance - The ACS instance

Method Detail

getServicesDescription

public StartServicesHelper.AlarmServicesDefinitionHolder getServicesDescription()
                                                                         throws StartServicesHelper.GettingDaemonException,
                                                                                StartServicesHelper.DaemonException,
                                                                                StartServicesHelper.TMCDBException

Reads from the TMCDB the list of ACS services to start. The definition of the services and the host where we want to deploy them is sent to an acs daemon in order to build an XML representation that can be later used by the daemons to start all the services.

Using this method is optional and expected only for special cases (in conjunction with startACSServices(java.lang.String)), because method startACSServices(java.lang.String) includes this step.

This method delegates to #internalGetServicesDescritpion(ServicesDaemon, ServiceDefinitionBuilder)

Returns:

A struct with the XML representation of the services to start and the services to start read from the TMCDB

Throws:

StartServicesHelper.GettingDaemonException - In case of error getting the daemon

StartServicesHelper.DaemonException - In case of error from the daemon

StartServicesHelper.TMCDBException - If the list of service read from the TMCDB is empty

See Also:

#internalGetServicesDescritpion(ServicesDaemon, ServiceDefinitionBuilder)

startACSServices

public void startACSServices(java.lang.String xmlListOfServices)
                      throws StartServicesHelper.GettingDaemonException,
                             StartServicesHelper.DaemonException

Starts the services whose XML definition is in the parameter.

The real starting of services is delegated to #internalStartServices(ServicesDaemon, ServiceDefinitionBuilder, String) The starting of the services is delegated to a acs service daemon.

Parameters:

xmlListOfServices - The XML describing the list of services to start. It is generally returned by getServicesDescription()

Throws:

StartServicesHelper.GettingDaemonException - in case of error getting the services daemon

StartServicesHelper.DaemonException - In case of error from the daemon

startACSServices

public StartServicesHelper.AlarmServicesDefinitionHolder startACSServices()
                                                                   throws StartServicesHelper.GettingDaemonException,
                                                                          HibernateException,
                                                                          StartServicesHelper.DaemonException,
                                                                          StartServicesHelper.TMCDBException

Starts the services as they are defined in the TMCDB. This method is a convenience that before first gets the list of services from the TMCDB by calling getServicesDescription() and then executes startACSServices(String xmlListOfServices)

The real starting of services is delegated to #internalStartServices(ServicesDaemon, ServiceDefinitionBuilder, String)

Returns:

A struct with the An XML representation of the started services, to be used in stopServices(java.lang.String) and a list of services as they have been read from the TMCDB

Throws:

StartServicesHelper.GettingDaemonException - in case of error getting the services daemon

HibernateException - In case of error reading the services from the TMCDB

DaemonExceptionIn - case of error from the daemon

StartServicesHelper.TMCDBException - If the list of services read from the TMCDB is empty

StartServicesHelper.DaemonException

See Also:

StartServicesHelper.AlarmServicesDefinitionHolder

stopServices

public void stopServices(java.lang.String xmlListOfServices)
                  throws StartServicesHelper.GettingDaemonException,
                         StartServicesHelper.DaemonException

Stops the services whose definition is in the passed parameter.

Parameters:

xmlListOfServices - The XML describing the list of services to stop.

Throws:

StartServicesHelper.GettingDaemonException - In case of error getting the services daemon

StartServicesHelper.DaemonException - In case of error from the services daemon

addServiceListener

public void addServiceListener(StartServicesHelper.ServicesListener listener)

Add a listener to be notified about the progress of the start/stop of services.

Parameters:

listener - The not null listener to add.

removeServiceListener

public boolean removeServiceListener(StartServicesHelper.ServicesListener listener)

Remove the passed listener of the start/stop of services.

Parameters:

listener - The not null listener to remove.

Returns:

true if this set contained the specified element