co.ecg.alpaca.toolkit.helper.information

Class AccessDeviceInformationBuilder<T extends co.ecg.alpaca.toolkit.generated.AccessDevice,I extends AccessDeviceInformation<T>>

java.lang.Object

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

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

co.ecg.alpaca.toolkit.helper.information.AbstractInformationBuilder<T,AccessDeviceInformationBuilder<T,I>,AccessDeviceInformation<T>,AccessDeviceInformationBuilder.BuildStep>

co.ecg.alpaca.toolkit.helper.information.AccessDeviceInformationBuilder<T,I>

All Implemented Interfaces:

Executable<AccessDeviceInformation<T>>, Loggable

public class AccessDeviceInformationBuilder<T extends co.ecg.alpaca.toolkit.generated.AccessDevice,I extends AccessDeviceInformation<T>>
extends AbstractInformationBuilder<T,AccessDeviceInformationBuilder<T,I>,AccessDeviceInformation<T>,AccessDeviceInformationBuilder.BuildStep>

Builder for the AccessDeviceInformation Class

Author:

Matthew Keathley on 4/13/16.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AccessDeviceInformationBuilder.BuildStep

Field Summary

Fields inherited from class co.ecg.alpaca.toolkit.helper.information.AbstractInformationBuilder

broadWorksObject

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
AccessDeviceInformationBuilder(T accessDevice)

Method Summary

Modifier and Type	Method and Description
AccessDeviceInformationBuilder<T,I>	addCustomTags() Adds the CustomTags in the AccessDevice
AccessDeviceInformationBuilder<T,I>	addDeviceFiles() Adds the DeviceFiles in the AccessDevice
AccessDeviceInformationBuilder<T,I>	addUserList() Adds the UserList in the AccessDevice
protected void	downloadDeviceFile(co.ecg.alpaca.toolkit.generated.AccessDevice device, String deviceType, String macAddress, DeviceFile file, String accessURL, String fileFormat) Uses the provided information to determine if the DeviceFile can be downloaded.
I	execute()
AccessDeviceInformation<T>	getGroupAccessDeviceInformation(co.ecg.alpaca.toolkit.generated.GroupAccessDevice gad) Retrieves AccessDeviceInformation for a GroupAccessDevice
AccessDeviceInformation<T>	getServiceProviderAccessDeviceInformation(co.ecg.alpaca.toolkit.generated.ServiceProviderAccessDevice spad) Retrieves AccessDeviceInformation for a ServiceProviderAccessDevice
AccessDeviceInformation<T>	getSystemAccessDeviceInformation(co.ecg.alpaca.toolkit.generated.SystemAccessDevice sad) Retrieves AccessDeviceInformation for a SystemAccessDevice

Methods inherited from class co.ecg.alpaca.toolkit.helper.information.AbstractInformationBuilder

concurrencyCheck

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

AccessDeviceInformationBuilder

public AccessDeviceInformationBuilder(T accessDevice)
                               throws HelperException

Throws:

HelperException

Method Detail

addCustomTags

public AccessDeviceInformationBuilder<T,I> addCustomTags()

Adds the CustomTags in the AccessDevice

Returns:

AccessDeviceInformationBuilder

addDeviceFiles

public AccessDeviceInformationBuilder<T,I> addDeviceFiles()

Adds the DeviceFiles in the AccessDevice

Returns:

AccessDeviceInformationBuilder

addUserList

public AccessDeviceInformationBuilder<T,I> addUserList()

Adds the UserList in the AccessDevice

Returns:

AccessDeviceInformationBuilder

execute

public I execute()
          throws HelperException

Throws:

HelperException

getGroupAccessDeviceInformation

public AccessDeviceInformation<T> getGroupAccessDeviceInformation(co.ecg.alpaca.toolkit.generated.GroupAccessDevice gad)
                                                           throws HelperException

Retrieves AccessDeviceInformation for a GroupAccessDevice

Parameters:

gad - The GroupAccessDevice

Returns:

Returns an AccessDeviceInformation object filled for the Device

Throws:

HelperException - Thrown if an error occues while retrieving Information.

getServiceProviderAccessDeviceInformation

public AccessDeviceInformation<T> getServiceProviderAccessDeviceInformation(co.ecg.alpaca.toolkit.generated.ServiceProviderAccessDevice spad)
                                                                     throws HelperException

Retrieves AccessDeviceInformation for a ServiceProviderAccessDevice

Parameters:

spad - The ServiceProviderAccessDevice to retrieve information

Returns:

The AccessDeviceInformation object

Throws:

HelperException - Thrown if an error occues while retrieving Information.

getSystemAccessDeviceInformation

public AccessDeviceInformation<T> getSystemAccessDeviceInformation(co.ecg.alpaca.toolkit.generated.SystemAccessDevice sad)
                                                            throws HelperException

Retrieves AccessDeviceInformation for a SystemAccessDevice

Parameters:

sad - The SystemAccessDevice to retrieve information

Returns:

The AccessDeviceInformation object

Throws:

HelperException - Thrown if an error occues while retrieving Information.

downloadDeviceFile

protected void downloadDeviceFile(co.ecg.alpaca.toolkit.generated.AccessDevice device,
                                  String deviceType,
                                  String macAddress,
                                  DeviceFile file,
                                  String accessURL,
                                  String fileFormat)
                           throws HelperException,
                                  co.ecg.utilities.exception.AlpacaUtilityException,
                                  IOException

Uses the provided information to determine if the DeviceFile can be downloaded. If so attempt to retrieve the file and set the file contents.

Parameters:

device - The source AccessDevice

deviceType - The source DeviceType

macAddress - The source MAC address

file - The file to retrieve

accessURL - The expected access URL

fileFormat - The file format

Throws:

HelperException - Thrown if an error occurs while attempting to download the file.

co.ecg.utilities.exception.AlpacaUtilityException - Thrown if an error occurs while attempting to download the file.

IOException - Thrown if an error occurs while trying to get the Repository URL.