com.testarchitect

Class Repository

java.lang.Object

com.testarchitect.Repository

public abstract class Repository
extends Object

This class corresponds to a TestArchitect repository Object.

TestArchitect repository Object is the root object for TAUtilities session. From here you will either use 'getProject' (or 'getProjects') to access objects in the projects in the repository, or you can run SQL queries using 'executeSQLQuery'.

Data can only be retrieved after you have successfully connected to a repository using 'connect' method and have logged in using the 'login' method.

In case of an error in any of the TAUtilities functions, use the static 'getLastErrorMessage' method of the Repository class to retrieve the last error message.

Constructor Summary

Constructors

Constructor and Description
Repository()

Method Summary

Modifier and Type	Method and Description
abstract boolean	connect(String ip, int port, String repository) Connects to a repository on a specified repository server.
abstract boolean	disconnect() Disconnects from the repository.
abstract QueryResult	executeSQLQuery(String sql) Executes a SQL command.
static int	exportRepository(String rsHost, int rsPort, String repositoryName, String destination, boolean overwrite) Export a repository to a file.
abstract Entity	getEntityById(String id)
static Repository	getInstance() Returns a repository instance.
static String	getLastErrorMessage() Returns the most recent error message.
abstract Project	getProject(String name) Returns a specific project with a given name.
abstract Collection	getProjects() Returns all projects residing under a repository.
static int	importRepository(String rsHost, int rsPort, String repositoryName, String filePath, boolean overwrite) Import a repository from a file.
abstract boolean	login(String userName, String password) Log on to the repository.
abstract void	logout() Logs out of the repository.

Methods inherited from class java.lang.Object

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

Constructor Detail

Repository

public Repository()

Method Detail

connect

public abstract boolean connect(String ip,
                                int port,
                                String repository)

Connects to a repository on a specified repository server.

Parameters:

ip - - the hostname or IP address of the repository server where the repository resides.
If the ip argument is empty ,"localhost" is used as the default.

port - - the port number of the repository server. If this argument is set to 0, the default port number 53400 is used.

repository - - the name of the repository on the repository server.

Returns:

true if the connection is successful, false otherwise (call getLastErrorMessage for the error message).

disconnect

public abstract boolean disconnect()

Disconnects from the repository.

Returns:

true if the disconnection is successful; otherwise false (call getLastErrorMessage for the error message).

login

public abstract boolean login(String userName,
                              String password)

Log on to the repository.

Parameters:

userName - the username to log on.

password - - the password to log on.

Returns:

true if the logon is successful; otherwise false (call getLastErrorMessage for the error message).

logout

public abstract void logout()

Logs out of the repository.

getProjects

public abstract Collection getProjects()

Returns all projects residing under a repository.

Returns:

A collection of projects under the repository.

getProject

public abstract Project getProject(String name)

Returns a specific project with a given name.

Parameters:

name - the name of the desired project.

Returns:

A string value of the desired project.

executeSQLQuery

public abstract QueryResult executeSQLQuery(String sql)

Executes a SQL command.

Parameters:

sql - a SQL query.

Returns:

QueryResult object if the SQL query is executed successfully; otherwise returns null.

getLastErrorMessage

public static String getLastErrorMessage()

Returns the most recent error message.

Returns:

A string value with the latest error message.

getEntityById

public abstract Entity getEntityById(String id)

importRepository

public static int importRepository(String rsHost,
                                   int rsPort,
                                   String repositoryName,
                                   String filePath,
                                   boolean overwrite)

Import a repository from a file.

Parameters:

rsHost - IP Address or computer name of repository server. Default value: "localhost".

rsPort - Port used for target repository server. Default value: 53404

repositoryName - Repository name to be assigned to the imported repository. Default value: The source repository's name.

filePath - Path to .dat file to be imported

overwrite - true: Replace the existing repository, if any, without error message

Returns:

1: import completed successfully / Any other value: import failed.

exportRepository

public static int exportRepository(String rsHost,
                                   int rsPort,
                                   String repositoryName,
                                   String destination,
                                   boolean overwrite)

Export a repository to a file.

Parameters:

rsHost - IP address or computer name of repository server. Default value: "localhost".

rsPort - Port used for target repository server. Default value: 53404

repositoryName - Name to be assigned to the exported repository. Default value: source repository name.

destination - file path (absolute ) of the exported file.

overwrite - true: Replace the existing destination file, if any, without error message

Returns:

1: import completed successfully / Any other value: export failed.

getInstance

public static Repository getInstance()

Returns a repository instance.

Returns:

A repository instance.