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 and Description
static class	UserConfig.ContactType

Method Summary

Methods

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

Method Detail

parseXML

void parseXML(InputStream in)
              throws org.exolab.castor.xml.MarshalException,
                     org.exolab.castor.xml.ValidationException

parseXML

Parameters:

an - InputStream

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

saveUser

void saveUser(String name,
            User details)
              throws Exception

saveUser

Parameters:

a - String

a - User

Throws:

Exception

save

void save(OnmsUser onmsUser)
          throws Exception

save

Parameters:

an - OnmsUser

Throws:

Exception

isUserOnDuty

boolean isUserOnDuty(String user,
                   Calendar time)
                     throws IOException,
                            org.exolab.castor.xml.MarshalException,
                            org.exolab.castor.xml.ValidationException

isUserOnDuty

Parameters:

a - String

a - Calendar

Returns:

a boolean

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

getUsers

Map<String,User> getUsers()
                          throws IOException,
                                 org.exolab.castor.xml.MarshalException,
                                 org.exolab.castor.xml.ValidationException

getUsers

Returns:

a Map

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

getOnmsUserList

OnmsUserList getOnmsUserList()
                             throws org.exolab.castor.xml.MarshalException,
                                    org.exolab.castor.xml.ValidationException,
                                    IOException

getOnmsUserList

Returns:

an OnmsUserList

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

IOException

getOnmsUser

OnmsUser getOnmsUser(String username)
                     throws org.exolab.castor.xml.MarshalException,
                            org.exolab.castor.xml.ValidationException,
                            IOException

getOnmsUser

Parameters:

a - String

Returns:

an OnmsUser

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

IOException

hasUser

boolean hasUser(String userName)
                throws IOException,
                       org.exolab.castor.xml.MarshalException,
                       org.exolab.castor.xml.ValidationException

hasUser

Parameters:

a - String

Returns:

a boolean

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

getUserNames

List<String> getUserNames()
                          throws IOException,
                                 org.exolab.castor.xml.MarshalException,
                                 org.exolab.castor.xml.ValidationException

getUserNames

Returns:

a List

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

getUser

User getUser(String name)
             throws IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

getUser

Parameters:

a - String

Returns:

a User

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

getTuiPin

String getTuiPin(String name)
                 throws IOException,
                        org.exolab.castor.xml.MarshalException,
                        org.exolab.castor.xml.ValidationException

getTuiPin

Parameters:

a - String

Returns:

a String

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

getTuiPin

String getTuiPin(User user)
                 throws IOException,
                        org.exolab.castor.xml.MarshalException,
                        org.exolab.castor.xml.ValidationException

getTuiPin

Parameters:

a - User

Returns:

a String

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

getMicroblogName

String getMicroblogName(String name)
                        throws org.exolab.castor.xml.MarshalException,
                               org.exolab.castor.xml.ValidationException,
                               FileNotFoundException,
                               IOException

getMicroblogName

Parameters:

a - String

Returns:

a String

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

FileNotFoundException

IOException

setContactInfo

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

setContactInfo

Parameters:

a - String

a - ContactType

a - String

Throws:

Exception

getContactInfo

String getContactInfo(String userId,
                    UserConfig.ContactType contactType)
                      throws org.exolab.castor.xml.MarshalException,
                             org.exolab.castor.xml.ValidationException,
                             IOException

getContactInfo

Parameters:

a - String

a - ContactType

Returns:

a String

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

IOException

getContactInfo

String getContactInfo(String userID,
                    String command)
                      throws IOException,
                             org.exolab.castor.xml.MarshalException,
                             org.exolab.castor.xml.ValidationException

getContactInfo

Parameters:

a - String

a - String

Returns:

a String

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

getContactInfo

String getContactInfo(User user,
                    String command)
                      throws IOException,
                             org.exolab.castor.xml.MarshalException,
                             org.exolab.castor.xml.ValidationException

getContactInfo

Parameters:

a - User

a - String

Returns:

a String

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

getContactServiceProvider

String getContactServiceProvider(String userID,
                               String command)
                                 throws IOException,
                                        org.exolab.castor.xml.MarshalException,
                                        org.exolab.castor.xml.ValidationException

getContactServiceProvider

Parameters:

a - String

a - String

Returns:

a String

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

getContactServiceProvider

