OptimalTrace
5.2

com.compuware.optimaltrace.tools.common.tpn.client
Class ProjectManagerFacade

java.lang.Object
  extended by com.compuware.optimaltrace.framework.business.AbstractPropertiesContainer
      extended by com.compuware.optimaltrace.tools.common.tpn.client.AbstractRMIClientFacade
          extended by com.compuware.optimaltrace.tools.common.tpn.client.ProjectManagerFacade
All Implemented Interfaces:
PropertiesContainerIfc, com.compuware.optimaltrace.tools.common.tpn.client.RMIClientFacadeIfc, com.compuware.optimaltrace.tools.common.tpn.client.SessionHolderIfc

public class ProjectManagerFacade
extends com.compuware.optimaltrace.tools.common.tpn.client.AbstractRMIClientFacade
implements com.compuware.optimaltrace.tools.common.tpn.client.RMIClientFacadeIfc

Class ProjectManagerFacade

Author:
Damian Beresford

Field Summary
protected  java.util.Map<java.lang.Object,java.lang.Object> _allProjectsSecurityMap
           
protected  boolean _fullyInitialised
           
protected  boolean _isRunningStandalone
           
protected  java.util.Map<java.lang.String,ProjectIfc> _loadedProjects
           
protected  java.util.Map<java.lang.String,java.util.Map<?,?>> _projectBaselines
           
protected  java.util.List<java.lang.String> _projectBaselinesOrderedByDateCreated
           
static ProjectIfc _projectBeingDisconnected
          disconnectProject Disconnects a project from the repository This simply consists of removing its project server from the project server list, and removing the project from the list of project callbacks.
protected  java.util.Map<java.lang.Object,java.lang.Object> _projectNameIdMap
          Map of project name/project id's that have been read from the database
protected  java.util.Map<java.lang.Object,java.lang.Object> _projectNameSecurityMap
           
protected  java.util.Map<ProjectIfc,com.compuware.optimaltrace.tools.common.tpn.ProjectServerIfc> _projectServers
          Map of projects to ProjectServerImpls..
static java.lang.String ADMIN_DISCONNECT
           
static java.lang.String PROJECT_ONLINE
           
static java.lang.String SERVERSTOP_DISCONNECT
           
 
Fields inherited from class com.compuware.optimaltrace.tools.common.tpn.client.AbstractRMIClientFacade
_databaseProduct, _eventLog, _eventProcessors, _pollInterval, _projectDaemon, _session, _sessionId
 
Fields inherited from class com.compuware.optimaltrace.framework.business.AbstractPropertiesContainer
_propertyChangeSupport
 
Constructor Summary
protected ProjectManagerFacade()
          Constructor ProjectManagerFacade
 
Method Summary
 void authenticateUser(java.lang.String userName, java.lang.String password)
          Authenticates the user.
 void checkProjectDaemon()
          Checks the project daemon.
 void closeProject(ProjectIfc project)
          Closes the project.
 void closeProject(java.lang.String projectId)
          Closes the project.
 void closeSelectedProject()
          Closes the selected project
 void deleteBaseline(ProjectIfc project, java.lang.String baseline)
          Deletes the Project baseline.
 void deleteDocGenAndChangeHistoryLogForProject(ProjectIfc project)
          Deletes the DocGen and change history log for project.
 void deleteProject(java.lang.String projectName)
          Deletes a Project.
 void deleteQADProjectInfo(ProjectIfc project)
           
 void deleteQADScriptInfo(ProjectIfc project, long scenarioOID)
           
 void disconnectProject(ProjectIfc project)
          Disconnects the project.
 void disconnectProject(ProjectIfc project, boolean isAdminDisconnect, boolean isServerStopDisconnect)
          Disconnects the project from this repository
 boolean enableNewProjectSecurity()
          Check if newly created project is security enabled.
 com.compuware.optimaltrace.tools.qad.QADProjectInfo findQADProjectInfo(ProjectIfc project)
          Finds the QADProjectInfo.
 com.compuware.optimaltrace.tools.qad.QADScriptInfo findQADScriptInfo(ProjectIfc project, long scenarioOID)
          Locates the QADScriptInfo for the given Scenario.
 java.util.Collection<com.compuware.optimaltrace.tools.qad.QADScriptInfo> findQADScriptInfo(ProjectIfc project, long[] scenarioOID)
          Locates the QADScriptInfos for the given Scenarios.
 java.util.Map getAllProjectsSecurityInfo()
          Gets all project security Info.
 int getClientCount(ProjectIfc project)
          Gets the client count.
 java.util.List getDocGenEventLog(ProjectIfc project)
          Deprecated. This method is only used by DocGenEventLog which is not used.
 com.compuware.optimaltrace.tools.common.tpn.EventProcessorIfc getEventProcessorForProject(ProjectIfc project)
          Gets the event processor for this project.
