co.ecg.alpaca.toolkit.helper.migration.group

Class GroupMigration

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<Group,GroupInformation,AbstractTransform<GroupInformation>,GroupMigration.Step,GroupMigration>

co.ecg.alpaca.toolkit.helper.migration.group.GroupMigration

All Implemented Interfaces:

Executable<Group>, Loggable

public class GroupMigration
extends AbstractMigration<Group,GroupInformation,AbstractTransform<GroupInformation>,GroupMigration.Step,GroupMigration>

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

Author:

Matthew Keathley on 3/29/16.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GroupMigration.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
GroupMigration(GroupInformation inputInformation, AbstractTransform<GroupInformation>... transform) Performs the migration of a Group 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.
Group	execute() Performs the migration process in a step by step approach.
GroupDestroy	getGroupDestroy()
GroupImport	getGroupImport()

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

GroupMigration

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

Performs the migration of a Group by removing it and recreating with the specified add request. This process attempts to be comprehensive. It migrates all service settings and Group level service information. In addition, it migrates complete access device and user information.

Parameters:

inputInformation - The input GroupInformation to be migrated

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

Throws:

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

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

See Also:

Group.GroupAddRequest, Group

Method Detail

getGroupImport

public GroupImport getGroupImport()

getGroupDestroy

public GroupDestroy getGroupDestroy()

execute

public Group 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 Group following migration

Throws:

HelperException - Thrown if an error during execution occurs.

checkMigrationValidity

public void checkMigrationValidity()
                            throws HelperException

Checks the migration encumbrances and requirements.

Throws:

HelperException - Thrown if the migration is invalid.

See Also:

EncumbranceError