co.ecg.alpaca.toolkit.helper

Class ServiceProviderHelper

java.lang.Object

co.ecg.alpaca.toolkit.helper.ServiceProviderHelper

public class ServiceProviderHelper
extends Object

A class to contain helper methods and tools that pertain to a Service Provider in the BroadWorks system. This is intended to be a location for generalized scripts and utilities. Larger tools should be located in their own class.

Author:

Matthew Keathley

Constructor Summary

Constructors

Constructor and Description
ServiceProviderHelper()

Method Summary

Modifier and Type	Method and Description
static List<co.ecg.alpaca.toolkit.generated.User>	getAllUsersInServiceProvider(co.ecg.alpaca.toolkit.generated.ServiceProvider serviceProvider) Retrieve the List of Users in a Service Provider
static void	randomizeAuthentication(co.ecg.alpaca.toolkit.generated.ServiceProvider sp) Randomizes the authentication username and password for all users of the given service provider.
static List<AnnouncementFile>	retrieveEnterpriseAnnouncements(co.ecg.alpaca.toolkit.generated.Enterprise enterprise) Method to retrieve AnnouncementFile associated with the Enterprise.
static List<AnnouncementFile>	retrieveServiceProviderAnnouncements(co.ecg.alpaca.toolkit.generated.ServiceProvider serviceProvider) Method to retrieve AnnouncementFile associated with the ServiceProvider.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceProviderHelper

public ServiceProviderHelper()

Method Detail

getAllUsersInServiceProvider

public static List<co.ecg.alpaca.toolkit.generated.User> getAllUsersInServiceProvider(co.ecg.alpaca.toolkit.generated.ServiceProvider serviceProvider)
                                                                               throws HelperException

Retrieve the List of Users in a Service Provider

Parameters:

serviceProvider - The Service Provider

Returns:

An ArrayList of Users

Throws:

HelperException - Thrown if an error occurs while retrieving users.

randomizeAuthentication

public static void randomizeAuthentication(co.ecg.alpaca.toolkit.generated.ServiceProvider sp)
                                    throws HelperException

Randomizes the authentication username and password for all users of the given service provider.

Parameters:

sp - The service provider to randomize authentication for

Throws:

HelperException - Thrown if an error occurs during randomization.

retrieveEnterpriseAnnouncements

public static List<AnnouncementFile> retrieveEnterpriseAnnouncements(co.ecg.alpaca.toolkit.generated.Enterprise enterprise)
                                                              throws HelperException,
                                                                     co.ecg.utilities.exception.AlpacaUtilityException,
                                                                     IOException

Method to retrieve AnnouncementFile associated with the Enterprise.

Parameters:

enterprise - The Enterprise to retrieve the Announcement Information.

Returns:

List of Announcement Files

Throws:

HelperException - Thrown if unable to retrieve file URLs

co.ecg.utilities.exception.AlpacaUtilityException

IOException

retrieveServiceProviderAnnouncements

public static List<AnnouncementFile> retrieveServiceProviderAnnouncements(co.ecg.alpaca.toolkit.generated.ServiceProvider serviceProvider)
                                                                   throws HelperException,
                                                                          co.ecg.utilities.exception.AlpacaUtilityException,
                                                                          IOException

Method to retrieve AnnouncementFile associated with the ServiceProvider.

Parameters:

serviceProvider - The Service Provider to retrieve the Announcement Information.

Returns:

List of Announcement Files

Throws:

HelperException - Thrown if unable to retrieve file URLs

co.ecg.utilities.exception.AlpacaUtilityException

IOException