co.ecg.alpaca.toolkit.helper.migration.serviceprovider

Class ServiceProviderMigration

java.lang.Object

co.ecg.alpaca.toolkit.helper.model.ErrorableProcess

co.ecg.alpaca.toolkit.helper.model.IterableProcess<E,S>

co.ecg.alpaca.toolkit.helper.migration.AbstractMigration<ServiceProvider,ServiceProviderInformation,AbstractTransform<ServiceProviderInformation>,ServiceProviderMigration.Step,ServiceProviderMigration>

co.ecg.alpaca.toolkit.helper.migration.serviceprovider.ServiceProviderMigration

All Implemented Interfaces:

Executable<ServiceProvider>, Loggable

public class ServiceProviderMigration
extends AbstractMigration<ServiceProvider,ServiceProviderInformation,AbstractTransform<ServiceProviderInformation>,ServiceProviderMigration.Step,ServiceProviderMigration>

The ServiceProviderMigration class handles the movement of ServiceProvider settings within BroadWorks. This is commonly called - migration, reincarnation, and replacement. This class should contain migration specific tools whereas generalized ServiceProvider tools would be in the ServiceProviderHelper

Author:

Matthew Keathley on 7/12/16.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceProviderMigration.Step

Field Summary

Fields inherited from class co.ecg.alpaca.toolkit.helper.model.IterableProcess

stepList

Fields inherited from class co.ecg.alpaca.toolkit.helper.model.ErrorableProcess

errors, log, warnings

Constructor Summary

Constructors

Constructor and Description
ServiceProviderMigration(ServiceProviderInformation inputInformation, AbstractTransform<ServiceProviderInformation>... transform) Performs the migration of a ServiceProvider by removing it and recreating with the specified add request.

Method Summary

Modifier and Type	Method and Description
void	checkMigrationValidity() Checks the migration encumbrances and requirements.
ServiceProvider	execute() Performs the migration process in a step by step approach.
ServiceProviderDestroy	getServiceProviderDestroy()
ServiceProviderImport	getServiceProviderImport()

Methods inherited from class co.ecg.alpaca.toolkit.helper.migration.AbstractMigration

concurrencyCheck, getDestinationBroadWorksServer, getInput, getInputInformation, getOutput, getOutputInformation, getSourceBroadWorksServer, setOutput

Methods inherited from class co.ecg.alpaca.toolkit.helper.model.IterableProcess

addStep, addStep, all, allBut, getStepCount, isConcurrent, only, removeStep, setConcurrent, step, step

Methods inherited from class co.ecg.alpaca.toolkit.helper.model.ErrorableProcess

checkValidity, exception, getErrors, getReport, getWarnings, hasErrors, isError, isError, isError, printReport, setExceptionOnErrors

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.ecg.alpaca.toolkit.helper.model.Loggable

getSessionLogger, logger

Constructor Detail

ServiceProviderMigration

@SafeVarargs
public ServiceProviderMigration(ServiceProviderInformation inputInformation,
                                             AbstractTransform<ServiceProviderInformation>... transform)
                                      throws HelperException,
                                             co.ecg.licensing.LicenseException

Performs the migration of a ServiceProvider by removing it and recreating with the specified add request. This process attempts to be comprehensive.

Parameters:

inputInformation - The input ServiceProviderInformation to be migrated

transform - The information transformation to occur prior to the migration process

Throws:

co.ecg.licensing.LicenseException - Thrown if ServiceProviderMigration is not licensed

HelperException - Throws an exception if an error during migration occurs.

See Also:

ServiceProvider.ServiceProviderAddRequest, ServiceProvider

Method Detail

getServiceProviderImport

public ServiceProviderImport getServiceProviderImport()

getServiceProviderDestroy

public ServiceProviderDestroy getServiceProviderDestroy()

execute

public ServiceProvider execute()
                        throws HelperException

Performs the migration process in a step by step approach. Any error causes the migration to halt and get marked as failed.

Returns:

The new ServiceProvider following migration

Throws:

HelperException - Thrown if an error occurs during migration.

checkMigrationValidity

public void checkMigrationValidity()
                            throws HelperException

Checks the migration encumbrances and requirements.

Throws:

HelperException - Thrown if the migration is invalid.

See Also:

EncumbranceError