co.ecg.alpaca.toolkit.helper

Class TimesTenHelper

java.lang.Object

co.ecg.alpaca.toolkit.helper.TimesTenHelper

public class TimesTenHelper
extends Object

Class to handle the connection between an Alpaca Library and a TimesTen database. This would typically be located on an Application Server. This class needs to replicate the ability from an Application Server login. The expectation is to retrieve Password and Passcode information an be able to then set these same values on through a OCI request. 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

Author:

Matthew Keathley - mkeathley@e-c-group.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimesTenHelper.BroadWorksAuthenticationInformation A POJO to store BroadWorksAuthenticatonInformation for a User.
class	TimesTenHelper.VoicePortalPasscodeDetails

Constructor Summary

Constructors

Constructor and Description
TimesTenHelper(co.ecg.alpaca.toolkit.model.BroadWorksServer bws)

Method Summary

Modifier and Type	Method and Description
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.
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.
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.
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	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.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimesTenHelper

public TimesTenHelper(co.ecg.alpaca.toolkit.model.BroadWorksServer bws)
               throws HelperException

Throws:

HelperException

Method Detail

getAnnouncementURL

public String getAnnouncementURL(co.ecg.alpaca.toolkit.generated.User user,
                                 String announcementName)
                          throws HelperException

Method to get the URL for for a User Announcement file. This file is hashed from the UIDs of the Group, User, and Announcement.

Parameters:

user - The User that the announcement belongs

announcementName - The name of the announcement file

Throws:

HelperException

See Also:

User

getBroadWorksPasswordForUser

public String getBroadWorksPasswordForUser(co.ecg.alpaca.toolkit.generated.User user)
                                    throws HelperException

Method to retrieve the BroadWorks Password for the given User.

Parameters:

user - The User to retrieve the BroadWorks password

Throws:

HelperException

See Also:

User

getDeviceCredentials

public Credentials getDeviceCredentials(co.ecg.alpaca.toolkit.generated.AccessDevice accessDevice)
                                 throws HelperException

Method to retrieve the Credentials for the given AccessDevice

Parameters:

accessDevice - The AccessDevice to retrieve

Returns:

A set of credentials

Throws:

HelperException

See Also:

AccessDevice

getDeviceTypeCredentials

public Credentials getDeviceTypeCredentials(co.ecg.alpaca.toolkit.generated.AccessDevice accessDevice)
                                     throws HelperException

Method to retrieve the Credentials for the given AccessDevice device type. This does not retrieve the credentials for the device profile.

Parameters:

accessDevice - The AccessDevice to retrieve

Returns:

A set of credentials

Throws:

HelperException

See Also:

AccessDevice

getSavedVoicemails

public List<SavedMessageRow> getSavedVoicemails(co.ecg.alpaca.toolkit.generated.User user)
                                         throws HelperException

Method to retrieve the Voice Messaging saved messages for the given User.

Parameters:

user - The User to retrieve the saved Voicemails

Throws:

HelperException

See Also:

User

getUserAuthenticationInformation

public HashMap<String,String> getUserAuthenticationInformation(co.ecg.alpaca.toolkit.generated.User user)
                                                        throws HelperException

Method to retrieve the service information rows related to the Authentication service for a User

Parameters:

user - The User to retrieve

Returns:

A hashmap of name value pairs from the feature service table

Throws:

HelperException

getVoiceMessagingGroupMailServerCredentialsForUser

public Credentials getVoiceMessagingGroupMailServerCredentialsForUser(co.ecg.alpaca.toolkit.generated.User user)
                                                               throws HelperException

Retrieves the VoiceMessaging Group MailServer credentials for a given User

Parameters:

user - The user to retrieve

Returns:

the set of credentials if found

Throws:

HelperException

getVoiceMessagingPersonalMailServerCredentialsForUser

public Credentials getVoiceMessagingPersonalMailServerCredentialsForUser(co.ecg.alpaca.toolkit.generated.User user)
                                                                  throws HelperException

Retrieves the VoiceMessaging Personal MailServer credentials for a given User

Parameters:

user - The user to retrieve

Returns:

the set of credentials if found

Throws:

HelperException

getVoicePortalPasscodeForUser

public String getVoicePortalPasscodeForUser(co.ecg.alpaca.toolkit.generated.User user)
                                     throws HelperException

Method to retrieve the Voice Portal Passcode for the given User.

Parameters:

user - The User to retrieve the voice portal passcode

Throws:

HelperException

See Also:

User

setAutoLoginFlags

public void setAutoLoginFlags(co.ecg.alpaca.toolkit.generated.User user)
                       throws HelperException

Method to toggle the Voice Portal and Web Portal to login without requesting a password change.

Parameters:

user - The User to modify

Throws:

HelperException

See Also:

User

setDeviceProfileCredentials

public void setDeviceProfileCredentials(co.ecg.alpaca.toolkit.generated.AccessDevice accessDevice,
                                        Credentials accessDeviceCredentials)
                                 throws HelperException

Method to set the AccessDevice profile credentials

Parameters:

accessDevice - The AccessDevice to modify

accessDeviceCredentials - The credentials to set

Throws:

HelperException

See Also:

User

setHashedBroadWorksPasswordForUser

public void setHashedBroadWorksPasswordForUser(co.ecg.alpaca.toolkit.generated.User user,
                                               String hashedPassword)
                                        throws HelperException

Method to set the User Broadworks password. This password must be already hashed.

Parameters:

user - The User to modify

hashedPassword - The hashed password to set

Throws:

HelperException

See Also:

User

setUserAuthenticationInformation

public void setUserAuthenticationInformation(co.ecg.alpaca.toolkit.generated.User user,
                                             HashMap<String,String> authenticationRows)
                                      throws HelperException

Method to update existing user Authentication rows with a previously retrieved map of authentication rows

Parameters:

user - The user to modify

authenticationRows - The map of authentication row information

Throws:

HelperException

setVoicePortalPasscodeForUser

public void setVoicePortalPasscodeForUser(co.ecg.alpaca.toolkit.generated.User user,
                                          String voicePortalPasscode)
                                   throws HelperException

Method to set the User voice portal passcode.

Parameters:

user - The User to modify

voicePortalPasscode - The passcode to set

Throws:

HelperException

See Also:

User

getVoicePortalPasswordDetails

public TimesTenHelper.VoicePortalPasscodeDetails getVoicePortalPasswordDetails(co.ecg.alpaca.toolkit.generated.User user)
                                                                        throws HelperException

Method to retrieve the Voice Portal Passcode for the given User.

Parameters:

user - The User to retrieve the voice portal passcode

Throws:

HelperException

See Also:

User