Package org.jbehave.core.io.rest.confluence

Class IndexFromConfluence

java.lang.Object

org.jbehave.core.io.rest.confluence.IndexFromConfluence

All Implemented Interfaces:

ResourceIndexer

public class IndexFromConfluence
extends Object
implements ResourceIndexer

Constructor Summary

Constructors

Constructor	Description
IndexFromConfluence()
IndexFromConfluence(String username, String password)
IndexFromConfluence(RESTClient client)

Method Summary

Modifier and Type	Method	Description
Map<String,Resource>	indexResources(String rootURI)	Indexes resources retrieved from the given root URI
protected Map<String,Resource>	indexResources(String rootURI, String includePattern)
Map<String,Resource>	indexResources(String rootURI, String rootPath, String syntax, String includes)	Indexes resources found in the given root path

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IndexFromConfluence

public IndexFromConfluence()

IndexFromConfluence

public IndexFromConfluence(String username,
                           String password)

IndexFromConfluence

public IndexFromConfluence(RESTClient client)

Method Detail

indexResources

public Map<String,Resource> indexResources(String rootURI)

Description copied from interface: ResourceIndexer

Indexes resources retrieved from the given root URI

Specified by:

indexResources in interface ResourceIndexer

Parameters:

rootURI - the root URI

Returns:

The Map of index Resource objects

indexResources

public Map<String,Resource> indexResources(String rootURI,
                                                 String rootPath,
                                                 String syntax,
                                                 String includes)

Description copied from interface: ResourceIndexer

Indexes resources found in the given root path

Specified by:

indexResources in interface ResourceIndexer

Parameters:

rootURI - the root URI

rootPath - the root path of the resources to index

syntax - the syntax of the resources to index. Can be null or blank.

includes - the Ant-like pattern of the paths to index. Can be null or blank.

Returns:

The Map of index Resource objects

indexResources

protected Map<String,Resource> indexResources(String rootURI,
                                                    String includePattern)