com.rational.test.ft.services
Class TestManager

java.lang.Object
  com.rational.test.ft.services.TestManager

public class TestManager
extends java.lang.Object

Handles TestManager services such as registering and unregistering our datastores as TestManager script sources

Nested Class Summary

class

TestManager.LogInfoSpecifier

Field Summary

static int	TM_NOTREGISTERED return codes used by getDatastoreRegisterationStatus
static int	TM_REGISTERED
static int	TM_REGISTERED_OTHERPROJECT
static int	TM_REGISTERED_SSDELTDFROMTM
static int	TM_REGISTERED_WRONGDATAPATH

Method Summary

boolean	canRegisterDatastore() Check if a datastore can be registered or unregistered with current Rational project.
void	ensureRepoServer() Called before doing any TestManager services.
void	fixRegistration(java.lang.String path, java.lang.String logicalName, boolean bRestore) Fix datastore registration.
int	getDatastoreRegisterationStatus(java.lang.String path)
int	getDatastoreRegisterationStatus(java.lang.String path, boolean dotss) Get datastore registration status.
static TestManager	getInstance()
static TestManager.LogInfoSpecifier	getLogInfoSpecifier()
java.lang.String	getProjectDatapoolPath() Call this method to get its datapool path.
java.lang.String	getProjectDatastorePath() Call this method to get datastore path
java.lang.String	getProjectDatastorePathEx() It should only be called from other processes, for example, script playback process.
java.lang.Object	getScriptSource(java.lang.String sourceUID)
java.lang.String	getScriptSourceName(java.lang.Object scriptSource)
java.lang.String	GetScriptSourceNameByUID(java.lang.String uid)
java.lang.String	getScriptSourcePath(java.lang.Object scriptSource)
java.lang.String	GetScriptSourcePathByUID(java.lang.String uid)
java.lang.String	getTmProjectName() Returns current Rational Project Name
java.lang.String	getTmProjectPath()
boolean	isAssociatedWithOtherProject(java.lang.String path) Check if a dadastore is registered with current Rational project
boolean	isLoggedIn() Returns true if this instance of the IDE is logged into TestManager.
boolean	isLoggedInEx() To find out if we logged into a Rational project.
static boolean	isTestManagerInstalled() Check if TestManager is installed.
void	logout()
void	registerDatastore(java.lang.String path, java.lang.String logicalName) Registers a datastore with TestManager.
void	resetScriptSourceDatapath(java.lang.String path) Reset script source datapath.
void	setTSSDatapoolDirContext() To support datapool.
void	unregisterDatastore(java.lang.String path, boolean fDelete) Unregister this datastore as a TM script source.

Methods inherited from class java.lang.Object

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

Field Detail

TM_NOTREGISTERED

public static final int TM_NOTREGISTERED

return codes used by getDatastoreRegisterationStatus

See Also:

Constant Field Values

TM_REGISTERED_OTHERPROJECT

public static final int TM_REGISTERED_OTHERPROJECT

See Also:

Constant Field Values

TM_REGISTERED

public static final int TM_REGISTERED

See Also:

Constant Field Values

TM_REGISTERED_WRONGDATAPATH

public static final int TM_REGISTERED_WRONGDATAPATH

See Also:

Constant Field Values

TM_REGISTERED_SSDELTDFROMTM

public static final int TM_REGISTERED_SSDELTDFROMTM

See Also:

Constant Field Values

Method Detail

getInstance

public static TestManager getInstance()

getLogInfoSpecifier

public static TestManager.LogInfoSpecifier getLogInfoSpecifier()

getTmProjectPath

public java.lang.String getTmProjectPath()

getTmProjectName

public java.lang.String getTmProjectName()

Returns current Rational Project Name

isLoggedIn

public boolean isLoggedIn()

Returns true if this instance of the IDE is logged into TestManager. Should only be false if the user cancelled out of the login dialog.

isLoggedInEx

public boolean isLoggedInEx()

To find out if we logged into a Rational project. It should only be called from other processes, for example, script playback process. In process call should be isLoggedIn

getProjectDatastorePath

public java.lang.String getProjectDatastorePath()

Call this method to get datastore path

getProjectDatastorePathEx

public java.lang.String getProjectDatastorePathEx()