static ProjectManagerFacade getInstance()
          Gets the instance of this project manager facade.
 java.util.Map getLockedBizObjects(ProjectIfc project)
          Gets the locked biz objects.
 java.util.Map getProjectBaselines()
          Gets the project's baselines.
 java.lang.String getProjectId(java.lang.String projectName)
          Gets the project ID.
 com.compuware.optimaltrace.tools.common.tpn.ProjectPermissionsManagerClient getProjectPermissionsManagerClient(ProjectIfc project)
          Gets the project permission manager client.
 java.util.Map getProjectSecurityMap()
          Gets the project security map.
 java.util.List getRemoteDocGenEventLog(ProjectIfc project)
          Gets the remote DocGen event log.
 com.compuware.optimaltrace.tools.common.bizobjectslocal.ProjectChangeLogIfc getRemoteProjectHistory(ProjectIfc project, BizObjectIfc element)
          Gets the remote project history.
 java.lang.String getServerHostName()
          Gets the server host name.
 com.compuware.optimaltrace.tools.common.bizobjects.NotificationListIfc getUserNotifications()
          Gets the user notifications
 boolean isProject(java.lang.String name)
          Checks if it is a project.
 boolean isProjectBaselineSecure(ProjectIfc project, java.lang.String baseline)
          Checks if the project baseline is secure.
 boolean isProjectNew(ProjectIfc project)
          Checks if a Project is new.
 boolean isProjectOnline(ProjectIfc project)
          Checks if the project is online.
 boolean isProjectSaved(ProjectIfc project)
          Checks if a Project has been saved.
 boolean isProjectSecure(long projectId)
          Checks if a Project is Security Enabled or not
 boolean isProjectSecure(java.lang.String projectName)
          Checks if a Project is Security Enabled or not
 java.util.Map listProjectBaselines(long projectBOId)
          Lists the project baselines.
 java.util.List listProjectBaselinesOrderedByDateCreated(long projectBOId)
          Lists the project baselines ordered by created date.
 java.util.Map listProjects()
          Gets a List of Projects Currently this is not a supported call from the API
 java.util.Map[] listProjectsDetailWithSecurityInfo()
          List Project Details with their Security Info Element 0 is the map of name > project id's Element 1 is the map of name > isSecure
 com.compuware.optimaltrace.tools.common.bizobjects.PartialProjectIfc loadPartialProject(java.lang.String fileName)
          Loads the partial projects.
 ProjectIfc loadProject(long projectId)
          Loads the project.
 ProjectIfc loadProject(java.lang.String projectName)
          Loads the project.
 ProjectIfc loadProjectBaseline(long projectBOId, java.lang.String baseline)
          Loads the project's baseline.
 ProjectIfc loadProjectById(java.lang.String projectId)
          Loads the project by ID.
 ProjectIfc loadXMLProject(java.lang.String fileName)
          Loads the XML project.
 ProjectIfc loadXMLProject(java.lang.String fileName, boolean reload)
          Loads the XML project.
 void logoutUser()
          Logs out the currently logged in user.
 ProjectIfc newProject(java.lang.String projectName, boolean createInDatabase)
          Creates a New Local Project Currently this is not a supported call from the API
 ProjectIfc newRemoteProject(java.lang.String projectName)
          Creates a New Remote Project Currently this is not a supported call from the API
 void pingServer()
          Pings the server.
 void registerForNotification(BizObjectIfc bizObject, ProjectIfc project, boolean notifyChildren, java.util.List notifiableChildren)
          Registers the business object for notification.
 ProjectIfc reloadXMLProject(ProjectIfc project)
          Reloads the XML project.
 void removeAllNotificationsForUser(java.lang.String userId)
          Removes all notifications for user.
 void removeAllProjectNotifications(long projectId)
          Removes all project notifications.
 void reserveName(BizObjectIfc bizObject, java.lang.String name, BizObjectIfc parentBizObject, BizObjectIfc p)
          Reserves the Name.
 void reserveName(java.lang.String bizObjectName, java.lang.String bizObjectType, long parentId, BizObjectIfc p)
          Reserves the name.
 void reserveName(java.lang.String bizObjectName, java.lang.String bizObjectType, long parentId, java.lang.String constraint, BizObjectIfc project)
          Reserves the name
 void saveNotifications()
          Saves the notifications.
 void savePartialProjectXML(com.compuware.optimaltrace.tools.common.bizobjects.PartialProjectIfc project, java.lang.String fileName)
          Saves the partial project XML>
 void saveProject(ProjectIfc project)
          Saves the project.
 void saveProjectTemplate(ProjectIfc project, java.lang.String fileName)
          Saves the project template.
 void saveProjectXML(ProjectIfc project, java.lang.String fileName)
          Saves the project XML.
 void saveProjectXML(ProjectIfc project, java.lang.String fileName, boolean want26Format)
          Saves the project XML.
 void saveQADProjectInfo(ProjectIfc project, com.compuware.optimaltrace.tools.qad.QADProjectInfo qadProjectInfo)
          Saves the QADProjectInfo.
 void saveQADScriptInfo(ProjectIfc project, java.util.Collection<com.compuware.optimaltrace.tools.qad.QADScriptInfo> qadScriptInfoCol)
          Saves the QADScriptInfo collection.
 void saveQADScriptInfo(ProjectIfc project, com.compuware.optimaltrace.tools.qad.QADScriptInfo qadScriptInfo)
          Saves the QADScriptInfo.
 com.compuware.optimaltrace.tools.common.bizobjectslocal.RepositorySearchResultsIfc searchRepository(java.util.List projects, java.lang.String searchString, boolean matchCase, boolean matchWord)
          Searches the repository.
 void setIsUsedFromTogether(boolean isUsed)
          Sets a flag indicating the call is from "Together".
 void setStandAlone(boolean standAlone)
          Sets the stand alone.
 void setUserPassword(java.lang.String newPassword)
          Allows changing and setting the password of the currently authenticated user.
 void unregisterClient()
          Unregisters the client.
 void updateNotifications(com.compuware.optimaltrace.tools.common.bizobjects.NotificationListIfc updateNotifications, java.util.List removeBizObjectIds)
          Updates the notifications.
 java.util.List updateProjectState(ProjectIfc project)
          Updates the project state.
 ProjectIfc uploadProject(ProjectIfc project, com.compuware.optimaltrace.tools.common.bizobjectslocal.ProjectChangeLogIfc changeLog, java.util.List xmlDocGenEventLog)
          Uploads the project.
 ProjectIfc uploadProject(ProjectIfc project, com.compuware.optimaltrace.tools.common.bizobjectslocal.ProjectChangeLogIfc changeLog, java.util.List xmlDocGenEventLog, boolean isProjectBaseline)
          Uploads the project.
 boolean useWindowsIntegratedAuthentication()
          Verifies if Windows Integrated Authentication is to be used.
 void validateSelectedProject()
          Uses the validation support to validate the project that is currently selected in the pelican app.
 
