Return-Path: Delivered-To: apmail-maven-continuum-commits-archive@www.apache.org Received: (qmail 30599 invoked from network); 8 Jul 2005 21:59:15 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199) by minotaur.apache.org with SMTP; 8 Jul 2005 21:59:15 -0000 Received: (qmail 89265 invoked by uid 500); 8 Jul 2005 21:59:15 -0000 Delivered-To: apmail-maven-continuum-commits-archive@maven.apache.org Received: (qmail 89243 invoked by uid 500); 8 Jul 2005 21:59:15 -0000 Mailing-List: contact continuum-commits-help@maven.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: continuum-dev@maven.apache.org Delivered-To: mailing list continuum-commits@maven.apache.org Received: (qmail 89230 invoked by uid 99); 8 Jul 2005 21:59:14 -0000 X-ASF-Spam-Status: No, hits=-9.8 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received: from [209.237.227.194] (HELO minotaur.apache.org) (209.237.227.194) by apache.org (qpsmtpd/0.29) with SMTP; Fri, 08 Jul 2005 14:58:28 -0700 Received: (qmail 30330 invoked by uid 65534); 8 Jul 2005 21:58:25 -0000 Message-ID: <20050708215825.30329.qmail@minotaur.apache.org> Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r209901 - /maven/continuum/trunk/continuum-site/src/site/apt/soap-api.apt Date: Fri, 08 Jul 2005 21:58:25 -0000 To: continuum-commits@maven.apache.org From: evenisse@apache.org X-Mailer: svnmailer-1.0.2 X-Virus-Checked: Checked by ClamAV on apache.org X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N Author: evenisse Date: Fri Jul 8 14:58:24 2005 New Revision: 209901 URL: http://svn.apache.org/viewcvs?rev=209901&view=rev Log: Fix svn properties :-( Modified: maven/continuum/trunk/continuum-site/src/site/apt/soap-api.apt (contents, props changed) Modified: maven/continuum/trunk/continuum-site/src/site/apt/soap-api.apt URL: http://svn.apache.org/viewcvs/maven/continuum/trunk/continuum-site/src/site/apt/soap-api.apt?rev=209901&r1=209900&r2=209901&view=diff ============================================================================== --- maven/continuum/trunk/continuum-site/src/site/apt/soap-api.apt (original) +++ maven/continuum/trunk/continuum-site/src/site/apt/soap-api.apt Fri Jul 8 14:58:24 2005 @@ -1,88 +1,88 @@ - ------ - SOAP API - ------ - Dan Diephouse - ------ - Fri Jul 8 2005 - -Getting Started - - Continuum has a SOAP API which makes it easy to add, remove, view and manipulate - builds from within your applications. Continuum includes a client to access this - API. Alternatively, you may generate a client from favorite SOAP toolkit - (such as the toolkits for PERL or .NET) using the WSDL found at - {{http://localhost:8080/continuum/services/Continuum?wsdl}}. If you are using a - client other than the one mentioned below, the code should be roughly the same. - - The API provides the following operations: - * addProject - * getProject - * remoteProject - * updateProject - * checkoutProject - * removeProject - * getLatestBuild - * getCheckOutScmResult - -Using the Bundled Java Client - -* Creating a Client -+--+ -import org.apache.maven.continuum.xfire.ContinuumWebService; -import org.apache.maven.continuum.xfire.ContinuumClientFactory; -import org.apache.maven.continuum.xfire.Project; -import org.apache.maven.continuum.xfire.Build; -import org.apache.maven.continuum.project.ContinuumProjectState; - -... - -ContinuumWebService continuum = - ContinuumClientFactory.createClient("http://localhost:8080/continuum/services/Continuum"); -+--+ - -* Adding A Project - -+--+ -Project project = new Project(); -project.setType("maven-two"); -project.setScmUrl("scm:svn...."); - -continuum.addProject(project); -+--+ - - The project type tells Continuum what type of project to expect. Valid values are - "ant", "shell", "maven-one", and "maven-two". - -* Getting the latest build - -+--+ -Build build = continuum.getLatestBuild(project.getId()); - -if (build.getState() == ContinuumProjectState.OK) - doSomething(); -else if (build.getState() == ContinuumProjectState.FAILED) - punishDevelopers(); -+--+ - -Notes for other Toolkits - -* Project State - In one of the above code snippets, you see that we can check the build state. - The build state can be one of several values: - -*---*------------------------* -| 1 | New Build | -*---*------------------------* -| 2 | Successful Build | -*---*------------------------* -| 3 | Failed Build | -*---*------------------------* -| 4 | Error building | -*---*------------------------* -| 6 | Build in process | -*---*------------------------* -| 7 | Checking out from SCM | -*---*------------------------* -| 8 | Updating from SCM | -*---*------------------------* - + ------ + SOAP API + ------ + Dan Diephouse + ------ + Fri Jul 8 2005 + +Getting Started + + Continuum has a SOAP API which makes it easy to add, remove, view and manipulate + builds from within your applications. Continuum includes a client to access this + API. Alternatively, you may generate a client from favorite SOAP toolkit + (such as the toolkits for PERL or .NET) using the WSDL found at + {{http://localhost:8080/continuum/services/Continuum?wsdl}}. If you are using a + client other than the one mentioned below, the code should be roughly the same. + + The API provides the following operations: + * addProject + * getProject + * remoteProject + * updateProject + * checkoutProject + * removeProject + * getLatestBuild + * getCheckOutScmResult + +Using the Bundled Java Client + +* Creating a Client ++--+ +import org.apache.maven.continuum.xfire.ContinuumWebService; +import org.apache.maven.continuum.xfire.ContinuumClientFactory; +import org.apache.maven.continuum.xfire.Project; +import org.apache.maven.continuum.xfire.Build; +import org.apache.maven.continuum.project.ContinuumProjectState; + +... + +ContinuumWebService continuum = + ContinuumClientFactory.createClient("http://localhost:8080/continuum/services/Continuum"); ++--+ + +* Adding A Project + ++--+ +Project project = new Project(); +project.setType("maven-two"); +project.setScmUrl("scm:svn...."); + +continuum.addProject(project); ++--+ + + The project type tells Continuum what type of project to expect. Valid values are + "ant", "shell", "maven-one", and "maven-two". + +* Getting the latest build + ++--+ +Build build = continuum.getLatestBuild(project.getId()); + +if (build.getState() == ContinuumProjectState.OK) + doSomething(); +else if (build.getState() == ContinuumProjectState.FAILED) + punishDevelopers(); ++--+ + +Notes for other Toolkits + +* Project State + In one of the above code snippets, you see that we can check the build state. + The build state can be one of several values: + +*---*------------------------* +| 1 | New Build | +*---*------------------------* +| 2 | Successful Build | +*---*------------------------* +| 3 | Failed Build | +*---*------------------------* +| 4 | Error building | +*---*------------------------* +| 6 | Build in process | +*---*------------------------* +| 7 | Checking out from SCM | +*---*------------------------* +| 8 | Updating from SCM | +*---*------------------------* + Propchange: maven/continuum/trunk/continuum-site/src/site/apt/soap-api.apt ------------------------------------------------------------------------------ svn:eol-style = native Propchange: maven/continuum/trunk/continuum-site/src/site/apt/soap-api.apt ------------------------------------------------------------------------------ svn:keywords = Author Date Id Revision