Java Doc for CMSynergy.java in  » Build » cruisecontrol » net » sourceforge » cruisecontrol » sourcecontrols » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Build » cruisecontrol » net.sourceforge.cruisecontrol.sourcecontrols 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   net.sourceforge.cruisecontrol.sourcecontrols.CMSynergy

CMSynergy
public class CMSynergy implements SourceControl(Code)
Checks for modifications made to a Telelogic CM Synergy repository. It does this by examining a provided reference project, getting the tasks from all folders in that project, and checking the completion time of those tasks against the last build.
author:
   Robert J. Smith


Field Summary
final public static  StringCCM_ATTR_DELIMITER
    
final public static  StringCCM_END_OBJECT
    
final public static  StringCCM_EXE
    
final public static  StringCCM_SESSION_FILE
    
final public static  StringCCM_SESSION_VAR
     The environment variable used by CM Synergy to determine which backend ccmSession to use when issuing commands.


Method Summary
public static  ManagedCommandlinecreateCcmCommand(String ccmExe, String sessionName, File sessionFile)
     Creates a ManagedCommandline configured to run CM Synergy commands.
Parameters:
  ccmExe - Full path of the CM Synergy command line client (ornull to use the default).
Parameters:
  sessionName - The name of the session as stored in the map file (ornull to use the default session).
Parameters:
  sessionFile - The CM Synergy session map file (or null to usethe default).
public  ListgetModifications(Date lastBuild, Date now)
    
public  MapgetProperties()
    
public static  StringgetSessionID(String sessionName, File sessionFile)
     Given a CM Synergy session name, looks up the corresponding session ID.
public  voidsetCcmDateFormat(String format)
     Sets the date format used by your installation of CM Synergy.
public  voidsetCcmDb(String db)
     Sets the remote Synergy database with which to connect.
public  voidsetCcmExe(String ccmExe)
     Sets the name of the CM Synergy executable to use when issuing commands.
public  voidsetChangeSynergyURL(String url)
     Sets the URL for your installation of Change Synergy.
public  voidsetCountry(String country)
     Sets the country used to create the locale for parsing CM Synergy dates. The format should follow the ISO standard as specified by java.util.Locale.
public  voidsetIgnoreWorkarea(boolean ignoreWorkarea)
     Sets the value of the ignoreWorkarea attribute.
public  voidsetInstance(String projectInstance)
     Sets the project's instance value.
public  voidsetLanguage(String language)
     Sets the language used to create the locale for parsing CM Synergy dates. The format should follow the ISO standard as specified by java.util.Locale.
public  voidsetProject(String projectSpec)
     Sets the CM Synergy project spec to be used as a template for calculating changes.
public  voidsetProperty(String property)
    
public  voidsetReconfigure(boolean reconfigure)
     Sets the value of the reconfigure attribute.
public  voidsetRecurse(boolean recurse)
     Sets the value of the recurse attribute.
public  voidsetSessionFile(String sessionFile)
     Sets the file which contains the mapping between CM Synergy session names and IDs.
public  voidsetSessionName(String sessionName)
     Sets the name of the CM Synergy session to use with this plugin.
public  voidsetUpdateFolders(boolean updateFolders)
     Sets the value of the updateFolders attribute.
public  voidsetUseBindTime(boolean useBindTime)
     Sets the value of the useBindtime attribute.
public  voidvalidate()
    

Field Detail
CCM_ATTR_DELIMITER
final public static String CCM_ATTR_DELIMITER(Code)
A delimiter used for data values returned from a CM Synergy query



CCM_END_OBJECT
final public static String CCM_END_OBJECT(Code)
A delimiter used to mark the end of a multi-lined result from a query



CCM_EXE
final public static String CCM_EXE(Code)
The default CM Synergy command line client executable



CCM_SESSION_FILE
final public static String CCM_SESSION_FILE(Code)
The default CM Synergy session map file



CCM_SESSION_VAR
final public static String CCM_SESSION_VAR(Code)
The environment variable used by CM Synergy to determine which backend ccmSession to use when issuing commands.





Method Detail
createCcmCommand
public static ManagedCommandline createCcmCommand(String ccmExe, String sessionName, File sessionFile)(Code)
Creates a ManagedCommandline configured to run CM Synergy commands.
Parameters:
  ccmExe - Full path of the CM Synergy command line client (ornull to use the default).
Parameters:
  sessionName - The name of the session as stored in the map file (ornull to use the default session).
Parameters:
  sessionFile - The CM Synergy session map file (or null to usethe default). A configured ManagedCommandline



