org.eclipse.emf.emfstore.internal.client.model.connectionmanager
Interface ConnectionManager

All Superinterfaces:

EMFStore, EMFStoreInterface

All Known Implementing Classes:

XmlRpcConnectionManager

public interface ConnectionManager
extends EMFStore

The connection manager manages the connection to the EMFStore. It will initiate, reinitiate and terminate the connection as needed.

Author:

mkoegel, wesendon

Field Summary

static String	INCOMPATIBLE_VERSION Connection related failure message.
static String	LOGIN_FIRST Connection related failure message.
static String	LOGIN_REFUSED Connection related failure message.
static String	REMOTE Connection related failure message.
static String	UNSUPPORTED_ENCODING Connection related failure message.

Fields inherited from interface org.eclipse.emf.emfstore.internal.server.EMFStore

CHANGEPACKAGE_URI, PROJECT_URI

Method Summary

String	getVersion(ServerInfo serverInfo) Returns the version of the EMFStore server.
boolean	isLoggedIn(SessionId id) Checks whether session id is logged in.
AuthenticationInformation	logIn(String username, String password, ServerInfo severInfo, ClientVersionInfo clientVersionInfo) Log into the server given by server info.
void	logout(SessionId sessionId) Deletes a session on the server.

Methods inherited from interface org.eclipse.emf.emfstore.internal.server.EMFStore

addTag, createEmptyProject, createProject, createVersion, deleteProject, downloadFileChunk, exportProjectHistoryFromServer, getBranches, getChanges, getEMFProperties, getHistoryInfo, getProject, getProjectList, getVersion, importProjectHistoryToServer, registerEPackage, removeTag, resolveUser, resolveVersionSpec, setEMFProperties, transmitProperty, uploadFileChunk

Field Detail

REMOTE

static final String REMOTE

Connection related failure message.

LOGIN_FIRST

static final String LOGIN_FIRST

Connection related failure message.

UNSUPPORTED_ENCODING

static final String UNSUPPORTED_ENCODING

Connection related failure message.

LOGIN_REFUSED

static final String LOGIN_REFUSED

Connection related failure message.

INCOMPATIBLE_VERSION

static final String INCOMPATIBLE_VERSION

Connection related failure message.

Method Detail

logIn

AuthenticationInformation logIn(String username,
                                String password,
                                ServerInfo severInfo,
                                ClientVersionInfo clientVersionInfo)
                                throws ESException

Log into the server given by server info. The connection manager will also remember the serverInfo associated with the session id.

Parameters:

username - the user name

password - the password

severInfo - the server info for the server to log into

clientVersionInfo - the client's version

Returns:

AuthenticationInformation that can be used for later authentication

Throws:

ESException - in case of failure

logout

void logout(SessionId sessionId)
            throws ESException

Deletes a session on the server.

Parameters:

sessionId - id to be deleted.

Throws:

ESException - in case of failure on server

isLoggedIn

boolean isLoggedIn(SessionId id)

Checks whether session id is logged in.

Parameters:

id - session id

Returns:

true, if logged in

getVersion

String getVersion(ServerInfo serverInfo)
                  throws ESException

Returns the version of the EMFStore server.

Parameters:

serverInfo - the EMFStore server whose version should be retrieved

Returns:

the version of the EMFStore server

Throws:

ESException - in case of a failure