commit 5973a9b894e1e004d8ecf36fcbcb5c171651d9ee Author: Mauro Talevi <mauro.tal...@aquilonia.org> AuthorDate: Wed, 26 Feb 2014 09:24:29 +0000 Commit: Mauro Talevi <mauro.tal...@aquilonia.org> CommitDate: Wed, 26 Feb 2014 09:24:29 +0000
JBEHAVE-994: Updated docs. diff --git a/distribution/src/site/content/using-rest.html b/distribution/src/site/content/using-rest.html index 9a5f0c3..95aaf6b 100755 --- a/distribution/src/site/content/using-rest.html +++ b/distribution/src/site/content/using-rest.html @@ -14,14 +14,29 @@ <p>REST is typically used to access wikis. Each REST provider has its own API.</p> +<h3>Using provider-specific components</h3> + +<p>JBehave allows provider-specific implementation of the following interface:</p> +<ul> +<li><a href="javadoc/rest/org/jbehave/core/io/rest/ResourceIndexer.html">ResourceIndexer</a>: indexes resources</li> +<li><a href="javadoc/core/org/jbehave/core/io/ResourceLooader.html">ResourceLoader</a>: loads resources from provider</li> +<li><a href="javadoc/rest/org/jbehave/core/io/rest/ResourceUploader.html">ResourceUploader</a>: uploads resources to provider</li> +</ul> +</p> <p>Currently supported as REST providers are <a href="http://redmine.org">Redmine</a> and <a href="http://xwiki.org">XWiki</a>. -The implementations that are provider-specific are the <a href="javadoc/rest/org/jbehave/core/io/rest/ResourceIndexer.html">ResourceIndexer</a>, -the <a href="javadoc/core/org/jbehave/core/io/ResourceLooader.html">ResourceLoader</a> and -the <a href="javadoc/rest/org/jbehave/core/io/rest/ResourceUploader.html">ResourceUploader</a>.</p> +Also supported for resource indexing and loading (but not for uploading) is <a href="https://www.atlassian.com/software/confluence">Confluence</a>.</p> + +<p>JBehave allows provider-agnostic components for importing/export from/to providers:</p> +<ul> +<li><a href="javadoc/rest/org/jbehave/core/io/rest/ResourceImporter.html">ResourceImporter</a>: imports resources from provider</li> +<li><a href="javadoc/rest/org/jbehave/core/io/rest/ResourceExporter.html">ResourceExporter</a>: exports resources to provider</li> +</ul> +<p>Currently supported are import/export implementations to/from filesystem. Typically, importer/exporter implementations will be injected with +provider-specific implementations of resource indexer, loader and uploader.</p> -<h3>Using Maven goal</h3> +<h3>Using Maven goals</h3> -<p>The import/export functionality is also exposed via Maven goals:</p> +<p>The import/export filesystem functionality is also exposed via Maven goals:</p> <script type="syntaxhighlighter" class="brush: xml"> <![CDATA[