org.eclipse.emf.emfstore.internal.client.ui.dialogs.login
Interface ILoginDialogController

All Known Implementing Classes:

LoginDialogController

public interface ILoginDialogController

The login dialog controller manages a given ESUsersession and/or a ESServer instance to determine when it is necessary to open a LoginDialog in order to authenticate the user. If authentication already took place no such dialog should be opened.

Author:

ovonwesen, emueller

Method Summary

List<ESUsersession>	getKnownUsersessions() Returns the available ESUsersessions based on server info object, that is retrieved via getServer().
ESServer	getServer() Returns the ESServer the login dialog controller was assigned to, if any.
ESUsersession	getUsersession() Returns the ESUsersession the login dialog controller was assigned to, if any.
void	validate(ESUsersession usersession) Tries to login the given ESUsersession.

Method Detail

validate

void validate(ESUsersession usersession)
              throws ESException

Tries to login the given ESUsersession. If successful, the user session is attached to the workspace and saved.

Parameters:

usersession - the usersession to be validated

Throws:

ESException - in case the log-in of the user session fails

getUsersession

ESUsersession getUsersession()

Returns the ESUsersession the login dialog controller was assigned to, if any.

Returns:

the assigned user session or null, if none exists

getKnownUsersessions

List<ESUsersession> getKnownUsersessions()

Returns the available ESUsersessions based on server info object, that is retrieved via getServer().

Returns:

all available user sessions as an array.

getServer

ESServer getServer()

Returns the ESServer the login dialog controller was assigned to, if any. If no server info was set, getUsersession() will be used to try to determine the relevant server info.

Returns:

the server info, if any