com.whitestein.lsps.test

Class LspsRemote

java.lang.Object

com.whitestein.lsps.test.LspsRemote

public class LspsRemote
extends Object

Remotely controls LSPS - allows for model uploading and model instance starting. Just use static methods to obtain Module, then use Module's methods to control the module.

Expects that there is an administrator user created in the LSPS server, with username/password admin/admin. All static methods return services authenticated as admin/admin; you can call create(String, String) to obtain instance which authenticates as another user.

Author:

mvy

Field Summary

Fields

Modifier and Type	Field and Description
static LspsRemote	ADMIN The admin/admin connection.
static String	baseUrl
static String	url
static String	urlHuman

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LspsRemote(String username, String password)

Method Summary

Modifier and Type	Method and Description
static LspsRemote	create(String username, String password)
static LspsRemote	create(TestPerson person, String password)
GenericDocumentService	getDocumentService() Returns the document service for this user which retrieves documents available to this user.
List<String>	getDocumentTitles() Calls GenericDocumentService.getAllDocuments() and retrieves document names.
static PersonManagementService	getPersonManagementService() Provides methods for person management (creating, updating, removing persons), person-role mapping and querying, and role querying.
static TestSupportService	getTestSupportService() Returns TestSupportService.
List<Todo>	getTodoList() Returns the current user to-do list.
static List<Todo>	getTodoList(TestPerson person) Returns the current to-do list of given person.
static TodoService	getTodoService() Deprecated. call ADMIN's getTodoServiceUser()
TodoService	getTodoServiceUser() Service for accessing the functionality related to to-dos.
static boolean	isRunningOn(JEEServer server)
boolean	isRunningOnServer(JEEServer server)
static void	unloadAllModules() Unloads all modules from the server.
static Module	uploadModule(String name, String version, File pathToProject) Uploads a model to the server.
static Module	uploadModule(String name, String version, File pathToProject, SchemaUpdateStrategy strategy) Uploads a model to the server.
static Module	uploadModuleFromRepository(String name, String version) Uploads a model to the server.
static Module	uploadModuleFromRepository(String name, String version, SchemaUpdateStrategy strategy) Uploads a model to the server.

Methods inherited from class java.lang.Object

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

Field Detail

baseUrl

public static final String baseUrl

url

public static final String url

urlHuman

public static final String urlHuman

ADMIN

public static final LspsRemote ADMIN

The admin/admin connection.

Constructor Detail

LspsRemote

protected LspsRemote(String username,
                     String password)

Method Detail

create

public static LspsRemote create(TestPerson person,
                                String password)

create

public static LspsRemote create(String username,
                                String password)

uploadModuleFromRepository

public static Module uploadModuleFromRepository(String name,
                                                String version)

Uploads a model to the server. Looks up a directory named 'model' with the unpacked PDS project from a repository, zips it and sends it to the server. Uses the DROP-CREATE database update strategy.

Parameters:

name - the module name, not null.

version - the version, not null. Just type "1.0" here.

Returns:

id of uploaded model.

uploadModuleFromRepository

public static Module uploadModuleFromRepository(String name,
                                                String version,
                                                SchemaUpdateStrategy strategy)

Uploads a model to the server. Looks up a directory named 'model' with the unpacked PDS project from a repository, zips it and sends it to the server.

Parameters:

name - the module name, not null.

version - the version, not null. Just type "1.0" here.

strategy - the database update strategy to use, not null.

Returns:

id of uploaded model.

uploadModule

public static Module uploadModule(String name,
                                  String version,
                                  File pathToProject)

Uploads a model to the server. Looks up a directory named 'model' with the unpacked PDS project located in pathToProject, zips it and sends it to the server.

Uses the DROP-CREATE database update strategy.

Parameters:

name - the module name, not null. The module must be present in the project denoted by pathToProject.

version - the version, not null. Just type "1.0" here.

pathToProject - the path to the folder containing the .project file and modules.

Returns:

uploaded module

uploadModule

public static Module uploadModule(String name,
                                  String version,
                                  File pathToProject,
                                  SchemaUpdateStrategy strategy)

Uploads a model to the server. Looks up a directory named 'model' with the unpacked PDS project located in pathToProject, zips it and sends it to the server.

Parameters:

name - the module name, not null. The module must be present in the project denoted by pathToProject.

version - the version, not null. Just type "1.0" here.

pathToProject - the path to the folder containing the .project file and modules.

strategy - the database update strategy to use, not null.

Returns:

uploaded module

unloadAllModules

public static void unloadAllModules()

Unloads all modules from the server. Call this before each test, to make sure the server is in a known state.

getTestSupportService

public static TestSupportService getTestSupportService()

Returns TestSupportService.

Returns:

service

getPersonManagementService

public static PersonManagementService getPersonManagementService()

Provides methods for person management (creating, updating, removing persons), person-role mapping and querying, and role querying. Full role management (creating, updating, removing roles) is not supported as this is managed (almost) entirely by process models.

Returns:

service

getTodoService

@Deprecated
public static TodoService getTodoService()

Deprecated. call ADMIN's getTodoServiceUser()

Service for accessing the functionality related to to-dos. The application should use this service to get to-dos for a user and to submit, save and cancel to-dos.

WARNING: this TODO service returns TODOs for Admin, which is probably not intended. To obtain TODOs for particular user, use either getTodoList(TestPerson) or UITester.getTodoList(). As this method may be easily misused, it is marked deprecated; please call getTodoServiceUser() on an explicit instance of LspsRemote.

Returns:

the TODO service, not null.

getTodoServiceUser

public TodoService getTodoServiceUser()

Service for accessing the functionality related to to-dos. The application should use this service to get to-dos for a user and to submit, save and cancel to-dos.

Returns:

the TODO service, not null.

getTodoList

public static List<Todo> getTodoList(TestPerson person)
                              throws PersonNotFoundException

Returns the current to-do list of given person.

Parameters:

person - the person for which to retrieve

Returns:

the todo list, not null, may be empty.

Throws:

PersonNotFoundException - if no person with the given personId exists

getTodoList

public List<Todo> getTodoList()
                       throws PersonNotFoundException

Returns the current user to-do list.

Returns:

the todo list, not null, may be empty.

Throws:

PersonNotFoundException - if no person with the given personId exists

getDocumentService

public GenericDocumentService getDocumentService()

Returns the document service for this user which retrieves documents available to this user.

Returns:

this user's document service, not null.

getDocumentTitles

public List<String> getDocumentTitles()
                               throws ErrorException

Calls GenericDocumentService.getAllDocuments() and retrieves document names.

Returns:

the titles of available documents, not null, may be empty.

Throws:

ErrorException

isRunningOnServer

public boolean isRunningOnServer(JEEServer server)

Parameters:

server -

Returns:

true if test support service is running on server

isRunningOn

public static boolean isRunningOn(JEEServer server)