public class UserHelper extends Object
Constructor and Description |
---|
UserHelper() |
Modifier and Type | Method and Description |
---|---|
static String |
generateRandomUserPasscode(User user)
Method to retrieve password rules for the specific user and then use
those to create a randomized password that meets the BroadWorks
requirements.
|
static String |
generateRandomUserPassword(User user)
Method to retrieve password rules for the specific user and then use
those to create a randomized password that meets the BroadWorks
requirements.
|
static List<User> |
getAllUsersInSystem(BroadWorksServer broadWorksServer)
Retrieves a list of all Users in the BroadWorks system.
|
static <R extends Response> |
getResponsePerUserMap(BroadWorksServer bws,
List<User> users,
Class<? extends Request<R>> request)
Runs a request for every user in a list.
|
static List<AccessDevice> |
getUserAccessDeviceList(User user)
Retrieves the list of Access Devices for a given User
|
static UserInformation |
getUserInformation(User user)
Retrieves the
UserInformation for a given User. |
static UserInformation |
getUserInformation(User user,
List<UserService> services)
Retrieves the
UserInformation for a given User. |
static UserServices |
getUserServicesForAllAssignedServices(User user)
Retrieves a UserServices object populated with information from all
services and service packs assigned to the User.
|
static List<User> |
populateUserList(BroadWorksServer bws,
List<User> users)
Populates a list of User objects using asynchronous calls to perform the
population in an efficient manner
|
static String |
resetUserPasscode(User user) |
static String |
resetUserPassword(User user) |
static HashMap<AnnouncementFileKey,LabeledMediaFileResource> |
retrieveAnnouncementResourceList(User user)
Retrieves a map of
AnnouncementFileKey and their respecting
LabeledMediaFileResource that represent the Announcement files
for the User. |
static void |
setUserGroupServiceInformation(User user,
UserGroupServiceInformation information)
Set's Group Services information that can be configured for a specific
User
|
public static String generateRandomUserPasscode(User user) throws HelperException
user
- The user to generate the passwordHelperException
public static String generateRandomUserPassword(User user) throws HelperException
user
- The user to generate the passwordHelperException
public static List<User> getAllUsersInSystem(BroadWorksServer broadWorksServer) throws HelperException
broadWorksServer
- The BroadWorks server objectArrayList
of UsersHelperException
public static <R extends Response> HashMap<User,R> getResponsePerUserMap(BroadWorksServer bws, List<User> users, Class<? extends Request<R>> request) throws HelperException
bws
- The BroadWorksServer connection to use for the requestsusers
- The list of Users to populaterequest
- The request class to call. Must be a request with a
constructor as a User as single argument.HelperException
public static List<AccessDevice> getUserAccessDeviceList(User user) throws HelperException
user
- The User
to retrieveArrayList
of AccessDevicesHelperException
public static UserInformation getUserInformation(User user) throws HelperException
UserInformation
for a given User. This will contain
all Service information in addition to Registration information.user
- The user to retrieve information forHelperException
public static UserInformation getUserInformation(User user, List<UserService> services) throws HelperException
UserInformation
for a given User. This will contain
the service information listed in the services param or all available
information if set to null.user
- The user to retrieve information forservices
- The service objects to create. Can be null to retrieve all
assigned service information.HelperException
public static UserServices getUserServicesForAllAssignedServices(User user) throws HelperException
user
- The User to retrieve service information.HelperException
public static List<User> populateUserList(BroadWorksServer bws, List<User> users) throws HelperException
bws
- The BroadWorksServer connection to use for the requestsusers
- The list of Users to populateHelperException
public static HashMap<AnnouncementFileKey,LabeledMediaFileResource> retrieveAnnouncementResourceList(User user) throws HelperException
AnnouncementFileKey
and their respecting
LabeledMediaFileResource
that represent the Announcement files
for the User.user
- The user to retrieve announcement informationHelperException
public static void setUserGroupServiceInformation(User user, UserGroupServiceInformation information) throws HelperException
user
- The user to modifyinformation
- The UserGroupServiceInformation
to setHelperException
public static String resetUserPassword(User user) throws HelperException
HelperException
public static String resetUserPasscode(User user) throws HelperException
user
- HelperException
Copyright © 2016 ECG, Inc. All rights reserved.