org.opennms.netmgt.config.api

Interface GroupConfig

All Known Implementing Classes:

GroupFactory, GroupManager, MockGroupManager

public interface GroupConfig

An interface for GroupManager

Author:

Ryan Lambeth

Method Summary

Modifier and Type	Method and Description
void	deleteGroup(String name) deleteGroup
void	deleteRole(String name) deleteRole
void	deleteUser(String name) deleteUser
List<Group>	findGroupsForUser(String user) findGroupsForUser
Group	getGroup(String name) getGroup
List<String>	getGroupNames() getGroupNames
Map<String,Group>	getGroups() getGroups
OnmsGroup	getOnmsGroup(String groupName) getOnmsGroup
OnmsGroupList	getOnmsGroupList() getOnmsGroupList
Role	getRole(String roleName) getRole
String[]	getRoleNames() getRoleNames
Collection<Role>	getRoles() getRoles
OwnedIntervalSequence	getRoleScheduleEntries(String roleid, Date start, Date end) getRoleScheduleEntries
List<Schedule>	getSchedulesForRoleAt(String roleId, Date time) getSchedulesForRoleAt
List<Schedule>	getUserSchedulesForRole(String userId, String roleId) getUserSchedulesForRole
long	groupNextOnDuty(String group, Calendar time) groupNextOnDuty
boolean	hasGroup(String groupName) hasGroup
boolean	isGroupOnDuty(String group, Calendar time) isGroupOnDuty
boolean	isUserScheduledForRole(String userId, String roleId, Date time) isUserScheduledForRole
void	renameGroup(String oldName, String newName) renameGroup
void	renameUser(String oldName, String newName) renameUser
void	save(OnmsGroup group) save
void	saveGroup(String name, Group details) saveGroup
void	saveGroups() saveGroups
void	saveRole(Role role) saveRole
void	setGroups(Map<String,Group> grp) setGroups
boolean	userHasRole(String userId, String roleid) userHasRole

Method Detail

setGroups

void setGroups(Map<String,Group> grp)

setGroups

Parameters:

a - Map

getGroups

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

getGroups

Returns:

a Map

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

getOnmsGroupList

OnmsGroupList getOnmsGroupList()
                        throws org.exolab.castor.xml.MarshalException,
                               org.exolab.castor.xml.ValidationException,
                               IOException

getOnmsGroupList

Returns:

an OnmsGroupList

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

IOException

getOnmsGroup

OnmsGroup getOnmsGroup(String groupName)
                throws org.exolab.castor.xml.MarshalException,
                       org.exolab.castor.xml.ValidationException,
                       IOException

getOnmsGroup

Parameters:

a - String

Returns:

an OnmsGroup

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

IOException

save

void save(OnmsGroup group)
   throws Exception

save

Parameters:

an - OnmsGroup

Throws:

Exception

hasGroup

boolean hasGroup(String groupName)
          throws IOException,
                 org.exolab.castor.xml.MarshalException,
                 org.exolab.castor.xml.ValidationException

hasGroup

Parameters:

a - String

Returns:

a boolean

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

getGroupNames

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

getGroupNames

Returns:

a List

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

getGroup

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

getGroup

Parameters:

a - String

Returns:

a Group

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

saveGroups

void saveGroups()
         throws Exception

saveGroups

Throws:

Exception

isGroupOnDuty

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

isGroupOnDuty

Parameters:

a - String

a - Calendar

Returns:

a boolean

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

groupNextOnDuty

long groupNextOnDuty(String group,
                     Calendar time)
              throws IOException,
                     org.exolab.castor.xml.MarshalException,
                     org.exolab.castor.xml.ValidationException

groupNextOnDuty

Parameters:

a - String

a - Calendar

Returns:

a long

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

saveGroup

void saveGroup(String name,
               Group details)
        throws Exception

saveGroup

Parameters:

a - String

a - Group

Throws:

Exception

saveRole

void saveRole(Role role)
       throws Exception

saveRole

Parameters:

a - Role

Throws:

Exception

deleteUser

void deleteUser(String name)
         throws Exception

deleteUser

Parameters:

a - String

Throws:

Exception

deleteGroup

void deleteGroup(String name)
          throws Exception

deleteGroup

Parameters:

a - String

Throws:

Exception

deleteRole

void deleteRole(String name)
         throws Exception

deleteRole

Parameters:

a - String

Throws:

Exception

renameGroup

void renameGroup(String oldName,
                 String newName)
          throws Exception

renameGroup

Parameters:

a - String

a - String

Throws:

Exception

renameUser

void renameUser(String oldName,
                String newName)
         throws Exception

renameUser

Parameters:

a - String

a - String

Throws:

Exception

getRoleNames

String[] getRoleNames()

getRoleNames

Returns:

a String[]

getRoles

Collection<Role> getRoles()

getRoles

Returns:

a Collection

getRole

Role getRole(String roleName)

getRole

Parameters:

a - String

Returns:

a Role

userHasRole

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

userHasRole

Parameters:

a - String

a - String

Returns:

a boolean

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

IOException

getSchedulesForRoleAt

List<Schedule> getSchedulesForRoleAt(String roleId,
                                     Date time)
                              throws org.exolab.castor.xml.MarshalException,
                                     org.exolab.castor.xml.ValidationException,
                                     IOException

getSchedulesForRoleAt

Parameters:

a - String

a - String

Returns:

a List

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

IOException

getUserSchedulesForRole

List<Schedule> getUserSchedulesForRole(String userId,
                                       String roleId)
                                throws org.exolab.castor.xml.MarshalException,
                                       org.exolab.castor.xml.ValidationException,
                                       IOException

getUserSchedulesForRole

Parameters:

a - String

a - String

Returns:

a List

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

IOException

isUserScheduledForRole

boolean isUserScheduledForRole(String userId,
                               String roleId,
                               Date time)
                        throws org.exolab.castor.xml.MarshalException,
                               org.exolab.castor.xml.ValidationException,
                               IOException

isUserScheduledForRole

Parameters:

a - String

a - String

a - Date

Returns:

a boolean

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

IOException

getRoleScheduleEntries

OwnedIntervalSequence getRoleScheduleEntries(String roleid,
                                             Date start,
                                             Date end)
                                      throws org.exolab.castor.xml.MarshalException,
                                             org.exolab.castor.xml.ValidationException,
                                             IOException

getRoleScheduleEntries

Parameters:

a - String

a - Date

a - Date

Returns:

an OwnedIntervalSequence

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

IOException

findGroupsForUser

List<Group> findGroupsForUser(String user)

findGroupsForUser

Parameters:

a - String

Returns:

a List