public class TimesTenHelper extends Object
This is highly dependent on server configuration. Required settings are -- The Library Path for the server must be set at runtime. -Djava.library.path=/usr/local/TimesTen/tt_base/lib
The Class Path for the *SERVER* ttjdbc jar must be set. Although we are compiling with a ttjdbc*.jar, this is not the library used at runtime. -cp /server/timesten/library/ttjdbc*.jar
The TimesTen library needs to be set as an available Library in linux. Example - $ export LD_LIBRARY_PATH=/usr/local/TimesTen/tt_base/lib $ ldconfig
Constructor and Description |
---|
TimesTenHelper(BroadWorksServer bws) |
Modifier and Type | Method and Description |
---|---|
List<ActivatableFeature> |
getActivatableFeatures()
Method to retrieve a list of Activatable Features
from TimesTen.
|
String |
getAnnouncementURL(BroadWorksUser user,
String announcementName)
Method to get the URL for for a User Announcement file.
|
String |
getAnnouncementURL(Group group,
String announcementName)
Method to get the URL for for a Group Announcement file.
|
String |
getBroadWorksPasswordForUser(BroadWorksUser user)
Method to retrieve the BroadWorks Password for the given
BroadWorksUser . |
String |
getBroadWorksPasswordForUserId(String userId)
Method to retrieve the BroadWorks Password for the given user id.
|
String |
getDeviceAccessProtocol(String deviceType)
Method to retrieve Device Access Protocols from TimesTen.
|
Credentials |
getDeviceCredentials(AccessDevice accessDevice)
Method to retrieve the
Credentials for the given
AccessDevice |
List<DeviceFile> |
getDeviceFileList(String deviceName)
Method to retrieve a list of files for a given device.
|
Credentials |
getDeviceTypeCredentials(AccessDevice accessDevice)
Method to retrieve the
Credentials for the given
AccessDevice device type. |
String |
getEnterprisePreAlertingAnnouncementURL(Enterprise enterprise,
String mediaType)
Method to retrieve the URL for an
Enterprise PreAlerting Announcement. |
String |
getExchangeIntegrationPassword(Group group)
Method to get the exchange integration password attribute for the specified group.
|
String |
getFileRepositoryPassword(String fileRepositoryName,
String userId)
Method to retrieve the Password of a FileRepositoryUser.
|
co.ecg.utilities.ftp.FTPServer |
getFTPServer(AccessDevice accessDevice)
Method to retrieve information regarding an FTP File Server.
|
String |
getIntegratedIMPPassword(ServiceProvider serviceProvider)
Method to get the integrated imp password attribute for the specified
ServiceProvider . |
String |
getRepositoryUrl(AccessDevice device,
String fileName)
Method to retrieve the Repository URL of a device file from TimesTen.
|
List<SavedMessageRow> |
getSavedVoicemails(BroadWorksUser user)
Method to retrieve the Voice Messaging saved messages for the given
BroadWorksUser . |
String |
getServiceProviderAnswerConfirmationAnnouncementURL(ServiceProvider serviceProvider,
String mediaType)
Method to retrieve the URL for a
ServiceProvider Answer Confirmation Announcement |
HashMap<String,String> |
getUserAuthenticationInformation(User user)
Method to retrieve the service information rows related to the
Authentication service for a
User |
Credentials |
getVoiceMessagingGroupMailServerCredentialsForUser(BroadWorksUser user)
Retrieves the VoiceMessaging Group MailServer credentials for a given
BroadWorksUser |
Credentials |
getVoiceMessagingPersonalMailServerCredentialsForUser(BroadWorksUser user)
Retrieves the VoiceMessaging Personal MailServer credentials for a given
BroadWorksUser |
String |
getVoicePortalPasscodeForUser(BroadWorksUser user)
Method to retrieve the Voice Portal Passcode for the given
BroadWorksUser . |
VoicePortalPasscodeDetails |
getVoicePortalPasswordDetails(BroadWorksUser user)
Method to retrieve the Voice Portal Passcode for the given
BroadWorksUser . |
org.apache.commons.lang3.tuple.ImmutablePair<String,String> |
retrieveTrunkGroupAuthenticationPassword(Group group,
String trunkGroupName)
Method to retrieve the Authentication Password and Cipher for a Trunk Group.
|
void |
setAutoLoginFlags(BroadWorksUser user)
Method to toggle the Voice Portal and Web Portal to login without
requesting a password change.
|
void |
setCollaborateBridgeId(String bridgeId,
String userId,
String roomName,
CollaborateRoomType roomType)
Updates the TimesTen database to set the BridgeID to the desired value for the provided Collaborate Room
|
void |
setDeviceProfileCredentials(AccessDevice accessDevice,
Credentials accessDeviceCredentials)
Method to set the
AccessDevice profile credentials |
void |
setHashedBroadWorksPasswordForUser(BroadWorksUser user,
String hashedPassword)
Method to set the
BroadWorksUser Broadworks password. |
void |
setHashedBroadWorksPasswordForUserId(String userId,
String hashedPassword)
Method to set the user id Broadworks password.
|
void |
setMeetMeConferenceAccess(String currentConferenceID,
String currentModeratorPin,
MeetMeConferenceAccess meetMeConferenceAccess)
Updates the TimesTen database using the provided MeetMeConferenceAccess object.
|
void |
setTrunkGroupAuthenticationPassword(org.apache.commons.lang3.tuple.ImmutablePair<String,String> password,
Group group,
String trunkGroupName)
Method to set the Authentication Password for a Trunk Group.
|
void |
setUserAuthenticationInformation(User user,
HashMap<String,String> authenticationRows)
Method to update existing user Authentication rows with a previously
retrieved map of authentication rows
|
void |
setVoicePortalPasscodeForUser(BroadWorksUser user,
String voicePortalPasscode)
BWAS.SVC_PROVIDER_ATTR
Method to set the
BroadWorksUser voice portal passcode. |
public TimesTenHelper(BroadWorksServer bws) throws HelperException
HelperException
public String getExchangeIntegrationPassword(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(Group group, String announcementName) throws HelperException
group
- The Group
that the announcement belongsannouncementName
- The name of the announcement fileHelperException
- Thrown if CUST_GROUP_UID attribute does not exist.User
public String getAnnouncementURL(BroadWorksUser user, String announcementName) throws HelperException
user
- The BroadWorksUser
that the announcement belongsannouncementName
- The name of the announcement fileHelperException
- Thrown if either the USER_UID or CUST_GROUP_UID attribute does not exist.User
public String getServiceProviderAnswerConfirmationAnnouncementURL(ServiceProvider serviceProvider, String mediaType) throws HelperException
ServiceProvider
Answer Confirmation AnnouncementserviceProvider
- The ServiceProvider to retrieve the URL for.mediaType
- The type of media that the Announcement is.HelperException
- Thrown if the SVC_PROVIDER_UID attribute does not exist.public String getEnterprisePreAlertingAnnouncementURL(Enterprise enterprise, String mediaType) throws HelperException
Enterprise
PreAlerting Announcement.enterprise
- The enterprise to retrieve the URL for.mediaType
- The type of media that the Announcement is.HelperException
- Thrown if the SVC_PROVIDER_UID attribute does not exist.public String getBroadWorksPasswordForUser(BroadWorksUser user) throws HelperException
BroadWorksUser
.user
- The BroadWorksUser
to retrieve the BroadWorks passwordHelperException
- Thrown if either the BroadWorks Server or User are null.User
public String getBroadWorksPasswordForUserId(String userId) throws HelperException
userId
- The user id of the user to retrieve the BroadWorks passwordHelperException
- Thrown if either the BroadWorks Server or userId are null.User
public Credentials getDeviceCredentials(AccessDevice accessDevice) throws HelperException
Credentials
for the given
AccessDevice
accessDevice
- The AccessDevice
to retrieveHelperException
- Thrown if either the BroadWorks Server or AccessDevice are null.AccessDevice
public Credentials getDeviceTypeCredentials(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
- Thrown if accessDevice is not a valid subtype.AccessDevice
public List<SavedMessageRow> getSavedVoicemails(BroadWorksUser user) throws HelperException
BroadWorksUser
.user
- The BroadWorksUser
to retrieve the saved VoicemailsHelperException
- Thrown if either the BroadWorks Server or User are null.BroadWorksUser
public HashMap<String,String> getUserAuthenticationInformation(User user) throws HelperException
User
user
- The User
to retrieveHelperException
- Thrown if either the BroadWorks Server or User are null.public Credentials getVoiceMessagingGroupMailServerCredentialsForUser(BroadWorksUser user) throws HelperException
BroadWorksUser
user
- The BroadWorksUser
to retrieveHelperException
- Thrown if either the BroadWorks Server or User are null.public Credentials getVoiceMessagingPersonalMailServerCredentialsForUser(BroadWorksUser user) throws HelperException
BroadWorksUser
user
- The BroadWorksUser
to retrieveHelperException
- Thrown if either the BroadWorks Server or User are null.public String getVoicePortalPasscodeForUser(BroadWorksUser user) throws HelperException
BroadWorksUser
.user
- The BroadWorksUser
to retrieve the voice portal passcodeHelperException
- Thrown if either the BroadWorks Server or User are null.User
public void setAutoLoginFlags(BroadWorksUser user) throws HelperException
user
- The BroadWorksUser
to modifyHelperException
- Thrown if either the BroadWorks Server or User are null.User
public void setDeviceProfileCredentials(AccessDevice accessDevice, Credentials accessDeviceCredentials) throws HelperException
AccessDevice
profile credentialsaccessDevice
- The AccessDevice
to modifyaccessDeviceCredentials
- The credentials to setHelperException
- Thrown if either the BroadWorks Server or AccessDevice are null.User
public void setHashedBroadWorksPasswordForUser(BroadWorksUser user, String hashedPassword) throws HelperException
BroadWorksUser
Broadworks password. This password must be
already hashed.user
- The BroadWorksUser
to modifyhashedPassword
- The hashed password to setHelperException
- Thrown if either the BroadWorks Server or User are null.User
public void setHashedBroadWorksPasswordForUserId(String userId, String hashedPassword) throws HelperException
userId
- The user id to modifyhashedPassword
- The hashed password to setHelperException
- Thrown if BroadWorks Server is null or if the userId is null.User
public void setUserAuthenticationInformation(User user, HashMap<String,String> authenticationRows) throws HelperException
user
- The user to modifyauthenticationRows
- The map of authentication row informationHelperException
- Thrown if either the BroadWorks Server or User are null.public void setVoicePortalPasscodeForUser(BroadWorksUser user, String voicePortalPasscode) throws HelperException
BroadWorksUser
voice portal passcode.user
- The BroadWorksUser
to modifyvoicePortalPasscode
- The passcode to setHelperException
- Thrown if unable to retrieve the VoicePortalPasscodeUser
public VoicePortalPasscodeDetails getVoicePortalPasswordDetails(BroadWorksUser user) throws HelperException
BroadWorksUser
.user
- The BroadWorksUser
to retrieve the voice portal passcodeHelperException
- Thrown if unable to retrieve VoicePortalPasscodeDetailsUser
public co.ecg.utilities.ftp.FTPServer getFTPServer(AccessDevice accessDevice) throws HelperException
accessDevice
- The AccessDevice
whose files are stored on the FTP ServerHelperException
- Thrown if accessDevice is not a valid subtype.User
,
AccessDevice
public String getDeviceAccessProtocol(String deviceType)
deviceType
- The device type that the protocol will be retrieved for.public List<ActivatableFeature> getActivatableFeatures()
ActivatableFeature
public void setMeetMeConferenceAccess(String currentConferenceID, String currentModeratorPin, MeetMeConferenceAccess meetMeConferenceAccess) throws HelperException
currentConferenceID
- The conferences current conference IDcurrentModeratorPin
- The conferences current moderator pinmeetMeConferenceAccess
- The MeetMeConferenceAccess to insertHelperException
- Thrown if unable to insert the MeetMeConferenceAccess.public void setCollaborateBridgeId(String bridgeId, String userId, String roomName, CollaborateRoomType roomType) throws HelperException
bridgeId
- The desired bridge IDuserId
- The host user ID of the bridgeroomName
- The room nameroomType
- The room typeHelperException
- Thrown if the parameters are null or the room type is invalidCollaborateRoomType
public String getIntegratedIMPPassword(ServiceProvider serviceProvider) throws HelperException
ServiceProvider
.serviceProvider
- The Service Provider to retrieve the informatiom for.HelperException
- Throws a HelperException if the ATTR_VALUE does not exist.public String getFileRepositoryPassword(String fileRepositoryName, String userId) throws HelperException
fileRepositoryName
- The file repository to retrieve the Password for.userId
- The userId to retrieve the Password for.HelperException
- Thrown if there is an error while retrieving the password.public String getRepositoryUrl(AccessDevice device, String fileName)
device
- The device to retrieve the URL for.fileName
- The name of the file to retrieve the URL for.public List<DeviceFile> getDeviceFileList(String deviceName)
deviceName
- The name of the device to retrieve files for.public org.apache.commons.lang3.tuple.ImmutablePair<String,String> retrieveTrunkGroupAuthenticationPassword(Group group, String trunkGroupName)
group
- The Group that the Trunk Group is in.trunkGroupName
- The name of the Trunk Group.ImmutablePair
containing the password and cipher.public void setTrunkGroupAuthenticationPassword(org.apache.commons.lang3.tuple.ImmutablePair<String,String> password, Group group, String trunkGroupName)
password
- The ImmutablePair
of the password and cipher to set in TimesTen.group
- The Group the trunk group belongs to.trunkGroupName
- The name of the trunk Group.Copyright © 2017 ECG. All rights reserved.