Package org.opennms.netmgt.config.api

Interface UserConfig

All Known Implementing Classes:

MockUserManager, UserFactory, UserManager

public interface UserConfig

This is an interface for UserManager

Author:

Ryan Lambeth

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	UserConfig.ContactType

Method Summary

Modifier and Type	Method	Description
boolean	checkSaltedPassword(java.lang.String raw, java.lang.String encrypted)	checkSaltedPassword
boolean	comparePasswords(java.lang.String userID, java.lang.String aPassword)	comparePasswords
int	countUsersWithRole(java.lang.String roleid)	countUsersWithRole
void	deleteUser(java.lang.String name)	deleteUser
java.lang.String	encryptedPassword(java.lang.String aPassword, boolean useSalt)	encryptedPassword
java.lang.String	getContactInfo(java.lang.String userID, java.lang.String command)	getContactInfo
java.lang.String	getContactInfo(java.lang.String userId, UserConfig.ContactType contactType)	getContactInfo
java.lang.String	getContactInfo(User user, java.lang.String command)	getContactInfo
java.lang.String	getContactServiceProvider(java.lang.String userID, java.lang.String command)	getContactServiceProvider
java.lang.String	getContactServiceProvider(User user, java.lang.String command)	getContactServiceProvider
java.lang.String	getEmail(java.lang.String userID)	getEmail
java.lang.String	getEmail(User user)	getEmail
java.lang.String	getHomePhone(java.lang.String userID)	getHomePhone
java.lang.String	getHomePhone(User user)	getHomePhone
java.lang.String	getMicroblogName(java.lang.String name)	getMicroblogName
java.lang.String	getMobilePhone(java.lang.String userID)	getMobilePhone
java.lang.String	getMobilePhone(User user)	getMobilePhone
java.lang.String	getNumericPage(java.lang.String userID)	getNumericPage
java.lang.String	getNumericPage(User user)	getNumericPage
java.lang.String	getNumericPin(java.lang.String userID)	getNumericaPin
java.lang.String	getNumericPin(User user)	getNumericPin
OnmsUser	getOnmsUser(java.lang.String username)	getOnmsUser
OnmsUserList	getOnmsUserList()	getOnmsUserList
java.lang.String	getPagerEmail(java.lang.String userID)	getPagerEmail
java.lang.String	getPagerEmail(User user)	getPagerEmail
java.lang.String	getTextPage(java.lang.String userID)	getTextPage
java.lang.String	getTextPage(User user)	getTextPage
java.lang.String	getTextPin(java.lang.String userID)	getTextPin
java.lang.String	getTextPin(User user)	getTextPin
java.lang.String	getTuiPin(java.lang.String name)	getTuiPin
java.lang.String	getTuiPin(User user)	getTuiPin
User	getUser(java.lang.String name)	getUser
java.util.List<java.lang.String>	getUserNames()	getUserNames
java.util.Map<java.lang.String,User>	getUsers()	getUsers
java.lang.String[]	getUsersScheduledForRole(java.lang.String roleid, java.util.Date time)	getUsersScheduledForRole
java.lang.String[]	getUsersWithRole(java.lang.String roleid)	getUsersWithRole
java.lang.String	getWorkPhone(java.lang.String userID)	getWorkPhone
java.lang.String	getWorkPhone(User user)	getWorkPhone
java.lang.String	getXMPPAddress(java.lang.String userID)	getXMPPAddress
java.lang.String	getXMPPAddress(User user)	getXMPPAddress
boolean	hasOnCallRole(java.lang.String roleid)	hasOnCallRole
boolean	hasUser(java.lang.String userName)	hasUser
boolean	isUserOnDuty(java.lang.String user, java.util.Calendar time)	isUserOnDuty
boolean	isUserScheduledForRole(User user, java.lang.String roleid, java.util.Date time)	isUserScheduledForRole
void	parseXML(java.io.InputStream in)	parseXML
void	renameUser(java.lang.String oldName, java.lang.String newName)	renameUser
void	save(OnmsUser onmsUser)	save
void	saveUser(java.lang.String name, User details)	saveUser
void	saveUsers(java.util.Collection<User> usersList)	saveUsers
void	setContactInfo(java.lang.String userId, UserConfig.ContactType contactType, java.lang.String contactValue)	setContactInfo
void	setEncryptedPassword(java.lang.String userID, java.lang.String aPassword, boolean salted)	setEncryptedPassword
void	setUnencryptedPassword(java.lang.String userID, java.lang.String aPassword)	setUnencryptedPassword
void	update()	update
boolean	userHasRole(User user, java.lang.String roleid)	userHasRole

