Package de.mid.innovator.srv.excellence

Class ExcellenceModel

java.lang.Object

de.mid.innovator.srv.Model

de.mid.innovator.srv.excellence.ExcellenceModel

All Implemented Interfaces:

SrvContext

public class ExcellenceModel
extends Model

Method Summary

Modifier and Type	Method	Description
static Model	create(RepositoryServer rep, String name, K_ADMODEL modelType, ADModel mdlId)	Create a handle to an existing Innovator model specified by repository, model name and model.
void	delete(String pwd)	Deletes a model from a repository server.
ADModel	getADModel()	The instance of ADModel is fetched from the server.
List<String>	getUserRoleList(InoUser inoUser)	Fetch the possible roles
List<InoUser>	getUsers()	Gets the list of available users from model.
boolean	isUseRecentChangeset()	Is in the current model the use of the most recent changeset activated? If true, all modifications are done within the most recent changeset.
void	loginModelAdmin()	Login as model administrator for SSO
void	loginModelAdmin(String aUserName, String pwd)	Login as model administrator with name and password.
void	loginModelGuest(String pwd)	Login as model guest with password.
void	loginSuperUser(Boolean login, String pwd)	Switch superuser mode for login.
void	loginUser(String aUserName, String aCleartextPassword, String role)	Login as normal user with name and password.
void	logout()	Logout any user from the model.
void	setUseRecentChangeset(boolean useRecentChangeset)	Set the use of the most recent changeset.
boolean	tryReLogin(K_LOGINKIND loginKind, String loginName)	Checks if the given user has a login with the same display.
boolean	tryReLogin(String aUserName)	Checks if the given user has a login with the same display.
boolean	userHasAdminPrivileges()	Check for repository administrator role.

Methods inherited from class de.mid.innovator.srv.Model

asExcellenceModel, beginCommandSequence, endCommandSequence, equals, getCommandSequenceId, getCommandSequenceName, getLogin, getModelName, getModelType, getRepositoryServer, getSrvConnection, getVersionName, hasLogin, isAdminLoginAllowed, isApiAdminLoginAllowed, isGuestLoginAllowed, isLoginAllowed, isNormalLoginAllowed, isVersion

Methods inherited from class java.lang.Object

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

Method Details

loginUser

public void loginUser(String aUserName,
 String aCleartextPassword,
 String role)
               throws InoNetException,
SrvErrorException

Login as normal user with name and password. If name is omitted (equal to "" or is null), the system user is used by calling SystemUtils.getSystemUser();

Specified by:

loginUser in class Model

Parameters:

aUserName - the user name or null. If no name is given, the system user name is used.

aCleartextPassword - a clear text password for this user or null.

role - the user's role or null. If no role is given, the role of the user's last successful login is used.

Throws:

InoNetException

SrvErrorException

tryReLogin

public boolean tryReLogin(String aUserName)
                   throws InoNetException,
SrvErrorException

Checks if the given user has a login with the same display. If so, the login can be reused. In this case, the model stores the existing login and the ADModel instance and changes its state to "logged-in".

Specified by:

tryReLogin in class Model

Parameters:

aUserName - the user name to search for.

Returns:

true if a re-login was performed, otherwise false (a login must then be carried out).

Throws:

InoNetException

SrvErrorException

tryReLogin

public boolean tryReLogin(K_LOGINKIND loginKind,
 String loginName)
                   throws InoNetException,
SrvErrorException

Checks if the given user has a login with the same display. If so, the login can be reused. In this case, the model stores the existing login and the ADModel instance and changes its state to "logged-in".

Specified by:

tryReLogin in class Model

Parameters:

loginKind - the kind of login.

loginName - the user name to search for.

Returns:

true if a re-login was performed, otherwise false (a login must then be carried out).

Throws:

InoNetException

SrvErrorException

userHasAdminPrivileges

public boolean userHasAdminPrivileges()
                               throws InoNetException,
SrvErrorException

Check for repository administrator role.

Returns:

true for non-SSO or if user has model admin privileges.

Throws:

InoNetException

SrvErrorException

loginModelAdmin

public void loginModelAdmin(String aUserName,
 String pwd)
                     throws InoNetException,
SrvErrorException

Login as model administrator with name and password. If name is omitted (equal to "" or is null), the system user is used by calling SystemUtils.getSystemUser();

Specified by:

loginModelAdmin in class Model

Parameters:

aUserName - a user name as string or null

pwd - the administrator's password

Throws:

InoNetException

SrvErrorException

loginModelAdmin

public void loginModelAdmin()
                     throws InoNetException,
SrvErrorException

Login as model administrator for SSO

Specified by:

loginModelAdmin in class Model

Throws:

InoNetException

SrvErrorException

loginSuperUser

public void loginSuperUser(Boolean login,
 String pwd)
                    throws InoNetException,
SrvErrorException

Switch superuser mode for login.

Specified by:

loginSuperUser in class Model

Parameters:

login - flag for log-in/out

pwd - the administrator's password

Throws:

InoNetException

SrvErrorException

loginModelGuest

public void loginModelGuest(String pwd)
                     throws InoNetException,
SrvErrorException

Login as model guest with password.

Specified by:

loginModelGuest in class Model

Parameters:

pwd - the administrator's password

Throws:

InoNetException

SrvErrorException

logout

public void logout()
            throws InoNetException,
SrvErrorException

Logout any user from the model. This however means that the ADModel instance cannot be used in further calls. Only logout if there is no other application of the user on this machine is connected with the same model.

Specified by:

logout in class Model

Throws:

InoNetException

SrvErrorException

getADModel

public ADModel getADModel()

The instance of ADModel is fetched from the server. It can be used as an entry point for further model requests.

Returns:

the model's ADModel instance.

create

public static Model create(RepositoryServer rep,
 String name,
 K_ADMODEL modelType,
 ADModel mdlId)

Create a handle to an existing Innovator model specified by repository, model name and model.

Parameters:

rep -

name -

modelType -

mdlId -

Returns:

delete

public void delete(String pwd)
            throws InoNetException,
SrvErrorException

Description copied from class: Model

Deletes a model from a repository server. The corresponding server must be prepared for administration with RepositoryServer.repositoryAdminLogin(String)

Specified by:

delete in class Model

Parameters:

pwd - the model's administrator password

Throws:

InoNetException

SrvErrorException

getUsers

public List<InoUser> getUsers()
                       throws InoNetException,
SrvErrorException

Description copied from class: Model

Gets the list of available users from model.

Specified by:

getUsers in class Model

Returns:

list of users

Throws:

InoNetException

SrvErrorException

getUserRoleList

public List<String> getUserRoleList(InoUser inoUser)
                             throws InoNetException,
SrvErrorException

Description copied from class: Model

Fetch the possible roles

Specified by:

getUserRoleList in class Model

Parameters:

inoUser - the Innovator user

Throws:

InoNetException

SrvErrorException

isUseRecentChangeset

public boolean isUseRecentChangeset()

Is in the current model the use of the most recent changeset activated? If true, all modifications are done within the most recent changeset. If false, a new changeset is created each time, a new login is done. A relogin or reusing the login of the Innovator model editor does not create a new login. If the changeset is empty, it will be deleted at logout. Default is false.

Returns:

setUseRecentChangeset

public void setUseRecentChangeset(boolean useRecentChangeset)

Set the use of the most recent changeset.

Parameters:

useRecentChangeset - true or false.