public class TimesTenHelper extends Object
Modifier and Type | Class and Description |
---|---|
static class |
TimesTenHelper.BroadWorksAuthenticationInformation
A POJO to store BroadWorksAuthenticatonInformation for a User.
|
class |
TimesTenHelper.VoicePortalPasscodeDetails |
Constructor and Description |
---|
TimesTenHelper(co.ecg.alpaca.toolkit.model.BroadWorksServer bws) |
Modifier and Type | Method and Description |
---|---|
String |
getAnnouncementURL(co.ecg.alpaca.toolkit.generated.Group group,
String announcementName)
Method to get the URL for for a Group Announcement file.
|
String |
getAnnouncementURL(co.ecg.alpaca.toolkit.generated.User user,
String announcementName)
Method to get the URL for for a User Announcement file.
|
String |
getBroadWorksPasswordForUser(co.ecg.alpaca.toolkit.generated.User user)
Method to retrieve the BroadWorks Password for the given
User . |
String |
getBroadWorksPasswordForUserId(String userId)
Method to retrieve the BroadWorks Password for the given user id.
|
Credentials |
getDeviceCredentials(co.ecg.alpaca.toolkit.generated.AccessDevice accessDevice)
Method to retrieve the
Credentials for the given
AccessDevice |
Credentials |
getDeviceTypeCredentials(co.ecg.alpaca.toolkit.generated.AccessDevice accessDevice)
Method to retrieve the
Credentials for the given
AccessDevice device type. |
String |
getExchangeIntegrationPassword(co.ecg.alpaca.toolkit.generated.Group group)
Method to get the exchange integration password attribute for the specified group.
|
co.ecg.utilities.ftp.FTPServer |
getFTPServer(co.ecg.alpaca.toolkit.generated.AccessDevice accessDevice)
Method to retrieve information regarding an FTP File Server.
|
List<SavedMessageRow> |
getSavedVoicemails(co.ecg.alpaca.toolkit.generated.User user)
Method to retrieve the Voice Messaging saved messages for the given
User . |
HashMap<String,String> |
getUserAuthenticationInformation(co.ecg.alpaca.toolkit.generated.User user)
Method to retrieve the service information rows related to the
Authentication service for a
User |
Credentials |
getVoiceMessagingGroupMailServerCredentialsForUser(co.ecg.alpaca.toolkit.generated.User user)
Retrieves the VoiceMessaging Group MailServer credentials for a given
User
|
Credentials |
getVoiceMessagingPersonalMailServerCredentialsForUser(co.ecg.alpaca.toolkit.generated.User user)
Retrieves the VoiceMessaging Personal MailServer credentials for a given
User
|
String |
getVoicePortalPasscodeForUser(co.ecg.alpaca.toolkit.generated.User user)
Method to retrieve the Voice Portal Passcode for the given
User . |
TimesTenHelper.VoicePortalPasscodeDetails |
getVoicePortalPasswordDetails(co.ecg.alpaca.toolkit.generated.User user)
Method to retrieve the Voice Portal Passcode for the given
User . |
List<String> |
retrieveDeviceFileNames(co.ecg.alpaca.toolkit.generated.AccessDevice accessDevice)
Method to retrieve Device File Names from TimesTen.
|
void |
setAutoLoginFlags(co.ecg.alpaca.toolkit.generated.User user)
Method to toggle the Voice Portal and Web Portal to login without
requesting a password change.
|
void |
setDeviceProfileCredentials(co.ecg.alpaca.toolkit.generated.AccessDevice accessDevice,
Credentials accessDeviceCredentials)
Method to set the
AccessDevice profile credentials |
void |
setHashedBroadWorksPasswordForUser(co.ecg.alpaca.toolkit.generated.User user,
String hashedPassword)
Method to set the
User Broadworks password. |
void |
setHashedBroadWorksPasswordForUserId(String userId,
String hashedPassword)
Method to set the user id Broadworks password.
|
void |
setUserAuthenticationInformation(co.ecg.alpaca.toolkit.generated.User user,
HashMap<String,String> authenticationRows)
Method to update existing user Authentication rows with a previously
retrieved map of authentication rows
|
void |
setVoicePortalPasscodeForUser(co.ecg.alpaca.toolkit.generated.User user,
String voicePortalPasscode)
Method to set the
User voice portal passcode. |
public TimesTenHelper(co.ecg.alpaca.toolkit.model.BroadWorksServer bws) throws HelperException
HelperException
public String getExchangeIntegrationPassword(co.ecg.alpaca.toolkit.generated.Group group) throws HelperException
group
- The group to retrieve the information for.HelperException
- Throws a HelperException if the ATTR_VALUE does not exist.public String getAnnouncementURL(co.ecg.alpaca.toolkit.generated.Group group, String announcementName) throws HelperException
group
- The Group
that the announcement belongsannouncementName
- The name of the announcement fileHelperException
User
public String getAnnouncementURL(co.ecg.alpaca.toolkit.generated.User user, String announcementName) throws HelperException
user
- The User
that the announcement belongsannouncementName
- The name of the announcement fileHelperException
User
public String getBroadWorksPasswordForUser(co.ecg.alpaca.toolkit.generated.User user) throws HelperException
User
.user
- The User
to retrieve the BroadWorks passwordHelperException
User
public String getBroadWorksPasswordForUserId(String userId) throws HelperException
userId
- The user id of the user to retrieve the BroadWorks passwordHelperException
User
public Credentials getDeviceCredentials(co.ecg.alpaca.toolkit.generated.AccessDevice accessDevice) throws HelperException
Credentials
for the given
AccessDevice
accessDevice
- The AccessDevice
to retrieveHelperException
AccessDevice
public Credentials getDeviceTypeCredentials(co.ecg.alpaca.toolkit.generated.AccessDevice accessDevice) throws HelperException
Credentials
for the given
AccessDevice
device type. This does not retrieve the credentials
for the device profile.accessDevice
- The AccessDevice
to retrieveHelperException
AccessDevice
public List<SavedMessageRow> getSavedVoicemails(co.ecg.alpaca.toolkit.generated.User user) throws HelperException
User
.user
- The User
to retrieve the saved VoicemailsHelperException
User
public HashMap<String,String> getUserAuthenticationInformation(co.ecg.alpaca.toolkit.generated.User user) throws HelperException
User
user
- The User
to retrieveHelperException
public Credentials getVoiceMessagingGroupMailServerCredentialsForUser(co.ecg.alpaca.toolkit.generated.User user) throws HelperException
user
- The user to retrieveHelperException
public Credentials getVoiceMessagingPersonalMailServerCredentialsForUser(co.ecg.alpaca.toolkit.generated.User user) throws HelperException
user
- The user to retrieveHelperException
public String getVoicePortalPasscodeForUser(co.ecg.alpaca.toolkit.generated.User user) throws HelperException
User
.user
- The User
to retrieve the voice portal passcodeHelperException
User
public void setAutoLoginFlags(co.ecg.alpaca.toolkit.generated.User user) throws HelperException
user
- The User
to modifyHelperException
User
public void setDeviceProfileCredentials(co.ecg.alpaca.toolkit.generated.AccessDevice accessDevice, Credentials accessDeviceCredentials) throws HelperException
AccessDevice
profile credentialsaccessDevice
- The AccessDevice
to modifyaccessDeviceCredentials
- The credentials to setHelperException
User
public void setHashedBroadWorksPasswordForUser(co.ecg.alpaca.toolkit.generated.User user, String hashedPassword) throws HelperException
User
Broadworks password. This password must be
already hashed.user
- The User
to modifyhashedPassword
- The hashed password to setHelperException
User
public void setHashedBroadWorksPasswordForUserId(String userId, String hashedPassword) throws HelperException
userId
- The user id to modifyhashedPassword
- The hashed password to setHelperException
User
public void setUserAuthenticationInformation(co.ecg.alpaca.toolkit.generated.User user, HashMap<String,String> authenticationRows) throws HelperException
user
- The user to modifyauthenticationRows
- The map of authentication row informationHelperException
public void setVoicePortalPasscodeForUser(co.ecg.alpaca.toolkit.generated.User user, String voicePortalPasscode) throws HelperException
User
voice portal passcode.user
- The User
to modifyvoicePortalPasscode
- The passcode to setHelperException
User
public TimesTenHelper.VoicePortalPasscodeDetails getVoicePortalPasswordDetails(co.ecg.alpaca.toolkit.generated.User user) throws HelperException
User
.user
- The User
to retrieve the voice portal passcodeHelperException
User
public co.ecg.utilities.ftp.FTPServer getFTPServer(co.ecg.alpaca.toolkit.generated.AccessDevice accessDevice) throws HelperException
accessDevice
- The AccessDevice
whose files are stored on the FTP ServerHelperException
User
,
AccessDevice
public List<String> retrieveDeviceFileNames(co.ecg.alpaca.toolkit.generated.AccessDevice accessDevice) throws HelperException
accessDevice
- The AccessDevice
whose files are being retrieved.HelperException
AccessDevice
Copyright © 2016. All rights reserved.