It should only be called from other processes, for example, script playback process. In process call should be GetProjectDatastorePath

getProjectDatapoolPath

public java.lang.String getProjectDatapoolPath()

Call this method to get its datapool path. Notice that if need to get the datapool path remotely, call getProjectDatastorePath and construct the datapool path based on its return value

getDatastoreRegisterationStatus

public int getDatastoreRegisterationStatus(java.lang.String path,
                                           boolean dotss)

Get datastore registration status.

Parameters:

path - datstore path

bTSS - if true, uid is checked against the Rational project through TSS

Returns:

one of the following:

• TM_NOTREGISTERED -- not registered
• TM_REGISTERED_SSDELTDFROMTM -- registered but its script source has beenn deleted from TM
• TM_REGISTERED_OTHERPROJECT -- registered with a different Rational project
• TM_REGISTERED_WRONGDATAPATH -- registered but script source datapath doesn't match
• TM_REGISTERED -- registered

if status is TM_REGISTERED, datastore definition might need to be updated if the Rational project name or path is changed

getDatastoreRegisterationStatus

public int getDatastoreRegisterationStatus(java.lang.String path)

fixRegistration

public void fixRegistration(java.lang.String path,
                            java.lang.String logicalName,
                            boolean bRestore)

Fix datastore registration. The action is either to restore registration or leave it unregistered. This rotine is called when datastore registration status is TM_REGISTERED_SSDELTDFROMTM

Throws:

TestManagerException

Parameters:

path - datastore path

logicalName - datastore logical name

bRestore -

resetScriptSourceDatapath

public void resetScriptSourceDatapath(java.lang.String path)

Reset script source datapath. It is called when datastore registration status is TM_REGISTERED_WRONGDATAPATH

Throws:

TestManagerException

Parameters:

path - datastore path

isAssociatedWithOtherProject

public boolean isAssociatedWithOtherProject(java.lang.String path)

Check if a dadastore is registered with current Rational project

Parameters:

path - datastore path

Returns:

true is datastore registration status is TM_REGISTERED_OTHERPROJECT. Otherwise false

canRegisterDatastore

public boolean canRegisterDatastore()

Check if a datastore can be registered or unregistered with current Rational project. If not logged in a project, can't do it; If user doesn't have the right privilege, can't do it; The result is cached per TM instance. So if current user TM privilege has been changed, user needs to restart to have updated privilege reflected

registerDatastore

public void registerDatastore(java.lang.String path,
                              java.lang.String logicalName)

Registers a datastore with TestManager. It is only called if datastore currently is not registered

Parameters:

path - the path to the root of the datastore.

logicalName - the name of the datastore in the IDE. We will give the TestManager script-source the same name if possible.

fUpdateDatastoreDef - if true, update datastore definition file

unregisterDatastore

public void unregisterDatastore(java.lang.String path,
                                boolean fDelete)

Unregister this datastore as a TM script source. 'path' is the path to the root of the datastore. 'dd' is the DatastoreDefinition, persisted into memory (note by the time we are called the underlying datastore definition file might have been deleted). 'fDelete' is true if deleting the datastore, false if just unregistering it.

getScriptSource

public java.lang.Object getScriptSource(java.lang.String sourceUID)

getScriptSourceName

public java.lang.String getScriptSourceName(java.lang.Object scriptSource)

GetScriptSourceNameByUID

public java.lang.String GetScriptSourceNameByUID(java.lang.String uid)

getScriptSourcePath

public java.lang.String getScriptSourcePath(java.lang.Object scriptSource)

GetScriptSourcePathByUID

public java.lang.String GetScriptSourcePathByUID(java.lang.String uid)

setTSSDatapoolDirContext

public void setTSSDatapoolDirContext()

To support datapool. Set tss datapool dir context. This method is only called when playback is not under TestManager, not using TestManager logging format and user has logged into a Rational project.

ensureRepoServer

public void ensureRepoServer()

Called before doing any TestManager services. Loads the library rtJavaTestServer.jar through which we will perform operations on the TestManager repository. Then invokes the login dialog to log into TestManager.

isTestManagerInstalled

public static boolean isTestManagerInstalled()

Check if TestManager is installed. Result is cached so that checking is done only once

logout

public void logout()