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

Class AbstractDeviceImport<T extends co.ecg.alpaca.toolkit.generated.AccessDevice,R extends co.ecg.alpaca.toolkit.messaging.request.Request<co.ecg.alpaca.toolkit.messaging.response.DefaultResponse>,E extends Enum<E>,A extends AbstractDeviceImport<T,R,E,A>>

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.AbstractImport<T,AccessDeviceInformation<T>,R,E,A>

co.ecg.alpaca.toolkit.helper.migration.device.AbstractDeviceImport<T,R,E,A>

All Implemented Interfaces:

Executable<T>, Loggable

Direct Known Subclasses:

GroupAccessDeviceImport, ServiceProviderAccessDeviceImport

public abstract class AbstractDeviceImport<T extends co.ecg.alpaca.toolkit.generated.AccessDevice,R extends co.ecg.alpaca.toolkit.messaging.request.Request<co.ecg.alpaca.toolkit.messaging.response.DefaultResponse>,E extends Enum<E>,A extends AbstractDeviceImport<T,R,E,A>>
extends AbstractImport<T,AccessDeviceInformation<T>,R,E,A>

An abstract AccessDevice import into Broadworks. Contains methods shared across System, ServiceProvider, and Group AccessDevices. Created by mkeathley on 5/10/16.

Field Summary

Fields inherited from class co.ecg.alpaca.toolkit.helper.migration.AbstractImport

addRequest

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

Constructor Summary

Constructors

Constructor and Description
AbstractDeviceImport(co.ecg.alpaca.toolkit.model.BroadWorksServer bws, AccessDeviceInformation<T> information, Class<E> buildStepClass) Creates a new Object Import with the provided information

Method Summary

Modifier and Type	Method and Description
void	addCustomTags() Adds Custom Tags
void	addDeviceFiles(String outputDeviceType, String outputMacAddress) Performs the addition of device files that match the DeviceFileMigrationRules
void	addOutputDevice() Fires the DeviceAddRequest to create the output device
void	addUsersToOutputDevice() Adds the Users in the input AccessDeviceInformation to the OutputDevice
void	checkMACAddressAvailability(co.ecg.alpaca.toolkit.model.BroadWorksServer broadWorksServer, String newMacAddres) Checks the if the MAC address for the Add Request is available for use.
void	checkMACAddressAvailability(co.ecg.alpaca.toolkit.model.BroadWorksServer broadWorksServer, String newMacAddres, String oldMacAddress) Checks the if the MAC address for the Add Request is available for use.
abstract co.ecg.alpaca.toolkit.messaging.request.Request	createAddTagRequest(DeviceTag tag) Creates an Add Tag Request for the specific Device sub-type
abstract void	migrateCustomFile(DeviceFile file) Migrates Custom Files based on the specific Device sub-type

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

concurrencyCheck, getAddRequest, getBroadWorksServer, getInformation, getOutput, setAddRequest, setOutput

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

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

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

checkValidity, exception, getErrors, hasErrors, isError, isError

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.Executable

execute

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

getSessionLogger, logger

Constructor Detail

AbstractDeviceImport

public AbstractDeviceImport(co.ecg.alpaca.toolkit.model.BroadWorksServer bws,
                            AccessDeviceInformation<T> information,
                            Class<E> buildStepClass)
                     throws HelperException,
                            co.ecg.licensing.LicenseException

Creates a new Object Import with the provided information

Parameters:

bws - The BroadWorks server to create the User on

information - The information to base the new object on

buildStepClass - The class of the import build steps

Throws:

HelperException

co.ecg.licensing.LicenseException

Method Detail

addOutputDevice

public void addOutputDevice()
                     throws co.ecg.alpaca.toolkit.exception.RequestException,
                            HelperException

Fires the DeviceAddRequest to create the output device

Throws:

co.ecg.alpaca.toolkit.exception.RequestException

HelperException

addUsersToOutputDevice

public void addUsersToOutputDevice()
                            throws HelperException

Adds the Users in the input AccessDeviceInformation to the OutputDevice

Throws:

HelperException

addDeviceFiles

public void addDeviceFiles(String outputDeviceType,
                           String outputMacAddress)
                    throws HelperException

Performs the addition of device files that match the DeviceFileMigrationRules

Throws:

HelperException

migrateCustomFile

public abstract void migrateCustomFile(DeviceFile file)
                                throws co.ecg.alpaca.toolkit.exception.RequestException,
                                       IOException,
                                       HelperException

Migrates Custom Files based on the specific Device sub-type

Parameters:

file -

Throws:

co.ecg.alpaca.toolkit.exception.RequestException

IOException

HelperException

addCustomTags

public void addCustomTags()
                   throws co.ecg.alpaca.toolkit.exception.RequestException

Adds Custom Tags

Throws:

co.ecg.alpaca.toolkit.exception.RequestException

createAddTagRequest

public abstract co.ecg.alpaca.toolkit.messaging.request.Request createAddTagRequest(DeviceTag tag)

Creates an Add Tag Request for the specific Device sub-type

Parameters:

tag -

Returns:

checkMACAddressAvailability

public void checkMACAddressAvailability(co.ecg.alpaca.toolkit.model.BroadWorksServer broadWorksServer,
                                        String newMacAddres,
                                        String oldMacAddress)
                                 throws HelperException

Checks the if the MAC address for the Add Request is available for use. This throws a Helper Exception if the MAC address is different than the source devices and is already in use by the provided BroadWorksSystem.

Parameters:

broadWorksServer - The BroadWorksServer to check.

newMacAddres - The new MAC address to check

oldMacAddress - The current MAC address of the device

Throws:

HelperException

checkMACAddressAvailability

public void checkMACAddressAvailability(co.ecg.alpaca.toolkit.model.BroadWorksServer broadWorksServer,
                                        String newMacAddres)
                                 throws HelperException

Checks the if the MAC address for the Add Request is available for use. This throws a Helper Exception if the MAC address is already in use by the provided BroadWorksSystem.

Parameters:

broadWorksServer - The BroadWorksServer to check.

newMacAddres - The new MAC address to check

Throws:

HelperException