co.ecg.alpaca.toolkit.helper.device

Class DeviceHelper

java.lang.Object

co.ecg.alpaca.toolkit.helper.device.DeviceHelper

public class DeviceHelper
extends Object

Constructor Summary

Constructors

Constructor and Description
DeviceHelper()

Method Summary

Modifier and Type	Method and Description
static void	addEndpointsToDevice(co.ecg.alpaca.toolkit.generated.AccessDevice device, List<AccessDeviceUser> accessDeviceUsers) Method to add a list of endpoints to a device.
static void	backupDevice(AccessDeviceInformation<co.ecg.alpaca.toolkit.generated.GroupAccessDevice> gadInformation, PrintStream out) Helper Method to backup a GroupAccessDevice.
static List<DeviceFile>	downloadFTPFiles(co.ecg.alpaca.toolkit.generated.AccessDevice device) Helper Method to download device files that are stored on an FTP server.
static co.ecg.alpaca.toolkit.generated.AccessDevice	getAccessDeviceFromUser(co.ecg.alpaca.toolkit.generated.User user) Utility Method to retrieve the specific subclass AccessDevice from a User
static com.github.zafarkhaja.semver.Version	getDeviceVersion(co.ecg.alpaca.toolkit.generated.AccessDevice accessDevice) Retrieves the semantic version of the Access Device.
static AccessDeviceUser	getPrimaryAccessDeviceUser(co.ecg.alpaca.toolkit.generated.GroupAccessDevice gad) Helper Method to find the Primary Access Device User from a Group Access Device.
static String	getRepositoryURL(co.ecg.alpaca.toolkit.generated.AccessDevice accessDevice, String deviceType, String macAddress, String fileFormat, String method) Retrieves Repository URL for an access device file
static boolean	isCompatibleDeviceType(co.ecg.alpaca.toolkit.generated.AccessDevice accessDevice, AccessDeviceInformation<?> information, String deviceType) Checks if the given AccessDevice and AccessDeviceInformation are compatible with the given device type.
static void	rebuildAccessDeviceConfigurationFiles(co.ecg.alpaca.toolkit.generated.AccessDevice accessDevice) Utility Method to rebuild an AccessDevice configuration files.
static void	removeEndpointsFromDevice(co.ecg.alpaca.toolkit.generated.AccessDevice device, List<AccessDeviceUser> accessDeviceUsers) Method to remove endpoints from an AccessDevice.
static void	replaceUserDevice(co.ecg.alpaca.toolkit.generated.User user, co.ecg.alpaca.toolkit.generated.AccessDevice newDevice) Method to replace an AccessDevice on a User with another.
static void	resetAccessDevice(co.ecg.alpaca.toolkit.generated.AccessDevice accessDevice) Method to reset an AccessDevice on a User.
static co.ecg.alpaca.toolkit.generated.AccessDevice	retrieveUserAccessDeviceSubtype(co.ecg.alpaca.toolkit.generated.AccessDevice device, co.ecg.alpaca.toolkit.generated.User user) Helper Method to convert an AccessDevice to its more specific subtype.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeviceHelper

public DeviceHelper()

Method Detail

addEndpointsToDevice

public static void addEndpointsToDevice(co.ecg.alpaca.toolkit.generated.AccessDevice device,
                                        List<AccessDeviceUser> accessDeviceUsers)
                                 throws HelperException

Method to add a list of endpoints to a device. This uses the correct attachment requests based on the endpoint type.

Parameters:

device - The device to add the endpoints

accessDeviceUsers - The list of access device users to add

Throws:

HelperException

getAccessDeviceFromUser

public static co.ecg.alpaca.toolkit.generated.AccessDevice getAccessDeviceFromUser(co.ecg.alpaca.toolkit.generated.User user)
                                                                            throws HelperException

Utility Method to retrieve the specific subclass AccessDevice from a User

Parameters:

user - The User of the AccessDevice

Returns:

Returns

Throws:

HelperException

getRepositoryURL

public static String getRepositoryURL(co.ecg.alpaca.toolkit.generated.AccessDevice accessDevice,
                                      String deviceType,
                                      String macAddress,
                                      String fileFormat,
                                      String method)
                               throws HelperException

Retrieves Repository URL for an access device file

Parameters:

accessDevice - The access device

deviceType -

macAddress -

fileFormat -

method - GET or PUT

Returns:

Returns a String containing the repository URL

Throws:

HelperException

isCompatibleDeviceType