Methods inherited from class com.compuware.optimaltrace.tools.common.tpn.client.AbstractRMIClientFacade
checkProjectDaemon, createDetailedNetworkException, getLoggedInUserName, getSession, invalidateEventProcessor, isOracleDatabase, isProjectDirty, registerEventProcessor, unregisterClient
 
Methods inherited from class com.compuware.optimaltrace.framework.business.AbstractPropertiesContainer
addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener, setTimeStampListenersEnabled
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_projectServers

protected java.util.Map<ProjectIfc,com.compuware.optimaltrace.tools.common.tpn.ProjectServerIfc> _projectServers
Map of projects to ProjectServerImpls..


_isRunningStandalone

protected boolean _isRunningStandalone

_projectNameIdMap

protected java.util.Map<java.lang.Object,java.lang.Object> _projectNameIdMap
Map of project name/project id's that have been read from the database


_fullyInitialised

protected boolean _fullyInitialised

PROJECT_ONLINE

public static java.lang.String PROJECT_ONLINE

ADMIN_DISCONNECT

public static java.lang.String ADMIN_DISCONNECT

SERVERSTOP_DISCONNECT

public static java.lang.String SERVERSTOP_DISCONNECT

_projectNameSecurityMap

protected java.util.Map<java.lang.Object,java.lang.Object> _projectNameSecurityMap

_allProjectsSecurityMap

protected java.util.Map<java.lang.Object,java.lang.Object> _allProjectsSecurityMap

_projectBaselines

protected java.util.Map<java.lang.String,java.util.Map<?,?>> _projectBaselines

_projectBaselinesOrderedByDateCreated

protected java.util.List<java.lang.String> _projectBaselinesOrderedByDateCreated

_loadedProjects

protected java.util.Map<java.lang.String,ProjectIfc> _loadedProjects

_projectBeingDisconnected

public static ProjectIfc _projectBeingDisconnected
disconnectProject Disconnects a project from the repository This simply consists of removing its project server from the project server list, and removing the project from the list of project callbacks. This can be used when we wish to silently take the project offline. The next time the project is saved the user will be asked to save it locally. This is useful if the client losses the connection with the server. added by Eoin Wren

Constructor Detail

ProjectManagerFacade

protected ProjectManagerFacade()
Constructor ProjectManagerFacade

Method Detail

getInstance

public static ProjectManagerFacade getInstance()
Gets the instance of this project manager facade.

Returns:
ProjectManagerFacade

setStandAlone

public void setStandAlone(boolean standAlone)
Sets the stand alone.

Parameters:
standAlone -

uploadProject

public ProjectIfc uploadProject(ProjectIfc project,
                                com.compuware.optimaltrace.tools.common.bizobjectslocal.ProjectChangeLogIfc changeLog,
                                java.util.List xmlDocGenEventLog)
                         throws NetworkException,
                                CorruptedProjectException,
                                ProjectNotUniqueException,
                                ProjectCannotBeLoadedException,
                                AuthenticationException,
                                PermissionException,
                                DisconnectEventPendingException
