Package 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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
deleteGroup(java.lang.String name)
deleteGroupvoid
deleteRole(java.lang.String name)
deleteRolevoid
deleteUser(java.lang.String name)
deleteUserjava.util.List<Group>
findGroupsForUser(java.lang.String user)
findGroupsForUserGroup
getGroup(java.lang.String name)
getGroupjava.util.List<java.lang.String>
getGroupNames()
getGroupNamesjava.util.Map<java.lang.String,Group>
getGroups()
getGroupsOnmsGroup
getOnmsGroup(java.lang.String groupName)
getOnmsGroupOnmsGroupList
getOnmsGroupList()
getOnmsGroupListRole
getRole(java.lang.String roleName)
getRolejava.lang.String[]
getRoleNames()
getRoleNamesjava.util.Collection<Role>
getRoles()
getRolesOwnedIntervalSequence
getRoleScheduleEntries(java.lang.String roleid, java.util.Date start, java.util.Date end)
getRoleScheduleEntriesjava.util.List<Schedule>
getSchedulesForRoleAt(java.lang.String roleId, java.util.Date time)
getSchedulesForRoleAtjava.util.List<Schedule>
getUserSchedulesForRole(java.lang.String userId, java.lang.String roleId)
getUserSchedulesForRolelong
groupNextOnDuty(java.lang.String group, java.util.Calendar time)
groupNextOnDutyboolean
hasGroup(java.lang.String groupName)
hasGroupboolean
isGroupOnDuty(java.lang.String group, java.util.Calendar time)
isGroupOnDutyboolean
isUserScheduledForRole(java.lang.String userId, java.lang.String roleId, java.util.Date time)
isUserScheduledForRolevoid
renameGroup(java.lang.String oldName, java.lang.String newName)
renameGroupvoid
renameUser(java.lang.String oldName, java.lang.String newName)
renameUservoid
save(OnmsGroup group)
savevoid
saveGroup(java.lang.String name, Group details)
saveGroupvoid
saveGroups()
saveGroupsvoid
saveRole(Role role)
saveRolevoid
setGroups(java.util.Map<java.lang.String,Group> grp)
setGroupsboolean
userHasRole(java.lang.String userId, java.lang.String roleid)
userHasRole
-
-
-
Method Detail
-
setGroups
void setGroups(java.util.Map<java.lang.String,Group> grp)
setGroups
- Parameters:
a
- Map
-
getGroups
java.util.Map<java.lang.String,Group> getGroups() throws java.io.IOException
getGroups
- Returns:
- a Map
- Throws:
java.io.IOException
-
getOnmsGroupList
OnmsGroupList getOnmsGroupList() throws java.io.IOException
getOnmsGroupList
- Returns:
- an OnmsGroupList
- Throws:
java.io.IOException
-
getOnmsGroup
OnmsGroup getOnmsGroup(java.lang.String groupName) throws java.io.IOException
getOnmsGroup
- Parameters:
a
- String- Returns:
- an OnmsGroup
- Throws:
java.io.IOException
-
save
void save(OnmsGroup group) throws java.lang.Exception
save
- Parameters:
an
- OnmsGroup- Throws:
java.lang.Exception
-
hasGroup
boolean hasGroup(java.lang.String groupName) throws java.io.IOException
hasGroup
- Parameters:
a
- String- Returns:
- a boolean
- Throws:
java.io.IOException
-
getGroupNames
java.util.List<java.lang.String> getGroupNames() throws java.io.IOException
getGroupNames
- Returns:
- a List
- Throws:
java.io.IOException
-
getGroup
Group getGroup(java.lang.String name) throws java.io.IOException
getGroup
- Parameters:
a
- String- Returns:
- a Group
- Throws:
java.io.IOException
-
saveGroups
void saveGroups() throws java.lang.Exception
saveGroups
- Throws:
java.lang.Exception
-
isGroupOnDuty
boolean isGroupOnDuty(java.lang.String group, java.util.Calendar time) throws java.io.IOException
isGroupOnDuty
- Parameters:
a
- Stringa
- Calendar- Returns:
- a boolean
- Throws:
java.io.IOException
-
groupNextOnDuty
long groupNextOnDuty(java.lang.String group, java.util.Calendar time) throws java.io.IOException
groupNextOnDuty
- Parameters:
a
- Stringa
- Calendar- Returns:
- a long
- Throws:
java.io.IOException
-
saveGroup
void saveGroup(java.lang.String name, Group details) throws java.lang.Exception
saveGroup
- Parameters:
a
- Stringa
- Group- Throws:
java.lang.Exception
-
saveRole
void saveRole(Role role) throws java.lang.Exception
saveRole
- Parameters:
a
- Role- Throws:
java.lang.Exception
-
deleteUser
void deleteUser(java.lang.String name) throws java.lang.Exception
deleteUser
- Parameters:
a
- String- Throws:
java.lang.Exception
-
deleteGroup
void deleteGroup(java.lang.String name) throws java.lang.Exception
deleteGroup
- Parameters:
a
- String- Throws:
java.lang.Exception
-
deleteRole
void deleteRole(java.lang.String name) throws java.lang.Exception
deleteRole
- Parameters:
a
- String- Throws:
java.lang.Exception
-
renameGroup
void renameGroup(java.lang.String oldName, java.lang.String newName) throws java.lang.Exception
renameGroup
- Parameters:
a
- Stringa
- String- Throws:
java.lang.Exception
-
renameUser
void renameUser(java.lang.String oldName, java.lang.String newName) throws java.lang.Exception
renameUser
- Parameters:
a
- Stringa
- String- Throws:
java.lang.Exception
-
getRoleNames
java.lang.String[] getRoleNames()
getRoleNames
- Returns:
- a String[]
-
getRoles
java.util.Collection<Role> getRoles()
getRoles
- Returns:
- a Collection
-
getRole
Role getRole(java.lang.String roleName)
getRole
- Parameters:
a
- String- Returns:
- a Role
-
userHasRole
boolean userHasRole(java.lang.String userId, java.lang.String roleid) throws java.io.IOException
userHasRole
- Parameters:
a
- Stringa
- String- Returns:
- a boolean
- Throws:
java.io.IOException
-
getSchedulesForRoleAt
java.util.List<Schedule> getSchedulesForRoleAt(java.lang.String roleId, java.util.Date time) throws java.io.IOException
getSchedulesForRoleAt
- Parameters:
a
- Stringa
- String- Returns:
- a List
- Throws:
java.io.IOException
-
getUserSchedulesForRole
java.util.List<Schedule> getUserSchedulesForRole(java.lang.String userId, java.lang.String roleId) throws java.io.IOException
getUserSchedulesForRole
- Parameters:
a
- Stringa
- String- Returns:
- a List
- Throws:
java.io.IOException
-
isUserScheduledForRole
boolean isUserScheduledForRole(java.lang.String userId, java.lang.String roleId, java.util.Date time) throws java.io.IOException
isUserScheduledForRole
- Parameters:
a
- Stringa
- Stringa
- Date- Returns:
- a boolean
- Throws:
java.io.IOException
-
getRoleScheduleEntries
OwnedIntervalSequence getRoleScheduleEntries(java.lang.String roleid, java.util.Date start, java.util.Date end) throws java.io.IOException
getRoleScheduleEntries
- Parameters:
a
- Stringa
- Datea
- Date- Returns:
- an OwnedIntervalSequence
- Throws:
java.io.IOException
-
findGroupsForUser
java.util.List<Group> findGroupsForUser(java.lang.String user)
findGroupsForUser
- Parameters:
a
- String- Returns:
- a List
-
-