LspsRemote (LSPS 3.3 SDK)

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 methods to obtain Module, then use Module's methods to control the module.

Field Summary

Fields
Modifier and Type Field and Description

static LspsRemote ADMIN
The admin/admin connection.

static String serverUrl

static String urlWs

static String urlWsHuman

Fields
Modifier and Type	Field and Description
`static LspsRemote`	`ADMIN` The admin/admin connection.
`static String`	`serverUrl`
`static String`	`urlWs`
`static String`	`urlWsHuman`

Constructor Summary

Constructors
Modifier Constructor and Description

protected LspsRemote(String login, String password)

Constructors
Modifier	Constructor and Description
`protected`	`LspsRemote(String login, String password)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static LspsRemote`	`create(Person person, String password)` Creates remote lsps controller for person and password.
`static LspsRemote`	`create(String username, String password)` Creates LSPS remote with a given username, password.
`boolean`	`equals(Object obj)`
`List<ModelInstance>`	`findModelInstances(ModelInstanceCriteria criteria)` Finds model instances by given criteria.
`List<Module>`	`findModules(ModuleCriteria criteria)` Finds modules by given criteria.
`Person`	`findOrCreatePerson(String login)` Finds a person with a given login, if not found, it creates one.
`Person`	`findPersonByLogin(String login)` Finds a person with a given login.
`Person`	`getAdminPerson()` Returns the predefined person 'admin'.
`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.
`ErrorHandlingService`	`getErrorHandlingService()`
`Person`	`getGuestPerson()` Returns the predefined person 'guest'.
`Module`	`getLatestModule(String name)` Returns the latest module with a given name or `null` if there is no module uploaded (unloaded modules are ignored).
`LogService`	`getLogService()`
`MigrationService`	`getMigrationService()`
`ModelInstance`	`getModelInstance(long id)` Returns the model instance with a given id.
`ModelManagementService`	`getModelManagementService()`
`Module`	`getModule(long moduleId)` Returns the module with a given id, if not found, an exception is thrown.
`Person`	`getPerson(String personId)` Finds a person with a given id.
`String`	`getPersonId()` Returns the person id of the connected user.
`PersonManagementService`	`getPersonManagementService()` Provides methods for person management (creating, updating, removing persons), person-role mapping and querying, and role querying.
`ProcessService`	`getProcessService()`
`<T> T`	`getService(Class<T> clazz)` Returns instance of service.
`TestSupportService`	`getTestSupportService()` Returns `TestSupportService`.
`Todo`	`getTodo(long todoId)` Returns the to-do with a given id, if not found, an exception is thrown.
`TodoService`	`getTodoService()` Service for accessing the functionality related to to-dos.
`int`	`hashCode()`
`boolean`	`isRunningOn(JEEServer server)`
`String`	`toString()`
`void`	`unloadAllModules()` Unloads all modules from the server.
`Module`	`uploadModule(String name, String version, File pathToProject)` Uploads a model to the server.
`Module`	`uploadModule(String name, String version, File pathToProject, SchemaUpdateStrategy strategy)` Uploads a model to the server.
`Module`	`uploadModuleFromRepository(String name, String version)` Uploads a model to the server.
`Module`	`uploadModuleFromRepository(String name, String version, SchemaUpdateStrategy strategy)` Uploads a model to the server.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - serverUrl
```
public static final String serverUrl
```
  - urlWs
```
public static final String urlWs
```
  - urlWsHuman
```
public static final String urlWsHuman
```
  - ADMIN
```
public static final LspsRemote ADMIN
```
    The admin/admin connection.
- Constructor Detail
  - LspsRemote
```
protected LspsRemote(String login,
                     String password)
```
- Method Detail
  - create
```
public static LspsRemote create(Person person,
                                String password)
```
    Creates remote lsps controller for person and password.
    
    Parameters:
    
    person -
    
    password -
    
    Returns:
    
    remote controller
  - create
```
public static LspsRemote create(String username,
                                String password)
```
    Creates LSPS remote with a given username, password.
    
    Parameters:
    
    username -
    
    password -
    
    Returns:
    
    the created remote
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getPersonId
```
public String getPersonId()
```
    Returns the person id of the connected user.
    
    Returns:
    
    the current person id
  - uploadModuleFromRepository
```
public 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 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:
    
    module
  - getLatestModule