Uploads the project.

Parameters:
project -
changeLog -
xmlDocGenEventLog -
Returns:
ProjectIfc
Throws:
NetworkException
CorruptedProjectException
ProjectNotUniqueException
ProjectCannotBeLoadedException
AuthenticationException
PermissionException
DisconnectEventPendingException

uploadProject

public ProjectIfc uploadProject(ProjectIfc project,
                                com.compuware.optimaltrace.tools.common.bizobjectslocal.ProjectChangeLogIfc changeLog,
                                java.util.List xmlDocGenEventLog,
                                boolean isProjectBaseline)
                         throws NetworkException,
                                CorruptedProjectException,
                                ProjectNotUniqueException,
                                ProjectCannotBeLoadedException,
                                AuthenticationException,
                                PermissionException,
                                DisconnectEventPendingException
Uploads the project.

Parameters:
project -
changeLog -
xmlDocGenEventLog -
isProjectBaseline -
Returns:
ProjectIfc
Throws:
NetworkException
CorruptedProjectException
ProjectNotUniqueException
ProjectCannotBeLoadedException
AuthenticationException
PermissionException
DisconnectEventPendingException

saveProjectXML

public void saveProjectXML(ProjectIfc project,
                           java.lang.String fileName)
                    throws CorruptedProjectException,
                           ReadOnlyFileException
Saves the project XML.

Parameters:
project -
fileName -
Throws:
CorruptedProjectException
ReadOnlyFileException

deleteDocGenAndChangeHistoryLogForProject

public void deleteDocGenAndChangeHistoryLogForProject(ProjectIfc project)
Deletes the DocGen and change history log for project.

Parameters:
project -

saveProjectXML

public void saveProjectXML(ProjectIfc project,
                           java.lang.String fileName,
                           boolean want26Format)
                    throws CorruptedProjectException,
                           ReadOnlyFileException
Saves the project XML.

Parameters:
project -
fileName -
Throws:
CorruptedProjectException
ReadOnlyFileException

saveProjectTemplate

public void saveProjectTemplate(ProjectIfc project,
                                java.lang.String fileName)
                         throws CorruptedProjectException,
                                ReadOnlyFileException
Saves the project template.

Parameters:
project -
fileName -
Throws:
CorruptedProjectException
ReadOnlyFileException

saveProject

public void saveProject(ProjectIfc project)
                 throws NetworkException,
                        CorruptedProjectException,
                        ProjectNotUniqueException,
                        PermissionException,
                        DisconnectEventPendingException
Saves the project.

Parameters:
project -
Throws:
NetworkException
CorruptedProjectException
ProjectNotUniqueException
PermissionException
DisconnectEventPendingException

loadProject

public ProjectIfc loadProject(java.lang.String projectName)
                       throws NetworkException,
                              CorruptedProjectException,
                              ProjectCannotBeLoadedException,
                              AuthenticationException,
                              PermissionException
Loads the project.

Parameters:
projectName -
Returns:
ProjectIfc
Throws:
NetworkException
CorruptedProjectException
ProjectCannotBeLoadedException
AuthenticationException
PermissionException

loadProject

public ProjectIfc loadProject(long projectId)
                       throws NetworkException,
                              CorruptedProjectException,
                              ProjectCannotBeLoadedException,
                              AuthenticationException,
                              PermissionException
Loads the project.

Parameters:
projectId -
Returns:
ProjectIfc
Throws:
NetworkException
CorruptedProjectException
ProjectCannotBeLoadedException
AuthenticationException
PermissionException

closeProject

public void closeProject(java.lang.String projectId)
Closes the project.

Parameters:
projectId -

closeProject

public void closeProject(ProjectIfc project)
Closes the project.

Parameters:
project -

getProjectSecurityMap

public java.util.Map getProjectSecurityMap()
Gets the project security map.

Returns:
Map

loadProjectById

public ProjectIfc loadProjectById(java.lang.String projectId)
                           throws NetworkException,
                                  CorruptedProjectException,
                                  ProjectCannotBeLoadedException,
                                  AuthenticationException,
                                  PermissionException
Loads the project by ID. Only used by Catalyze clients, not ACL tool etc.

Parameters:
projectId -
Returns:
ProjectIfc
Throws:
NetworkException
CorruptedProjectException
ProjectCannotBeLoadedException
AuthenticationException
PermissionException

getRemoteProjectHistory

public com.compuware.optimaltrace.tools.common.bizobjectslocal.ProjectChangeLogIfc getRemoteProjectHistory(ProjectIfc project,
                                                                                                           BizObjectIfc element)
                                                                                                    throws java.rmi.RemoteException,
                                                                                                           com.compuware.optimaltrace.tools.common.tpn.client.xml.InvalidProjectChangeLogFileException,
                                                                                                           DisconnectEventPendingException
