org.eclipse.emf.emfstore.internal.client.ui.dialogs.login
Class LoginDialogController

java.lang.Object
  org.eclipse.emf.emfstore.internal.client.ui.dialogs.login.LoginDialogController

All Implemented Interfaces:

ILoginDialogController

public class LoginDialogController
extends Object
implements ILoginDialogController

The login dialog controller manages a given ESUsersession and/or a ESServer to determine when it is necessary to open a LoginDialog in order to authenticate the user. It does not, however, open a dialog, if the usersession is already logged in.

Author:

ovonwesen, emueller

Constructor Summary

LoginDialogController()

Method Summary

List<ESUsersession>	getKnownUsersessions() Returns the available ESUsersessions based on server info object, that is retrieved via ILoginDialogController.getServer().
ESServer	getServer() Returns the ESServer the login dialog controller was assigned to, if any.
String	getServerLabel() Returns the server name.
ESUsersession	getUsersession() Returns the ESUsersession the login dialog controller was assigned to, if any.
ESUsersession	login(ESServer server) Perform a login using an ESUsersession that can be determined with the given ESServer.
ESUsersession	login(ESServer server, boolean force) Perform a login using an ESUsersession that can be determined with the given ESServer.
ESUsersession	login(ESUsersession usersession) Perform a login using the given ESUsersession.
void	login(ESUsersession usersession, boolean force) Perform a login using the given ESUsersession.
void	validate(ESUsersession session) Tries to login the given ESUsersession.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LoginDialogController

public LoginDialogController()

Method Detail

getKnownUsersessions

public List<ESUsersession> getKnownUsersessions()

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

Specified by:

getKnownUsersessions in interface ILoginDialogController

Returns:

all available user sessions as an array.

See Also:

ILoginDialogController.getKnownUsersessions()

getServerLabel

public String getServerLabel()

Returns the server name.

Returns:

the label

validate

public void validate(ESUsersession session)
              throws ESException

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

Specified by:

validate in interface ILoginDialogController

Parameters:

session - the usersession to be validated

Throws:

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

See Also:

ILoginDialogController.validate(org.eclipse.emf.emfstore.client.ESUsersession)

getUsersession

public ESUsersession getUsersession()

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

Specified by:

getUsersession in interface ILoginDialogController

Returns:

the assigned user session or null, if none exists

See Also:

ILoginDialogController.getUsersession()

getServer

public ESServer getServer()

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

Specified by:

getServer in interface ILoginDialogController

Returns:

the server info, if any

See Also:

ILoginDialogController.getServer()

login

public ESUsersession login(ESServer server,
                           boolean force)
                    throws ESException

Perform a login using an ESUsersession that can be determined with the given ESServer.

Parameters:

server - the server info to be used in order to determine a valid usersession

force - whether to force requesting the password

Returns:

a logged-in usersession

Throws:

ESException - in case the login fails

login

public void login(ESUsersession usersession,
                  boolean force)
           throws ESException

Perform a login using the given ESUsersession.

Parameters:

usersession - the usersession to be used during login

force - whether to force requesting the password

Throws:

ESException - in case the login fails

login

public ESUsersession login(ESServer server)
                    throws ESException

Perform a login using an ESUsersession that can be determined with the given ESServer.

Parameters:

server - the server info to be used in order to determine a valid usersession

Returns:

a logged-in usersession

Throws:

ESException - in case the login fails

login

public ESUsersession login(ESUsersession usersession)
                    throws ESException

Perform a login using the given ESUsersession.

Parameters:

usersession - the usersession to be used during login

Returns:

usersession

Throws:

ESException - in case the login fails