Method Detail

parseXML

void parseXML(java.io.InputStream in)

parseXML

Parameters:

an - InputStream

saveUser

void saveUser(java.lang.String name,
              User details)
       throws java.lang.Exception

saveUser

Parameters:

a - String

a - User

Throws:

java.lang.Exception

save

void save(OnmsUser onmsUser)
   throws java.lang.Exception

save

Parameters:

an - OnmsUser

Throws:

java.lang.Exception

isUserOnDuty

boolean isUserOnDuty(java.lang.String user,
                     java.util.Calendar time)
              throws java.io.IOException

isUserOnDuty

Parameters:

a - String

a - Calendar

Returns:

a boolean

Throws:

java.io.IOException

getUsers

java.util.Map<java.lang.String,User> getUsers()
                                             throws java.io.IOException

getUsers

Returns:

a Map

Throws:

java.io.IOException

getOnmsUserList

OnmsUserList getOnmsUserList()
                      throws java.io.IOException

getOnmsUserList

Returns:

an OnmsUserList

Throws:

java.io.IOException

getOnmsUser

OnmsUser getOnmsUser(java.lang.String username)
              throws java.io.IOException

getOnmsUser

Parameters:

a - String

Returns:

an OnmsUser

Throws:

java.io.IOException

hasUser

boolean hasUser(java.lang.String userName)
         throws java.io.IOException

hasUser

Parameters:

a - String

Returns:

a boolean

Throws:

java.io.IOException

getUserNames

java.util.List<java.lang.String> getUserNames()
                                       throws java.io.IOException

getUserNames

Returns:

a List

Throws:

java.io.IOException

getUser

User getUser(java.lang.String name)
      throws java.io.IOException

getUser

Parameters:

a - String

Returns:

a User

Throws:

java.io.IOException

getTuiPin

java.lang.String getTuiPin(java.lang.String name)
                    throws java.io.IOException

getTuiPin

Parameters:

a - String

Returns:

a String

Throws:

java.io.IOException

getTuiPin

java.lang.String getTuiPin(User user)
                    throws java.io.IOException

getTuiPin

Parameters:

a - User

Returns:

a String

Throws:

java.io.IOException

getMicroblogName

java.lang.String getMicroblogName(java.lang.String name)
                           throws java.io.FileNotFoundException,
                                  java.io.IOException

getMicroblogName

Parameters:

a - String

Returns:

a String

Throws:

java.io.FileNotFoundException

java.io.IOException

setContactInfo

void setContactInfo(java.lang.String userId,
                    UserConfig.ContactType contactType,
                    java.lang.String contactValue)
             throws java.lang.Exception

setContactInfo

Parameters:

a - String

a - ContactType

a - String

Throws:

java.lang.Exception

getContactInfo

java.lang.String getContactInfo(java.lang.String userId,
                                UserConfig.ContactType contactType)
                         throws java.io.IOException

getContactInfo

Parameters:

a - String

a - ContactType

Returns:

a String

Throws:

java.io.IOException

getContactInfo

java.lang.String getContactInfo(java.lang.String userID,
                                java.lang.String command)
                         throws java.io.IOException

getContactInfo

Parameters:

a - String

a - String

Returns:

a String

Throws:

java.io.IOException

getContactInfo

java.lang.String getContactInfo(User user,
                                java.lang.String command)
                         throws java.io.IOException