Gets the remote project history.

Parameters:
project -
element -
Returns:
ProjectChangeLogIfc
Throws:
java.rmi.RemoteException
com.compuware.optimaltrace.tools.common.tpn.client.xml.InvalidProjectChangeLogFileException
DisconnectEventPendingException

getRemoteDocGenEventLog

public java.util.List getRemoteDocGenEventLog(ProjectIfc project)
                                       throws java.rmi.RemoteException
Gets the remote DocGen event log.

Parameters:
project -
Returns:
List
Throws:
java.rmi.RemoteException

getDocGenEventLog

public java.util.List getDocGenEventLog(ProjectIfc project)
                                 throws NetworkException
Deprecated. This method is only used by DocGenEventLog which is not used.

Gets the DocGen event log.

Parameters:
project -
Returns:
List
Throws:
NetworkException

getAllProjectsSecurityInfo

public java.util.Map getAllProjectsSecurityInfo()
                                         throws NetworkException
Gets all project security Info.

Returns:
Map
Throws:
NetworkException

isProject

public boolean isProject(java.lang.String name)
                  throws NetworkException
Checks if it is a project.

Parameters:
name -
Returns:
boolean
Throws:
NetworkException

searchRepository

public com.compuware.optimaltrace.tools.common.bizobjectslocal.RepositorySearchResultsIfc searchRepository(java.util.List projects,
                                                                                                           java.lang.String searchString,
                                                                                                           boolean matchCase,
                                                                                                           boolean matchWord)
                                                                                                    throws NetworkException
Searches the repository.

Parameters:
projects -
searchString -
matchCase -
matchWord -
Returns:
RepositorySearchResultsIfc
Throws:
NetworkException

isProjectNew

public boolean isProjectNew(ProjectIfc project)
Checks if a Project is new. Used in the case where you might have created a new project, but have not changed it and you want to apply a label.

Parameters:
project - a ProjectIfc value
Returns:
boolean of value

isProjectSaved

public boolean isProjectSaved(ProjectIfc project)
Checks if a Project has been saved.

Parameters:
project - a ProjectIfc value
Returns:
boolean of value

loadXMLProject

public ProjectIfc loadXMLProject(java.lang.String fileName)
                          throws com.compuware.optimaltrace.tools.common.tpn.client.xml.InvalidProjectFileException,
                                 com.compuware.optimaltrace.tools.common.bizobjects.InvalidProjectException
Loads the XML project.

Parameters:
fileName -
Returns:
ProjectIfc
Throws:
com.compuware.optimaltrace.tools.common.tpn.client.xml.InvalidProjectFileException
com.compuware.optimaltrace.tools.common.bizobjects.InvalidProjectException

loadXMLProject

public ProjectIfc loadXMLProject(java.lang.String fileName,
                                 boolean reload)
                          throws com.compuware.optimaltrace.tools.common.tpn.client.xml.InvalidProjectFileException,
                                 com.compuware.optimaltrace.tools.common.bizobjects.InvalidProjectException
Loads the XML project.

Parameters:
fileName -
reload -
Returns:
ProjectIfc
Throws:
com.compuware.optimaltrace.tools.common.tpn.client.xml.InvalidProjectFileException
com.compuware.optimaltrace.tools.common.bizobjects.InvalidProjectException

reserveName

public void reserveName(BizObjectIfc bizObject,
                        java.lang.String name,
                        BizObjectIfc parentBizObject,
                        BizObjectIfc p)
                 throws com.compuware.optimaltrace.tools.common.tpn.client.NameAlreadyReservedException,
                        NetworkException
Reserves the Name.

Parameters:
bizObject -
name -
parentBizObject -
p -
Throws:
NameAlreadyReservedException
NetworkException

reserveName

public void reserveName(java.lang.String bizObjectName,
                        java.lang.String bizObjectType,
                        long parentId,
                        BizObjectIfc p)
                 throws com.compuware.optimaltrace.tools.common.tpn.client.NameAlreadyReservedException,
                        NetworkException
Reserves the name.

Specified by:
reserveName in interface com.compuware.optimaltrace.tools.common.tpn.client.RMIClientFacadeIfc
Parameters:
bizObjectName -
bizObjectType -
parentId -
p -
Throws:
NameAlreadyReservedException
NetworkException

reserveName

public void reserveName(java.lang.String bizObjectName,
                        java.lang.String bizObjectType,
                        long parentId,
                        java.lang.String constraint,
                        BizObjectIfc project)
                 throws com.compuware.optimaltrace.tools.common.tpn.client.NameAlreadyReservedException,
                        NetworkException
Reserves the name

Parameters:
bizObjectName -
bizObjectType -
parentId -
constraint -
project -
Throws:
NameAlreadyReservedException
NetworkException

getClientCount

public int getClientCount(ProjectIfc project)
                   throws java.rmi.RemoteException
