You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@continuum.apache.org by ev...@apache.org on 2007/11/12 13:45:39 UTC
svn commit: r594096 - in /maven/continuum/trunk/continuum-site/src/site:
apt/documentation/1_1/developer_guides/xmlrpc.apt fml/faqs.fml
Author: evenisse
Date: Mon Nov 12 04:45:38 2007
New Revision: 594096
URL: http://svn.apache.org/viewvc?rev=594096&view=rev
Log:
[CONTINUUM-1313] Add xmlrpc documentation
[CONTINUM-347]Document push build technique by project id
Added:
maven/continuum/trunk/continuum-site/src/site/apt/documentation/1_1/developer_guides/xmlrpc.apt (with props)
Modified:
maven/continuum/trunk/continuum-site/src/site/fml/faqs.fml
Added: maven/continuum/trunk/continuum-site/src/site/apt/documentation/1_1/developer_guides/xmlrpc.apt
URL: http://svn.apache.org/viewvc/maven/continuum/trunk/continuum-site/src/site/apt/documentation/1_1/developer_guides/xmlrpc.apt?rev=594096&view=auto
==============================================================================
--- maven/continuum/trunk/continuum-site/src/site/apt/documentation/1_1/developer_guides/xmlrpc.apt (added)
+++ maven/continuum/trunk/continuum-site/src/site/apt/documentation/1_1/developer_guides/xmlrpc.apt Mon Nov 12 04:45:38 2007
@@ -0,0 +1,110 @@
+ ------
+ Guide to use XML-RPC with Continuum
+ ------
+ Emmanuel Venisse
+ ------
+ Nov 12 2007
+ ------
+
+Guide to use XML-RPC with Continuum
+
+%{toc|section=0}
+
+* {Introduction}
+
+ In this section, you'll learn how to connect to a Continuum instance and how to do some action on projects.
+
+* {Requirements}
+
+ To connect to a Continuum instance, you must use the {{{http://repo1.maven.org/maven2/org/apache/maven/continuum/continuum-xmlrpc-client/}continuum-xmlrpc-client}} jar.
+
+ This library have some others jars as dependencies, so the best way to start the development of a Continuum xmlrpc client is to create a maven2 project with the following dependencies:
+
++--------------------------+
+ <dependency>
+ <groupId>org.apache.maven.continuum</groupId>
+ <artifactId>continuum-xmlrpc-client</artifactId>
+ <version>YOUR_CONTINUUM_VERSION</version>
+ </dependency>
++--------------------------+
+
+* {Connection to Continuum}
+
+ To connect to your Continuum with the client API, you must use the
+ {{{http://maven.apache.org/continuum/ref/latest/apidocs/org/apache/maven/continuum/xmlrpc/client/ContinuumXmlRpcClient.html}ContinuumXmlRpcClient}} class.
+
+ The constructor use 3 parameters:
+
+ * url, the url of the xmlrpc listener that is http://host:port/continuum/xmlrpc
+
+ * user, a Continuum user
+
+ * password, the user's password
+
++--------------------------+
+String url = "http://localhost:8080/continuum/xmlrpc";
+ContinuumXmlRpcClient client = new ContinuumXmlRpcClient( url, username, password );
++--------------------------+
+
+* {Getting project groups list}
+
+ You have two ways to get the project groups list. The first is to get only a summary of groups and the second returns groups with details.
+ If you don't need all informations, we recommend to use the first way, so you'll save time to get datas and memory on the server.
+
++--------------------------+
+List<ProjectGroupSummary> pgs = client.getAllProjectGroups();
+List<ProjectGroup> pgs = client.getAllProjectGroupsWithProjects();
++--------------------------+
+
+* {Getting projects in a group}
+
++--------------------------+
+List<ProjectSummary> ps = client.getProjects( projectGroupId );
++--------------------------+
+
+ If you already have a ProjectGroup or ProjectGroupSummary object, you can access to the project group id with this:
+
++--------------------------+
+int projectGroupId = pg.getId();
++--------------------------+
+
+* {Building all projects in a group}
+
+ * With the default build definition
+
++--------------------------+
+client.buildGroup( projectGroupId );
++--------------------------+
+
+ * With a build definition
+
++--------------------------+
+client.buildGroup( projectGroupId, buildDefinitionId );
++--------------------------+
+
+* {Building a project}
+
+ * With the default build definition
+
++--------------------------+
+client.buildProject( project.getId() );
++--------------------------+
+
+ * With a build definition
+
++--------------------------+
+client.buildProject( project.getId(), buildDefinitionId );
++--------------------------+
+
+ <<Note:>> When you start a build, the project is put in the Continuum queue and will be built when all projects added previously in the queue will be built.
+
+* {Triggering a build}
+
+ In some case, users want to use the push build technique with a hook in their SCM, so when a developer will commit some files, a build will be triggered.
+ To do this, you can write a simple xmlrpc client that will use a project id as parameter and you'll use the <<<buildProject(...)>>> method described above.
+
+ This method will start a forced build.
+
+* {Backup}
+
+ With the Continuum xmlrpc client, you can backup a full Continuum instance (without users database, for the moment).
\ No newline at end of file
Propchange: maven/continuum/trunk/continuum-site/src/site/apt/documentation/1_1/developer_guides/xmlrpc.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/continuum/trunk/continuum-site/src/site/apt/documentation/1_1/developer_guides/xmlrpc.apt
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Modified: maven/continuum/trunk/continuum-site/src/site/fml/faqs.fml
URL: http://svn.apache.org/viewvc/maven/continuum/trunk/continuum-site/src/site/fml/faqs.fml?rev=594096&r1=594095&r2=594096&view=diff
==============================================================================
--- maven/continuum/trunk/continuum-site/src/site/fml/faqs.fml (original)
+++ maven/continuum/trunk/continuum-site/src/site/fml/faqs.fml Mon Nov 12 04:45:38 2007
@@ -295,7 +295,7 @@
<question>How can I build projects with a scm post-commit hook?</question>
<answer>
<p>
- If your SCM support hook scripts, you'll need to write an <a href="guides/mini/guide-xmlrpc-api.html">xml-rpc client</a> for Continuum and call it in your post-commit script.
+ If your SCM support hook scripts, you'll need to write an <a href="documentation/1_1/developer_guides/xmlrpc.html">xml-rpc client</a> for Continuum and call it in your post-commit script.
</p>
</answer>
</faq>