String getContactServiceProvider(User user,
                               String command)
                                 throws IOException,
                                        org.exolab.castor.xml.MarshalException,
                                        org.exolab.castor.xml.ValidationException

getContactServiceProvider

Parameters:

a - User

a - String

Returns:

a String

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

getEmail

String getEmail(String userID)
                throws IOException,
                       org.exolab.castor.xml.MarshalException,
                       org.exolab.castor.xml.ValidationException

getEmail

Parameters:

a - String

Returns:

a String

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

getEmail

String getEmail(User user)
                throws IOException,
                       org.exolab.castor.xml.MarshalException,
                       org.exolab.castor.xml.ValidationException

getEmail

Parameters:

a - User

Returns:

a String

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

getPagerEmail

String getPagerEmail(String userID)
                     throws IOException,
                            org.exolab.castor.xml.MarshalException,
                            org.exolab.castor.xml.ValidationException

getPagerEmail

Parameters:

a - String

Returns:

a String

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

getPagerEmail

String getPagerEmail(User user)
                     throws IOException,
                            org.exolab.castor.xml.MarshalException,
                            org.exolab.castor.xml.ValidationException

getPagerEmail

Parameters:

a - User

Returns:

a String

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

getNumericPin

String getNumericPin(String userID)
                     throws IOException,
                            org.exolab.castor.xml.MarshalException,
                            org.exolab.castor.xml.ValidationException

getNumericaPin

Parameters:

a - String

Returns:

a String

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

getNumericPin

String getNumericPin(User user)
                     throws IOException,
                            org.exolab.castor.xml.MarshalException,
                            org.exolab.castor.xml.ValidationException

getNumericPin

Parameters:

a - User

Returns:

a String

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

getXMPPAddress

String getXMPPAddress(String userID)
                      throws IOException,
                             org.exolab.castor.xml.MarshalException,
                             org.exolab.castor.xml.ValidationException

getXMPPAddress

Parameters:

a - String

Returns:

a String

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

getXMPPAddress

String getXMPPAddress(User user)
                      throws IOException,
                             org.exolab.castor.xml.MarshalException,
                             org.exolab.castor.xml.ValidationException

getXMPPAddress

Parameters:

a - User

Returns:

a String

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

getNumericPage

String getNumericPage(String userID)
                      throws IOException,
                             org.exolab.castor.xml.MarshalException,
                             org.exolab.castor.xml.ValidationException

getNumericPage

Parameters:

a - String

Returns:

a String

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

getNumericPage

String getNumericPage(User user)
                      throws IOException,
                             org.exolab.castor.xml.MarshalException,
                             org.exolab.castor.xml.ValidationException

getNumericPage

Parameters:

a - User

Returns:

a String

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

getTextPin

String getTextPin(String userID)
                  throws IOException,
                         org.exolab.castor.xml.MarshalException,
                         org.exolab.castor.xml.ValidationException

getTextPin

Parameters:

a - String

Returns:

a String

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

getTextPin

String getTextPin(User user)
                  throws IOException,
                         org.exolab.castor.xml.MarshalException,
                         org.exolab.castor.xml.ValidationException

getTextPin

Parameters:

a - User

Returns:

a String

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

getTextPage

String getTextPage(String userID)
                   throws IOException,
                          org.exolab.castor.xml.MarshalException,
                          org.exolab.castor.xml.ValidationException

getTextPage

Parameters:

a - String

Returns:

a String

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

getTextPage

String getTextPage(User user)
                   throws IOException,
                          org.exolab.castor.xml.MarshalException,
                          org.exolab.castor.xml.ValidationException

getTextPage

Parameters:

a - User

Returns:

a String

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

getWorkPhone

String getWorkPhone(String userID)
                    throws org.exolab.castor.xml.MarshalException,
                           org.exolab.castor.xml.ValidationException,
                           IOException

getWorkPhone

Parameters:

a - String

Returns:

a String

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

IOException

getWorkPhone

String getWorkPhone(User user)
                    throws org.exolab.castor.xml.MarshalException,
                           org.exolab.castor.xml.ValidationException,
                           IOException

getWorkPhone

Parameters:

a - User

Returns:

a String

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

IOException

getMobilePhone

String getMobilePhone(String userID)
                      throws org.exolab.castor.xml.MarshalException,
                             org.exolab.castor.xml.ValidationException,
                             IOException