Gets the client count.

Parameters:
project -
Throws:
java.rmi.RemoteException

validateSelectedProject

public void validateSelectedProject()
                             throws com.compuware.optimaltrace.tools.common.bizobjects.InvalidProjectException
Uses the validation support to validate the project that is currently selected in the pelican app.

Throws:
com.compuware.optimaltrace.tools.common.bizobjects.InvalidProjectException - if the project is not valid

closeSelectedProject

public void closeSelectedProject()
Closes the selected project


getLockedBizObjects

public java.util.Map getLockedBizObjects(ProjectIfc project)
                                  throws java.rmi.RemoteException
Gets the locked biz objects.

Parameters:
project -
Returns:
Map
Throws:
java.rmi.RemoteException

reloadXMLProject

public ProjectIfc reloadXMLProject(ProjectIfc project)
                            throws com.compuware.optimaltrace.tools.common.tpn.client.xml.InvalidProjectFileException,
                                   com.compuware.optimaltrace.tools.common.bizobjects.InvalidProjectException
Reloads the XML project.

Parameters:
project -
Returns:
ProjectIfc
Throws:
com.compuware.optimaltrace.tools.common.tpn.client.xml.InvalidProjectFileException
com.compuware.optimaltrace.tools.common.bizobjects.InvalidProjectException

disconnectProject

public void disconnectProject(ProjectIfc project)
Disconnects the project.

Parameters:
project -

disconnectProject

public void disconnectProject(ProjectIfc project,
                              boolean isAdminDisconnect,
                              boolean isServerStopDisconnect)
Disconnects the project from this repository

Parameters:
project -
isAdminDisconnect -
isServerStopDisconnect -

isProjectOnline

public boolean isProjectOnline(ProjectIfc project)
Checks if the project is online.

Parameters:
project -
Returns:
boolean

getProjectId

public java.lang.String getProjectId(java.lang.String projectName)
Gets the project ID.

Parameters:
projectName -
Returns:
String

getServerHostName

public java.lang.String getServerHostName()
Gets the server host name.

Returns:
String

savePartialProjectXML

public void savePartialProjectXML(com.compuware.optimaltrace.tools.common.bizobjects.PartialProjectIfc project,
                                  java.lang.String fileName)
                           throws ReadOnlyFileException
Saves the partial project XML>

Parameters:
project -
fileName -
Throws:
ReadOnlyFileException

loadPartialProject

public com.compuware.optimaltrace.tools.common.bizobjects.PartialProjectIfc loadPartialProject(java.lang.String fileName)
                                                                                        throws com.compuware.optimaltrace.tools.common.tpn.client.xml.InvalidProjectFileException,
                                                                                               com.compuware.optimaltrace.tools.common.bizobjects.InvalidProjectException
Loads the partial projects.

Parameters:
fileName -
Returns:
PartialProjectIfc
Throws:
com.compuware.optimaltrace.tools.common.tpn.client.xml.InvalidProjectFileException
com.compuware.optimaltrace.tools.common.bizobjects.InvalidProjectException

setIsUsedFromTogether

public void setIsUsedFromTogether(boolean isUsed)
Sets a flag indicating the call is from "Together".

Parameters:
isUsed -

authenticateUser

public void authenticateUser(java.lang.String userName,
                             java.lang.String password)
                      throws AuthenticationException,
                             NetworkException
Authenticates the user.

Parameters:
userName -
password -
Throws:
AuthenticationException
NetworkException

getProjectPermissionsManagerClient

public com.compuware.optimaltrace.tools.common.tpn.ProjectPermissionsManagerClient getProjectPermissionsManagerClient(ProjectIfc project)
Gets the project permission manager client.

Parameters:
project -
Returns:
ProjectPermissionsManagerClient

logoutUser

public void logoutUser()
                throws NetworkException
Logs out the currently logged in user.

Throws:
NetworkException

pingServer

public void pingServer()
                throws NetworkException
Pings the server.

Overrides:
pingServer in class com.compuware.optimaltrace.tools.common.tpn.client.AbstractRMIClientFacade
Throws:
NetworkException

setUserPassword

public void setUserPassword(java.lang.String newPassword)
                     throws NetworkException,
                            ObjectAlreadyLockedException,
                            PermissionException
Allows changing and setting the password of the currently authenticated user.

Parameters:
newPassword -
Throws:
NetworkException
ObjectAlreadyLockedException
PermissionException

listProjectBaselines

public java.util.Map listProjectBaselines(long projectBOId)
                                   throws NetworkException
Lists the project baselines.

Parameters:
projectBOId -
Returns:
Map
Throws:
NetworkException

listProjectBaselinesOrderedByDateCreated

public java.util.List listProjectBaselinesOrderedByDateCreated(long projectBOId)
                                                        throws NetworkException
Lists the project baselines ordered by created date.

Parameters:
projectBOId -
Returns:
List
Throws:
NetworkException

