Package jmri

Interface PermissionManager

All Known Implementing Classes:

DefaultPermissionManager

public interface PermissionManager

A manager for permissions.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PermissionManager.BadPasswordException
static class	PermissionManager.BadUserOrPasswordException
static interface	PermissionManager.LoginListener
static class	PermissionManager.RoleAlreadyExistsException
static class	PermissionManager.RoleDoesNotExistException
static class	PermissionManager.UserAlreadyExistsException
static class	PermissionManager.UserDoesNotExistException

Method Summary

Modifier and Type	Method	Description
void	addLoginListener(PermissionManager.LoginListener listener)
Role	addRole(java.lang.String name)
User	addUser(java.lang.String username, java.lang.String password)
void	changePassword(java.lang.String newPassword, java.lang.String oldPassword)
boolean	checkPermission(Permission permission)	Checks if the current user has the permission.
java.lang.String	getCurrentUserName()
boolean	hasPermission(Permission permission)
boolean	isAllowEmptyPasswords()
boolean	isCurrentUser(java.lang.String username)
boolean	isCurrentUser(User user)
boolean	isEnabled()
boolean	isGuestUser(User user)
boolean	isLoggedIn()
boolean	login(java.lang.String username, java.lang.String password)
void	logout()
void	registerOwner(PermissionOwner owner)
void	registerPermission(Permission permission)
void	removeRole(java.lang.String name)
void	removeUser(java.lang.String username)
void	setAllowEmptyPasswords(boolean value)
void	setEnabled(boolean enabled)
void	storePermissionSettings()

Method Detail

addRole

Role addRole(java.lang.String name)
      throws PermissionManager.RoleAlreadyExistsException

Throws:

PermissionManager.RoleAlreadyExistsException

removeRole

void removeRole(java.lang.String name)
         throws PermissionManager.RoleDoesNotExistException

Throws:

PermissionManager.RoleDoesNotExistException

addUser

User addUser(java.lang.String username,
             java.lang.String password)
      throws PermissionManager.UserAlreadyExistsException

Throws:

PermissionManager.UserAlreadyExistsException

removeUser

void removeUser(java.lang.String username)
         throws PermissionManager.UserDoesNotExistException

Throws:

PermissionManager.UserDoesNotExistException

changePassword

void changePassword(java.lang.String newPassword,
                    java.lang.String oldPassword)

login

boolean login(java.lang.String username,
              java.lang.String password)

logout

void logout()

isLoggedIn

boolean isLoggedIn()

isCurrentUser

boolean isCurrentUser(java.lang.String username)

isCurrentUser

boolean isCurrentUser(User user)

getCurrentUserName

java.lang.String getCurrentUserName()

isGuestUser

boolean isGuestUser(User user)

addLoginListener

void addLoginListener(PermissionManager.LoginListener listener)

isEnabled

boolean isEnabled()

setEnabled

void setEnabled(boolean enabled)

isAllowEmptyPasswords

boolean isAllowEmptyPasswords()

setAllowEmptyPasswords

void setAllowEmptyPasswords(boolean value)

hasPermission

boolean hasPermission(Permission permission)

checkPermission

boolean checkPermission(Permission permission)

Checks if the current user has the permission. If not, show a message dialog if not headless. Otherwise log a message.

Parameters:

permission - the permission to check

Returns:

true if the user has the permission, false otherwise

registerOwner

void registerOwner(PermissionOwner owner)

registerPermission

void registerPermission(Permission permission)

storePermissionSettings

void storePermissionSettings()