getMobilePhone

Parameters:

a - String

Returns:

a String

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

IOException

getMobilePhone

String getMobilePhone(User user)
                      throws org.exolab.castor.xml.MarshalException,
                             org.exolab.castor.xml.ValidationException,
                             IOException

getMobilePhone

Parameters:

a - User

Returns:

a String

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

IOException

getHomePhone

String getHomePhone(String userID)
                    throws org.exolab.castor.xml.MarshalException,
                           org.exolab.castor.xml.ValidationException,
                           IOException

getHomePhone

Parameters:

a - String

Returns:

a String

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

IOException

getHomePhone

String getHomePhone(User user)
                    throws org.exolab.castor.xml.MarshalException,
                           org.exolab.castor.xml.ValidationException,
                           IOException

getHomePhone

Parameters:

a - User

Returns:

a String

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

IOException

saveUsers

void saveUsers(Collection<User> usersList)
               throws Exception

saveUsers

Parameters:

a - Collection

Throws:

Exception

deleteUser

void deleteUser(String name)
                throws Exception

deleteUser

Parameters:

a - String

Throws:

Exception

renameUser

void renameUser(String oldName,
              String newName)
                throws Exception

renameUser

Parameters:

a - String

a - String

Throws:

Exception

setEncryptedPassword

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

setEncryptedPassword

Parameters:

a - String

a - String

a - boolean

Throws:

Exception

setUnencryptedPassword

void setUnencryptedPassword(String userID,
                          String aPassword)
                            throws Exception

setUnencryptedPassword

Parameters:

a - String

a - String

Throws:

Exception

encryptedPassword

String encryptedPassword(String aPassword,
                       boolean useSalt)

encryptedPassword

Parameters:

a - String

a - boolean

Returns:

a String

comparePasswords

boolean comparePasswords(String userID,
                       String aPassword)

comparePasswords

Parameters:

a - String

a - String

Returns:

a boolean

checkSaltedPassword

boolean checkSaltedPassword(String raw,
                          String encrypted)

checkSaltedPassword

Parameters:

a - String

a - String

Returns:

a boolean

update

void update()
            throws IOException,
                   FileNotFoundException,
                   org.exolab.castor.xml.MarshalException,
                   org.exolab.castor.xml.ValidationException

update

Throws:

IOException

FileNotFoundException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

getUsersWithRole

String[] getUsersWithRole(String roleid)
                          throws IOException,
                                 org.exolab.castor.xml.MarshalException,
                                 org.exolab.castor.xml.ValidationException

getUsersWithRole

Parameters:

roleid -

Returns:

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

userHasRole

boolean userHasRole(User user,
                  String roleid)
                    throws FileNotFoundException,
                           org.exolab.castor.xml.MarshalException,
                           org.exolab.castor.xml.ValidationException,
                           IOException

userHasRole

Parameters:

a - User

a - String

Returns:

a boolean

Throws:

FileNotFoundException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

IOException

isUserScheduledForRole

boolean isUserScheduledForRole(User user,
                             String roleid,
                             Date time)
                               throws FileNotFoundException,
                                      org.exolab.castor.xml.MarshalException,
                                      org.exolab.castor.xml.ValidationException,
                                      IOException

isUserScheduledForRole

Parameters:

a - User

a - String

a - Date

Returns:

a boolean

Throws:

FileNotFoundException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

IOException

getUsersScheduledForRole

String[] getUsersScheduledForRole(String roleid,
                                Date time)
                                  throws org.exolab.castor.xml.MarshalException,
                                         org.exolab.castor.xml.ValidationException,
                                         IOException

getUsersScheduledForRole

Parameters:

a - String

a - Date

Returns:

a String[]

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

IOException

hasRole

boolean hasRole(String roleid)
                throws org.exolab.castor.xml.MarshalException,
                       org.exolab.castor.xml.ValidationException,
                       IOException

hasRole

Parameters:

a - String

Returns:

a boolean

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

IOException

countUsersWithRole

int countUsersWithRole(String roleid)
                       throws org.exolab.castor.xml.MarshalException,
                              org.exolab.castor.xml.ValidationException,
                              IOException

countUsersWithRole

Parameters:

a - String

Returns:

an int

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

IOException