```
public Module getLatestModule(String name)
```
    Returns the latest module with a given name or null if there is no module uploaded (unloaded modules are ignored).
    
    Parameters:
    
    name -
    
    Returns:
    
    the latest module with a given name or null
  - uploadModule
```
public 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 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 void unloadAllModules()
```
    Unloads all modules from the server. Call this before each test, to make sure the server is in a known state.
  - getService
```
public <T> T getService(Class<T> clazz)
```
    Returns instance of service.
    
    Type Parameters:
    
    T -
    
    Parameters:
    
    clazz -
    
    Returns:
    
    instance of service
  - getTestSupportService
```
public TestSupportService getTestSupportService()
```
    Returns TestSupportService.
    
    Returns:
    
    service
  - getProcessService
```
public ProcessService getProcessService()
```
    Returns:
    
    the process service
  - getModelManagementService
```
public ModelManagementService getModelManagementService()
```
    Returns:
    
    the model management service
  - getPersonManagementService
```
public 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
  - getErrorHandlingService
```
public ErrorHandlingService getErrorHandlingService()
```
    Returns:
    
    the error handling service
  - getTodoService
```
public TodoService getTodoService()
```
    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 To-Do service, not null.
  - getLogService
```
public LogService getLogService()
```
    Returns:
    
    the log service
  - getMigrationService
```
public MigrationService getMigrationService()
```
    Returns:
    
    the migration service
  - 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
  - isRunningOn
```
public boolean isRunningOn(JEEServer server)
```
    Parameters:
    
    server -
    
    Returns:
    
    true if test support service is running on server
  - getAdminPerson
```
public Person getAdminPerson()
```
    Returns the predefined person 'admin'.
    
    Returns:
    
    'admin' person
  - getGuestPerson
```
public Person getGuestPerson()
```
    Returns the predefined person 'guest'.
    
    Returns:
    
    'guest' person
  - findOrCreatePerson
```
public Person findOrCreatePerson(String login)
```
    Finds a person with a given login, if not found, it creates one. The reason is that currently LSPS API does not allow to create a person with a given id, only with a given login and id is generated (usually in form login + "0").
    
    Parameters:
    
    login -
    
    Returns:
    
    the found or created person
  - findPersonByLogin
```
public Person findPersonByLogin(String login)
```
    Finds a person with a given login. Returns null if there is no person with a given login.
    
    Parameters:
    
    login -
    
    Returns:
    
    the found person or null
  - getPerson
```
public Person getPerson(String personId)
```
    Finds a person with a given id. Returns null if there is no person with a given id.
    
    Parameters:
    
    personId -
    
    Returns:
    
    the found person or null
  - getModule
```
public Module getModule(long moduleId)
```
    Returns the module with a given id, if not found, an exception is thrown.
    
    Parameters:
    
    moduleId -
    
    Returns:
    
    the module with a given id
  - findModules
```
public List<Module> findModules(ModuleCriteria criteria)
```
    Finds modules by given criteria.
    
    Parameters:
    
    criteria -
    
    Returns:
    
    the list of modules
  - getModelInstance
```
public ModelInstance getModelInstance(long id)
```
    Returns the model instance with a given id.
    
    Parameters:
    
    id -
    
    Returns:
    
    the model instance with a given id
  - findModelInstances
```
public List<ModelInstance> findModelInstances(ModelInstanceCriteria criteria)
```
    Finds model instances by given criteria.
    
    Parameters:
    
    criteria -
    
    Returns:
    
    the list of model instances
  - getTodo
```
public Todo getTodo(long todoId)
```
    Returns the to-do with a given id, if not found, an exception is thrown.
    
    Parameters:
    
    todoId -
    
    Returns:
    
    the to-do

Class LspsRemote

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serverUrl

urlWs

urlWsHuman

ADMIN

Constructor Detail

LspsRemote

Method Detail

create

create

toString

hashCode

equals

getPersonId

uploadModuleFromRepository

uploadModuleFromRepository

getLatestModule

uploadModule

uploadModule

unloadAllModules

getService

getTestSupportService

getProcessService

getModelManagementService

getPersonManagementService

getErrorHandlingService

getTodoService

getLogService

getMigrationService

getDocumentService

getDocumentTitles

isRunningOn

getAdminPerson

getGuestPerson

findOrCreatePerson

findPersonByLogin

getPerson

getModule

findModules

getModelInstance

findModelInstances

getTodo