co.ecg.alpaca.toolkit.helper.information

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

java.lang.Object

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

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

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

Builder for the AccessDeviceInformation Class

Created by mkeathley on 4/13/16.

Field Summary

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

broadWorksObject, errors, log, waitForLoad

Constructor Summary

Constructors

Constructor and Description
AccessDeviceInformationBuilder(T accessDevice)

Method Summary

Modifier and Type	Method and Description
AccessDeviceInformationBuilder<T>	addCustomTags() Adds the CustomTags in the AccessDevice
AccessDeviceInformationBuilder<T>	addDeviceFiles() Adds the DeviceFiles in the AccessDevice
AccessDeviceInformationBuilder<T>	addUserList() Adds the UserList in the AccessDevice
AccessDeviceInformationBuilder<T>	all() Build the AccessDeviceInformation with all available information
AccessDeviceInformation<T>	build()
AccessDeviceInformationBuilder<T>	concurrent() Runs the Builder in concurrent mode.
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.
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.InformationBuilder

checkValidity

Methods inherited from class java.lang.Object

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

Constructor Detail

AccessDeviceInformationBuilder

public AccessDeviceInformationBuilder(T accessDevice)
                               throws HelperException

Throws:

HelperException

Method Detail

concurrent

public AccessDeviceInformationBuilder<T> concurrent()

Runs the Builder in concurrent mode. This means that the information will return before all the underlying requests have been completed.

Specified by:

concurrent in class InformationBuilder<T extends co.ecg.alpaca.toolkit.generated.AccessDevice,AccessDeviceInformationBuilder,AccessDeviceInformation<T extends co.ecg.alpaca.toolkit.generated.AccessDevice>>

Returns:

AccessDeviceInformationBuilder

addCustomTags

public AccessDeviceInformationBuilder<T> addCustomTags()

Adds the CustomTags in the AccessDevice

Returns:

AccessDeviceInformationBuilder

addDeviceFiles

public AccessDeviceInformationBuilder<T> addDeviceFiles()

Adds the DeviceFiles in the AccessDevice

Returns:

AccessDeviceInformationBuilder

addUserList

public AccessDeviceInformationBuilder<T> addUserList()

Adds the UserList in the AccessDevice

Returns:

AccessDeviceInformationBuilder

all

public AccessDeviceInformationBuilder<T> all()

Build the AccessDeviceInformation with all available information

Specified by:

all in class InformationBuilder<T extends co.ecg.alpaca.toolkit.generated.AccessDevice,AccessDeviceInformationBuilder,AccessDeviceInformation<T extends co.ecg.alpaca.toolkit.generated.AccessDevice>>

Returns:

AccessDeviceInformationBuilder

build

public AccessDeviceInformation<T> build()
                                 throws HelperException

Specified by:

build in class InformationBuilder<T extends co.ecg.alpaca.toolkit.generated.AccessDevice,AccessDeviceInformationBuilder,AccessDeviceInformation<T extends co.ecg.alpaca.toolkit.generated.AccessDevice>>

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

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

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

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.alpaca.toolkit.exception.RequestException,
                                  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

co.ecg.alpaca.toolkit.exception.RequestException

co.ecg.utilities.exception.AlpacaUtilityException

IOException