getContactInfo

Parameters:

a - User

a - String

Returns:

a String

Throws:

java.io.IOException

getContactServiceProvider

java.lang.String getContactServiceProvider(java.lang.String userID,
                                           java.lang.String command)
                                    throws java.io.IOException

getContactServiceProvider

Parameters:

a - String

a - String

Returns:

a String

Throws:

java.io.IOException

getContactServiceProvider

java.lang.String getContactServiceProvider(User user,
                                           java.lang.String command)
                                    throws java.io.IOException

getContactServiceProvider

Parameters:

a - User

a - String

Returns:

a String

Throws:

java.io.IOException

getEmail

java.lang.String getEmail(java.lang.String userID)
                   throws java.io.IOException

getEmail

Parameters:

a - String

Returns:

a String

Throws:

java.io.IOException

getEmail

java.lang.String getEmail(User user)
                   throws java.io.IOException

getEmail

Parameters:

a - User

Returns:

a String

Throws:

java.io.IOException

getPagerEmail

java.lang.String getPagerEmail(java.lang.String userID)
                        throws java.io.IOException

getPagerEmail

Parameters:

a - String

Returns:

a String

Throws:

java.io.IOException

getPagerEmail

java.lang.String getPagerEmail(User user)
                        throws java.io.IOException

getPagerEmail

Parameters:

a - User

Returns:

a String

Throws:

java.io.IOException

getNumericPin

java.lang.String getNumericPin(java.lang.String userID)
                        throws java.io.IOException

getNumericaPin

Parameters:

a - String

Returns:

a String

Throws:

java.io.IOException

getNumericPin

java.lang.String getNumericPin(User user)
                        throws java.io.IOException

getNumericPin

Parameters:

a - User

Returns:

a String

Throws:

java.io.IOException

getXMPPAddress

java.lang.String getXMPPAddress(java.lang.String userID)
                         throws java.io.IOException

getXMPPAddress

Parameters:

a - String

Returns:

a String

Throws:

java.io.IOException

getXMPPAddress

java.lang.String getXMPPAddress(User user)
                         throws java.io.IOException

getXMPPAddress

Parameters:

a - User

Returns:

a String

Throws:

java.io.IOException

getNumericPage

java.lang.String getNumericPage(java.lang.String userID)
                         throws java.io.IOException

getNumericPage

Parameters:

a - String

Returns:

a String

Throws:

java.io.IOException

getNumericPage

java.lang.String getNumericPage(User user)
                         throws java.io.IOException

getNumericPage

Parameters:

a - User

Returns:

a String

Throws:

java.io.IOException

getTextPin

java.lang.String getTextPin(java.lang.String userID)
                     throws java.io.IOException

getTextPin

Parameters:

a - String

Returns:

a String

Throws:

java.io.IOException

getTextPin

java.lang.String getTextPin(User user)
                     throws java.io.IOException

getTextPin

Parameters:

a - User

Returns:

a String

Throws:

java.io.IOException

getTextPage

java.lang.String getTextPage(java.lang.String userID)
                      throws java.io.IOException

getTextPage

Parameters:

a - String

Returns:

a String

Throws:

java.io.IOException

getTextPage

java.lang.String getTextPage(User user)
                      throws java.io.IOException

getTextPage

Parameters:

a - User

Returns:

a String

Throws:

java.io.IOException

getWorkPhone

java.lang.String getWorkPhone(java.lang.String userID)
                       throws java.io.IOException

getWorkPhone

Parameters:

a - String

Returns:

a String

Throws:

java.io.IOException

getWorkPhone

java.lang.String getWorkPhone(User user)
                       throws java.io.IOException

getWorkPhone

Parameters:

a - User

Returns:

a String

Throws:

java.io.IOException

getMobilePhone

java.lang.String getMobilePhone(java.lang.String userID)
                         throws java.io.IOException

getMobilePhone

Parameters:

a - String

Returns:

a String

Throws:

java.io.IOException