public static boolean isCompatibleDeviceType(co.ecg.alpaca.toolkit.generated.AccessDevice accessDevice,
                                             AccessDeviceInformation<?> information,
                                             String deviceType)
                                      throws HelperException

Checks if the given AccessDevice and AccessDeviceInformation are compatible with the given device type.

Parameters:

accessDevice - The AccessDevice

information - The AccessDeviceInformation for the AccessDevice

deviceType - The device type to check for compatibility

Returns:

Returns true iff compatible

Throws:

HelperException

rebuildAccessDeviceConfigurationFiles

public static void rebuildAccessDeviceConfigurationFiles(co.ecg.alpaca.toolkit.generated.AccessDevice accessDevice)
                                                  throws HelperException

Utility Method to rebuild an AccessDevice configuration files.

Parameters:

accessDevice - The access device to rebuild

Throws:

HelperException

removeEndpointsFromDevice

public static void removeEndpointsFromDevice(co.ecg.alpaca.toolkit.generated.AccessDevice device,
                                             List<AccessDeviceUser> accessDeviceUsers)
                                      throws HelperException

Method to remove endpoints from an AccessDevice. This will remove the various endpoint types via the correct method.

Parameters:

device - The device to remove endpoints

accessDeviceUsers - The list of AccessDeviceUsers to remove

Throws:

HelperException

replaceUserDevice

public static void replaceUserDevice(co.ecg.alpaca.toolkit.generated.User user,
                                     co.ecg.alpaca.toolkit.generated.AccessDevice newDevice)
                              throws HelperException

Method to replace an AccessDevice on a User with another. This pulls the existing endpoint settings such as lineport and contact and then maps them to the new Access Device.

Parameters:

user - The User to modify

newDevice - The device to assign

Throws:

co.ecg.alpaca.toolkit.exception.RequestException - Thrown if an issue is encountered during migration

HelperException

resetAccessDevice

public static void resetAccessDevice(co.ecg.alpaca.toolkit.generated.AccessDevice accessDevice)
                              throws HelperException

Method to reset an AccessDevice on a User.

Parameters:

accessDevice - The device to reset

Throws:

HelperException - Thrown if an issue is encountered during migration

getDeviceVersion

public static com.github.zafarkhaja.semver.Version getDeviceVersion(co.ecg.alpaca.toolkit.generated.AccessDevice accessDevice)
                                                             throws HelperException

Retrieves the semantic version of the Access Device. The version is expected to be in the #.#.# format and is retrieved from the version fields in the device get response.

Parameters:

accessDevice - The access device subclass to retrieve the version.

Returns:

A Version object or NULL if not found.

Throws:

HelperException

retrieveUserAccessDeviceSubtype

public static co.ecg.alpaca.toolkit.generated.AccessDevice retrieveUserAccessDeviceSubtype(co.ecg.alpaca.toolkit.generated.AccessDevice device,
                                                                                           co.ecg.alpaca.toolkit.generated.User user)
                                                                                    throws HelperException

Helper Method to convert an AccessDevice to its more specific subtype. Requires the source User to determine source ServiceProvider or Group if needed.

Parameters:

device - The AccessDevice to determine

user - A User that is assigned to the AccessDevice

Returns:

An object that extends AccessDevice

Throws:

HelperException

getPrimaryAccessDeviceUser

public static AccessDeviceUser getPrimaryAccessDeviceUser(co.ecg.alpaca.toolkit.generated.GroupAccessDevice gad)
                                                   throws HelperException

Helper Method to find the Primary Access Device User from a Group Access Device.

Parameters:

gad - The GroupAccessDevice to determine

Returns:

An AccessDeviceUser

Throws:

HelperException

backupDevice

public static void backupDevice(AccessDeviceInformation<co.ecg.alpaca.toolkit.generated.GroupAccessDevice> gadInformation,
                                PrintStream out)
                         throws HelperException,
                                IOException

Helper Method to backup a GroupAccessDevice. Leave the Print Stream NULL if printing to the screen is unwanted.

Parameters:

gadInformation - The AccessDeviceInformation for the AccessDevice

out - The Print Stream where device storage information is printed

Throws:

HelperException

IOException

downloadFTPFiles

public static List<DeviceFile> downloadFTPFiles(co.ecg.alpaca.toolkit.generated.AccessDevice device)
                                         throws HelperException,
                                                co.ecg.utilities.exception.AlpacaUtilityException,
                                                IOException

Helper Method to download device files that are stored on an FTP server.

Parameters:

device - The access device that owns the files that are being retrieved.

Throws:

HelperException

co.ecg.utilities.exception.AlpacaUtilityException

IOException