Jump to: navigation, search

HttpDeployer API

HTTP Deployer API Documentation

Demo Screencast

See http://vimeo.com/26697667

XML-Methods

Repositories

List known repositories

Request: GET /repository Response format:

 <repositories>
<repository>
<uri>http://download.eclipse.org/releases/staging/</uri>
</repository>
...
</repositories>

Upload repository

Request: POST /repository Parameters: Multipart-Request with an attached zipped version of the repository. Response format:

<repositories>
<repository>
<!-- Repository Path on Remote Server -->
<uri>file:/tmp/repo_24134021342071/</uri>
<status>successful</status>
<action>ADD</action>
</repository>
</repositories>

Add repository by URI

Request: POST /repository Parameter format:

<repositories>
<repository>
<uri>file:/home/sebs/repository/</uri>
</repository>
</repositories>

Response format:

<repositories>
<repository>
<uri>file:/home/sebs/repository/</uri>
<status>successful</status>
<action>ADD</action>
</repository>
</repositories>

Remove repository

Request: DELETE /repository Parameter format:

<repositories>
<repository>
<uri>file:/home/sebs/repository/</uri>
</repository>
</repositories>

Response format:

<repositories>
<repository>
<uri>file:/home/sebs/repository/</uri>
<status>successful</status>
<action>REMOVE</action>
</repository>
</repositories>


Features

Install feature

Request: POST /feature Parameter format:

<features>
<feature>
<name>testFeature.feature.group</name>
<version>1.0.0.servlet</version>
</feature>
</features>

Response format:

<features>
<feature>
<name>testFeature.feature.group</name>
<version>1.0.0.servlet</version>
<action>INSTALL</action>
<status>successful</status>
</feature>
</features>

Uninstall feature

Request: DELETE /feature Parameter format:

<features>
<feature>
<name>testFeature.feature.group</name>
<version>1.0.0.servlet</version>
</feature>
</features>

Response format:

<features>
<feature>
<name>testFeature.feature.group</name>
<version>1.0.0.servlet</version>
<action>UNINSTALL</action>
<status>successful</status>
</feature>
</features>


Bundles

List all bundles

Request: GET /bundle Response format:

<bundles>
<bundle>
<name>org.eclipse.osgi</name>
<version>3.7.0.v20110613</version>
</bundle>
...
</bundles>

List active bundles

Request: GET /bundle/active Response format:

<bundles>
<bundle>
<name>org.eclipse.osgi</name>
<version>3.7.0.v20110613</version>
</bundle>
...
</bundles>

List resolved bundles

Request: GET /bundle/resolved Response format:

<bundles>
<bundle>
<name>org.eclipse.osgi</name>
<version>3.7.0.v20110613</version>
</bundle>
...
</bundles>

Start bundle

Request: POST /bundle/manage Parameter format:

<bundles>
<bundle>
<action>start</action>
<name>testPlugin</name>
</bundle>
</bundles>

Response Format:

<bundles>
<bundle>
<action>START</action>
<status>successful</status>
<name>testPlugin</name>
</bundle>
</bundles>


Stop bundle

Request: POST /bundle/manage Parameter format:

<bundles>
<bundle>
<action>stop</action>
<name>testPlugin</name>
</bundle>
</bundles>

Response Format:

<bundles>
<bundle>
<action>STOP</action>
<status>successful</status>
<name>testPlugin</name>
</bundle>
</bundles>

Uninstall bundle

Request: DELETE /bundle/manage Parameter format:

<bundles>
<bundle>
<name>testPlugin</name>
</bundle>
</bundles>

Response Format:

<bundles>
<bundle>
<action>UNINSTALL</action>
<status>successful</status>
<name>testPlugin</name>
</bundle>
</bundles>