getMobilePhone

java.lang.String getMobilePhone(User user)
                         throws java.io.IOException

getMobilePhone

Parameters:

a - User

Returns:

a String

Throws:

java.io.IOException

getHomePhone

java.lang.String getHomePhone(java.lang.String userID)
                       throws java.io.IOException

getHomePhone

Parameters:

a - String

Returns:

a String

Throws:

java.io.IOException

getHomePhone

java.lang.String getHomePhone(User user)
                       throws java.io.IOException

getHomePhone

Parameters:

a - User

Returns:

a String

Throws:

java.io.IOException

saveUsers

void saveUsers(java.util.Collection<User> usersList)
        throws java.lang.Exception

saveUsers

Parameters:

a - Collection

Throws:

java.lang.Exception

deleteUser

void deleteUser(java.lang.String name)
         throws java.lang.Exception

deleteUser

Parameters:

a - String

Throws:

java.lang.Exception

renameUser

void renameUser(java.lang.String oldName,
                java.lang.String newName)
         throws java.lang.Exception

renameUser

Parameters:

a - String

a - String

Throws:

java.lang.Exception

setEncryptedPassword

void setEncryptedPassword(java.lang.String userID,
                          java.lang.String aPassword,
                          boolean salted)
                   throws java.lang.Exception

setEncryptedPassword

Parameters:

a - String

a - String

a - boolean

Throws:

java.lang.Exception

setUnencryptedPassword

void setUnencryptedPassword(java.lang.String userID,
                            java.lang.String aPassword)
                     throws java.lang.Exception

setUnencryptedPassword

Parameters:

a - String

a - String

Throws:

java.lang.Exception

encryptedPassword

java.lang.String encryptedPassword(java.lang.String aPassword,
                                   boolean useSalt)

encryptedPassword

Parameters:

a - String

a - boolean

Returns:

a String

comparePasswords

boolean comparePasswords(java.lang.String userID,
                         java.lang.String aPassword)

comparePasswords

Parameters:

a - String

a - String

Returns:

a boolean

checkSaltedPassword

boolean checkSaltedPassword(java.lang.String raw,
                            java.lang.String encrypted)

checkSaltedPassword

Parameters:

a - String

a - String

Returns:

a boolean

update

void update()
     throws java.io.IOException,
            java.io.FileNotFoundException

update

Throws:

java.io.IOException

java.io.FileNotFoundException

getUsersWithRole

java.lang.String[] getUsersWithRole(java.lang.String roleid)
                             throws java.io.IOException

getUsersWithRole

Parameters:

roleid -

Returns:

Throws:

java.io.IOException

userHasRole

boolean userHasRole(User user,
                    java.lang.String roleid)
             throws java.io.FileNotFoundException,
                    java.io.IOException

userHasRole

Parameters:

a - User

a - String

Returns:

a boolean

Throws:

java.io.FileNotFoundException

java.io.IOException

isUserScheduledForRole

boolean isUserScheduledForRole(User user,
                               java.lang.String roleid,
                               java.util.Date time)
                        throws java.io.FileNotFoundException,
                               java.io.IOException

isUserScheduledForRole

Parameters:

a - User

a - String

a - Date

Returns:

a boolean

Throws:

java.io.FileNotFoundException

java.io.IOException

getUsersScheduledForRole

java.lang.String[] getUsersScheduledForRole(java.lang.String roleid,
                                            java.util.Date time)
                                     throws java.io.IOException

getUsersScheduledForRole

Parameters:

a - String

a - Date

Returns:

a String[]

Throws:

java.io.IOException

hasOnCallRole

boolean hasOnCallRole(java.lang.String roleid)
               throws java.io.IOException

hasOnCallRole

Parameters:

a - String

Returns:

a boolean

Throws:

java.io.IOException

countUsersWithRole

int countUsersWithRole(java.lang.String roleid)
                throws java.io.IOException

countUsersWithRole

Parameters:

a - String

Returns:

an int

Throws:

java.io.IOException