getProjectBaselines

public java.util.Map getProjectBaselines()
Gets the project's baselines. Ensure you call listProjectBaselines() or listProjectBaselinesOrderedByDateCreated() before calling this method

Returns:
Map

loadProjectBaseline

public ProjectIfc loadProjectBaseline(long projectBOId,
                                      java.lang.String baseline)
                               throws NetworkException,
                                      CorruptedProjectException,
                                      ProjectCannotBeLoadedException,
                                      AuthenticationException,
                                      PermissionException
Loads the project's baseline.

Parameters:
projectBOId -
baseline -
Returns:
ProjectIfc
Throws:
NetworkException
CorruptedProjectException
ProjectCannotBeLoadedException
AuthenticationException
PermissionException

deleteBaseline

public void deleteBaseline(ProjectIfc project,
                           java.lang.String baseline)
                    throws NetworkException,
                           ClientConnectedException,
                           AuthenticationException,
                           PermissionException
Deletes the Project baseline.

Parameters:
project -
baseline -
Throws:
NetworkException
ClientConnectedException
AuthenticationException
PermissionException

registerForNotification

public void registerForNotification(BizObjectIfc bizObject,
                                    ProjectIfc project,
                                    boolean notifyChildren,
                                    java.util.List notifiableChildren)
                             throws NetworkException,
                                    NotificationException
Registers the business object for notification.

Parameters:
bizObject -
project -
notifyChildren -
notifiableChildren -
Throws:
NetworkException
NotificationException

updateNotifications

public void updateNotifications(com.compuware.optimaltrace.tools.common.bizobjects.NotificationListIfc updateNotifications,
                                java.util.List removeBizObjectIds)
                         throws NetworkException,
                                NotificationException
Updates the notifications.

Parameters:
updateNotifications -
removeBizObjectIds -
Throws:
NetworkException
NotificationException

getUserNotifications

public com.compuware.optimaltrace.tools.common.bizobjects.NotificationListIfc getUserNotifications()
                                                                                            throws NetworkException,
                                                                                                   NotificationException
Gets the user notifications

Returns:
NotificationListIfc
Throws:
NetworkException
NotificationException

removeAllNotificationsForUser

public void removeAllNotificationsForUser(java.lang.String userId)
                                   throws java.rmi.RemoteException,
                                          NotificationException
Removes all notifications for user.

Parameters:
userId -
Throws:
java.rmi.RemoteException
NotificationException

removeAllProjectNotifications

public void removeAllProjectNotifications(long projectId)
                                   throws java.rmi.RemoteException
Removes all project notifications.

Parameters:
projectId -
Throws:
java.rmi.RemoteException

saveNotifications

public void saveNotifications()
                       throws java.rmi.RemoteException,
                              NotificationException
Saves the notifications.

Throws:
java.rmi.RemoteException
NotificationException

updateProjectState

public java.util.List updateProjectState(ProjectIfc project)
                                  throws java.rmi.RemoteException,
                                         NetworkException
Updates the project state.

Parameters:
project -
Returns:
List
Throws:
java.rmi.RemoteException
NetworkException

getEventProcessorForProject

public com.compuware.optimaltrace.tools.common.tpn.EventProcessorIfc getEventProcessorForProject(ProjectIfc project)
Gets the event processor for this project.

Parameters:
project -
Returns:
EventProcessorIfc

checkProjectDaemon

public void checkProjectDaemon()
                        throws java.rmi.RemoteException
Checks the project daemon.

Throws:
java.rmi.RemoteException

unregisterClient

public void unregisterClient()
                      throws java.rmi.RemoteException
Unregisters the client.

Throws:
java.rmi.RemoteException

useWindowsIntegratedAuthentication

public boolean useWindowsIntegratedAuthentication()
                                           throws java.rmi.RemoteException
Verifies if Windows Integrated Authentication is to be used.

Returns:
boolean
Throws:
java.rmi.RemoteException

enableNewProjectSecurity

public boolean enableNewProjectSecurity()
                                 throws java.rmi.RemoteException
Check if newly created project is security enabled.

Returns:
boolean
Throws:
java.rmi.RemoteException

newProject

public ProjectIfc newProject(java.lang.String projectName,
                             boolean createInDatabase)
Creates a New Local Project Currently this is not a supported call from the API

Parameters:
projectName -
createInDatabase -
Returns:
ProjectIfc

newRemoteProject

public ProjectIfc newRemoteProject(java.lang.String projectName)
                            throws NetworkException,
                                   ProjectNotUniqueException,
                                   AuthenticationException,
                                   PermissionException
Creates a New Remote Project Currently this is not a supported call from the API

Parameters:
projectName -
Returns:
ProjectIfc
Throws:
NetworkException
ProjectNotUniqueException
AuthenticationException
PermissionException

deleteProject

