org.openepics.cable.services

Interface SessionService

All Known Implementing Classes:

DummySessionService, RBACSessionService

public interface SessionService

SessionService is the service layer that handles session operations.

Method Summary

Modifier and Type	Method and Description
boolean	canAdminister()
boolean	canManageOwnedCables()
String	getLoggedInName() Returns the distinguished name of the logged in user.
String	getVisibleName() Returns the name of the logged in user, which should be used for all display purposes.
boolean	isLoggedIn()
se.esss.ics.rbac.loginmodules.service.Message	login(String username, String password) Logs in with the given credentials.
se.esss.ics.rbac.loginmodules.service.Message	logout() Logs out the currently logged in user and returns the result as the message.

Method Detail

getLoggedInName

String getLoggedInName()

Returns the distinguished name of the logged in user. If no user is logged in, null is returned.

Returns:

the username of the logged in user

getVisibleName

String getVisibleName()

Returns the name of the logged in user, which should be used for all display purposes. In this case this should be the user's first name. If the user is not logged in, null is returned.

Returns:

the visible name of the logged in user

isLoggedIn

boolean isLoggedIn()

Returns:

true if the user is logged in

login

se.esss.ics.rbac.loginmodules.service.Message login(String username,
                                                    String password)

Logs in with the given credentials. Whether the action succeeded is stored in the returned result.

Parameters:

username - the user name to use

password - the password

Returns:

the result with the message and successful flag

logout

se.esss.ics.rbac.loginmodules.service.Message logout()

Logs out the currently logged in user and returns the result as the message. If the logout was successful, the message is set as successful, if it failed, the successful flag is set to false.

Returns:

the result

canAdminister

boolean canAdminister()

Returns:

true if the user can administer database, else false; if no user logged in, false is returned

canManageOwnedCables

boolean canManageOwnedCables()

Returns:

true if the user can manage cables that they own, else false; if no user logged in, false is returned