getModifications
public List getModifications(Date lastBuild, Date now)(Code)



getProperties
public Map getProperties()(Code)



getSessionID
public static String getSessionID(String sessionName, File sessionFile) throws CruiseControlException(Code)
Given a CM Synergy session name, looks up the corresponding session ID.
Parameters:
  sessionName - The CM Synergy session name
Parameters:
  sessionFile - The session map file The session ID.



setCcmDateFormat
public void setCcmDateFormat(String format)(Code)
Sets the date format used by your installation of CM Synergy. The format string should use the syntax described in SimpleDateFormat. The default is "EEE MMM dd HH:mm:ss yyyy" The value set here can be accessed from within the build as the property "cc.ccm.dateformat".
Parameters:
  format - the date format



setCcmDb
public void setCcmDb(String db)(Code)
Sets the remote Synergy database with which to connect. This is only needed if you wish to create active links from the build results page to your installation of Change Synergy. If you set this attribute, you must also set the changesynergyurl attribute.
Parameters:
  db - The remote Synergy database with which to connect (e.g./ccmdb/mydb).



setCcmExe
public void setCcmExe(String ccmExe)(Code)
Sets the name of the CM Synergy executable to use when issuing commands.
Parameters:
  ccmExe - the name of the CM Synergy executable



setChangeSynergyURL
public void setChangeSynergyURL(String url)(Code)
Sets the URL for your installation of Change Synergy. This is used to create active links from the modification report to the Change Requests associated with the modified tasks. If not set, the links will not be created. If you wish to use this feature, you must also set the ccmdb attribute to the remote location of the Synergy database.
Parameters:
  url - The URL of your ChangeSynergy installation



setCountry
public void setCountry(String country)(Code)
Sets the country used to create the locale for parsing CM Synergy dates. The format should follow the ISO standard as specified by java.util.Locale. The default is "US" (United States).
Parameters:
  country - The ISO country code to use



setIgnoreWorkarea
public void setIgnoreWorkarea(boolean ignoreWorkarea)(Code)
Sets the value of the ignoreWorkarea attribute. If set to true, we will not attempt to determine the location of the project's workarea, nor will we pass the cc.ccm.workarea attribute to the builders. Default is false.



setInstance
public void setInstance(String projectInstance)(Code)
Sets the project's instance value. This value will be used in any query which involves the project. Defaults to "1". This default should work for most people. You might, however, need to override this value when using DCM?
Parameters:
  projectInstance - The instance number of the project.



setLanguage
public void setLanguage(String language)(Code)
Sets the language used to create the locale for parsing CM Synergy dates. The format should follow the ISO standard as specified by java.util.Locale. The default is "en" (English).
Parameters:
  language - The language to use when creating the Locale



setProject
public void setProject(String projectSpec)(Code)
Sets the CM Synergy project spec to be used as a template for calculating changes. The value set here can be accessed from within the build as the property "cc.ccm.project".
Parameters:
  projectSpec - The project spec (in 2 part name format).



setProperty
public void setProperty(String property)(Code)



setReconfigure
public void setReconfigure(boolean reconfigure)(Code)
Sets the value of the reconfigure attribute. If set to true, the project will be reconfigured when changes are detected. Default value is false.



setRecurse
public void setRecurse(boolean recurse)(Code)
Sets the value of the recurse attribute. Used in conjuction with the reconfigure attribute. If set to true, all subprojects will also be reconfigured when changes are detected. Default is true.



setSessionFile
public void setSessionFile(String sessionFile)(Code)
Sets the file which contains the mapping between CM Synergy session names and IDs. This file should be in the standard properties file format. Each line should map one name to a CM Synergy session ID (as returned by the "ccm status" command).

example:

session1=localhost:65024:192.168.1.17
Parameters:
  sessionFile - The session file




setSessionName
public void setSessionName(String sessionName)(Code)
Sets the name of the CM Synergy session to use with this plugin. This name should appear in the specified session file.
Parameters:
  sessionName - The session name
See Also:   CMSynergy.setSessionFile(String)



setUpdateFolders
public void setUpdateFolders(boolean updateFolders)(Code)
Sets the value of the updateFolders attribute. If set to true, the contents of the folders contained within the project's reconfigure properties will be updated before we query to find new tasks.



setUseBindTime
public void setUseBindTime(boolean useBindTime)(Code)
Sets the value of the useBindtime attribute. If set to true, the time the task came into the reconfigure folders is used to query the modifications instead of the time the task was completed. Works for Synergy 6.3SP1 and newer only. Default value is false.



validate
public void validate() throws CruiseControlException(Code)



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.