public void deleteProject(java.lang.String projectName)
                   throws NetworkException,
                          ClientConnectedException,
                          AuthenticationException,
                          PermissionException
Deletes a Project. \r\n***Currently this is not a supported call from the API

Parameters:
projectName -
Throws:
NetworkException
ClientConnectedException
AuthenticationException
PermissionException

listProjectsDetailWithSecurityInfo

public java.util.Map[] listProjectsDetailWithSecurityInfo()
                                                   throws NetworkException
List Project Details with their Security Info Element 0 is the map of name > project id's Element 1 is the map of name > isSecure

Returns:
Map
Throws:
NetworkException

listProjects

public java.util.Map listProjects()
                           throws NetworkException
Gets a List of Projects Currently this is not a supported call from the API

Returns:
Map
Throws:
NetworkException

isProjectSecure

public boolean isProjectSecure(java.lang.String projectName)
Checks if a Project is Security Enabled or not

Parameters:
projectName -
Returns:
boolean

isProjectSecure

public boolean isProjectSecure(long projectId)
Checks if a Project is Security Enabled or not

Parameters:
projectId -
Returns:
boolean

isProjectBaselineSecure

public boolean isProjectBaselineSecure(ProjectIfc project,
                                       java.lang.String baseline)
Checks if the project baseline is secure.

Parameters:
project -
baseline -
Returns:
boolean

saveQADProjectInfo

public void saveQADProjectInfo(ProjectIfc project,
                               com.compuware.optimaltrace.tools.qad.QADProjectInfo qadProjectInfo)
                        throws NetworkException
Saves the QADProjectInfo. This method is used by the QAD Integration plugin. QADProjectInfo does not use the Event I/O system used by the BizObjects in Optimal Trace.

Parameters:
project -
qadProjectInfo - - modified instance of the method to be saved.
Throws:
NetworkException

findQADScriptInfo

public com.compuware.optimaltrace.tools.qad.QADScriptInfo findQADScriptInfo(ProjectIfc project,
                                                                            long scenarioOID)
                                                                     throws NetworkException
Locates the QADScriptInfo for the given Scenario. This method is used by the QAD Integration plugin. QADProjectInfo does not use the Event I/O system used by the BizObjects in Optimal Trace.

Parameters:
scenarioOID - - oid of the scenario to look up a QADScriptInfo for.
Returns:
QADScriptInfo - script info for the given scenario.
Throws:
NetworkException

deleteQADProjectInfo

public void deleteQADProjectInfo(ProjectIfc project)
                          throws NetworkException
Throws:
NetworkException

saveQADScriptInfo

public void saveQADScriptInfo(ProjectIfc project,
                              com.compuware.optimaltrace.tools.qad.QADScriptInfo qadScriptInfo)
                       throws NetworkException
Saves the QADScriptInfo. This method is used by the QAD Integration plugin. QADScriptInfo does not use the Event I/O system used by the BizObjects in Optimal Trace.

Parameters:
project -
qadScriptInfo - - modified instance to be saved.
Throws:
NetworkException

saveQADScriptInfo

public void saveQADScriptInfo(ProjectIfc project,
                              java.util.Collection<com.compuware.optimaltrace.tools.qad.QADScriptInfo> qadScriptInfoCol)
                       throws NetworkException
Saves the QADScriptInfo collection. This method is used by the QAD Integration plugin. QADScriptInfo does not use the Event I/O system used by the BizObjects in Optimal Trace.

Parameters:
project -
qadScriptInfo - - modified instance to be saved.
Throws:
NetworkException

findQADProjectInfo

public com.compuware.optimaltrace.tools.qad.QADProjectInfo findQADProjectInfo(ProjectIfc project)
                                                                       throws NetworkException
Finds the QADProjectInfo. This method is used by the QAD Integration plugin.

Parameters:
project -
Returns:
QADProjectInfo - modified instance of the method to be saved.
Throws:
NetworkException

deleteQADScriptInfo

public void deleteQADScriptInfo(ProjectIfc project,
                                long scenarioOID)
                         throws NetworkException
Throws:
NetworkException

findQADScriptInfo

public java.util.Collection<com.compuware.optimaltrace.tools.qad.QADScriptInfo> findQADScriptInfo(ProjectIfc project,
                                                                                                  long[] scenarioOID)
                                                                                           throws NetworkException
Locates the QADScriptInfos for the given Scenarios. This method is used by the QAD Integration plugin. QADProjectInfo does not use the Event I/O system used by the BizObjects in Optimal Trace.

Parameters:
scenarioOID - - oid of the scenario to look up a QADScriptInfo for.
Returns:
QADScriptInfo - script info for the given scenario.
Throws:
NetworkException

OptimalTrace
5.2

Compuware Corporation

OptimalTrace is a trademark or registered trademark of Compuware Corporation in the US and other countries.
Copyright 2008-2009 Compuware Corporation. One Campus Martius,
Detroit, Michigan, 48226, U.S.A. All Rights Reserved.