org.opennms.acl.service

Interface UserService

All Superinterfaces:

PagerService

All Known Implementing Classes:

UserServiceImpl

public interface UserService
extends PagerService

UserService interface.

Since:

jdk 1.5.0

Version:

$Id: $

Author:

Massimiliano Dessì (desmax74@yahoo.it)

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	disableUser(String id) disable a user
List<UserDTOLight>	getDisabledUsers(Pager pager) Retrieve the disabled users
List<UserDTOLight>	getEnabledUsers(Pager pager) getEnabledUsers
Object	getIdUser(String username) Retrieve the id of user by username
UserView	getUser(String id) retrieve a user
UserDTO	getUserCredentials(String id) retrieve a user with credentials
Integer	getUsersNumber() getUsersNumber
UserAuthoritiesDTO	getUserWithAuthorities(String username) retrieve a user with their authorities
UserAuthoritiesDTO	getUserWithAuthoritiesByID(Integer sid) retrieve a user with their id
boolean	save(UserAuthoritiesDTO user) save
boolean	save(UserDTO user) Method only for admin, insert a user or change the user password

Methods inherited from interface org.opennms.acl.service.PagerService

getTotalItemsNumber

Method Detail

getEnabledUsers

List<UserDTOLight> getEnabledUsers(Pager pager)

getEnabledUsers

Parameters:

pager - a Pager object.

Returns:

a List object.

getDisabledUsers

List<UserDTOLight> getDisabledUsers(Pager pager)

Retrieve the disabled users

Parameters:

pager - a Pager object.

Returns:

a List object.

getIdUser

Object getIdUser(String username)

Retrieve the id of user by username

Parameters:

username - a String object.

Returns:

the unique identifier

disableUser

Boolean disableUser(String id)

disable a user

Parameters:

id - a String object.

Returns:

the outcome of disable operation

getUser

UserView getUser(String id)

retrieve a user

Parameters:

id - a String object.

Returns:

a UserView

getUserCredentials

UserDTO getUserCredentials(String id)

retrieve a user with credentials

Parameters:

id - a String object.

Returns:

a UserView

getUserWithAuthorities

UserAuthoritiesDTO getUserWithAuthorities(String username)

retrieve a user with their authorities

Parameters:

username - a String object.

Returns:

UserAuthoritiesDTO with their roles

getUserWithAuthoritiesByID

UserAuthoritiesDTO getUserWithAuthoritiesByID(Integer sid)

retrieve a user with their id

Parameters:

sid - a Integer object.

Returns:

UserAuthoritiesDTO with their authorities

getUsersNumber

Integer getUsersNumber()

getUsersNumber

Returns:

user's number

save

boolean save(UserDTO user)

Method only for admin, insert a user or change the user password

Parameters:

user - a UserDTO object.

Returns:

a boolean.

save

boolean save(UserAuthoritiesDTO user)

save

Parameters:

user - a UserAuthoritiesDTO object.

Returns:

a boolean.