org.n52.iceland.config

Interface AdminUserService

All Known Implementing Classes:

AdminUserServiceImpl

public interface AdminUserService

TODO JavaDoc

Method Summary

Modifier and Type	Method and Description
AdministratorUser	createAdminUser(String username, String password) Creates a new AdministratorUser.
void	deleteAdminUser(AdministratorUser user) Deletes the user previously returned by getAdminUser(java.lang.String) or getAdminUsers().
void	deleteAdminUser(String username) Deletes the user with the specified username.
void	deleteAll() Deletes all users.
AdministratorUser	getAdminUser(String username) Gets the administrator user with the specified user name.
Set<AdministratorUser>	getAdminUsers() Gets all registered administrator users.
boolean	hasAdminUser() Checks if a administrator user exists.
void	saveAdminUser(AdministratorUser user) Saves a user previously returned by getAdminUser(java.lang.String) or getAdminUsers().

Method Detail

createAdminUser

AdministratorUser createAdminUser(String username,
                                  String password)

Creates a new AdministratorUser. This method will fail if the username is already used by another user.

Parameters:

username - the proposed username

password - the proposed (hashed) password

Returns:

the user

deleteAdminUser

void deleteAdminUser(String username)

Deletes the user with the specified username.

Parameters:

username - the username

deleteAdminUser

void deleteAdminUser(AdministratorUser user)

Deletes the user previously returned by getAdminUser(java.lang.String) or getAdminUsers().

Parameters:

user - the user

getAdminUser

AdministratorUser getAdminUser(String username)

Gets the administrator user with the specified user name.

Parameters:

username - the username

Returns:

the administrator user or null if no user with the specified name exists

getAdminUsers

Set<AdministratorUser> getAdminUsers()

Gets all registered administrator users.

Returns:

the users

hasAdminUser

boolean hasAdminUser()

Checks if a administrator user exists.

Returns:

true if there is a admin user, otherwise false.

saveAdminUser

void saveAdminUser(AdministratorUser user)

Saves a user previously returned by getAdminUser(java.lang.String) or getAdminUsers().

Parameters:

user - the user to change

deleteAll

void deleteAll()

Deletes all users.