co.ecg.alpaca.toolkit.helper.migration.device

Class GroupAccessDeviceMigration

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<O,I,AbstractTransform<O,I>,E,T>

co.ecg.alpaca.toolkit.helper.migration.device.AbstractDeviceMigration<co.ecg.alpaca.toolkit.generated.GroupAccessDevice,GroupAccessDeviceInformation,GroupAccessDeviceMigration.Step,GroupAccessDeviceMigration>

co.ecg.alpaca.toolkit.helper.migration.device.GroupAccessDeviceMigration

All Implemented Interfaces:

Executable<co.ecg.alpaca.toolkit.generated.GroupAccessDevice>, Loggable

public class GroupAccessDeviceMigration
extends AbstractDeviceMigration<co.ecg.alpaca.toolkit.generated.GroupAccessDevice,GroupAccessDeviceInformation,GroupAccessDeviceMigration.Step,GroupAccessDeviceMigration>

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

Author:

Matthew Keathley - mkeathley@e-c-group.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GroupAccessDeviceMigration.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
GroupAccessDeviceMigration(GroupAccessDeviceInformation inputInformation, AbstractTransform<co.ecg.alpaca.toolkit.generated.GroupAccessDevice,GroupAccessDeviceInformation>... transformation) Creates a new GroupAccessDevice migration object with the input device as the source and the add request as the target.

Method Summary

Modifier and Type	Method and Description
co.ecg.alpaca.toolkit.generated.GroupAccessDevice	execute() Performs Migration of a Group Access Device.
GroupAccessDeviceDestroy	getGroupAccessDeviceDestroy() Method to retrieve the GroupAccessDeviceDestroy.
GroupAccessDeviceImport	getGroupAccessDeviceImport() Method to retrieve the GroupAccessDeviceImport.

Methods inherited from class co.ecg.alpaca.toolkit.helper.migration.device.AbstractDeviceMigration

checkDeviceTypeCompatibility

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, isConcurrent, only, removeStep, setConcurrent, 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

GroupAccessDeviceMigration

@SafeVarargs
public GroupAccessDeviceMigration(GroupAccessDeviceInformation inputInformation,
                                               AbstractTransform<co.ecg.alpaca.toolkit.generated.GroupAccessDevice,GroupAccessDeviceInformation>... transformation)
                                        throws HelperException,
                                               co.ecg.licensing.LicenseException

Creates a new GroupAccessDevice migration object with the input device as the source and the add request as the target.

Parameters:

inputInformation - The input Device Information

transformation - The transformation to occur on the information before migration

Throws:

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

HelperException - Thrown when an error occurs during the creation of the migration object

See Also:

GroupAccessDevice

Method Detail

getGroupAccessDeviceDestroy

public GroupAccessDeviceDestroy getGroupAccessDeviceDestroy()

Method to retrieve the GroupAccessDeviceDestroy.

Returns:

The GroupAccessDeviceDestroy.

See Also:

GroupAccessDeviceDestroy

getGroupAccessDeviceImport

public GroupAccessDeviceImport getGroupAccessDeviceImport()

Method to retrieve the GroupAccessDeviceImport.

Returns:

The GroupAccessDeviceImport.

See Also:

GroupAccessDeviceImport

execute

public co.ecg.alpaca.toolkit.generated.GroupAccessDevice execute()
                                                          throws HelperException

Performs Migration of a Group Access Device. This will migrate a Device's Users, Tags, and Directory Entries to a new Device based on the supplied Add Request. The add request should already contain the desired GroupAccessDevice basic information. This will typically be done with RequestHelper.

Returns:

Returns the newly created GroupAccessDevice

Throws:

HelperException - Thrown when an error is occurred during the migration process

See Also:

GroupAccessDevice