Package org.jbehave.core.io.rest

Interface ResourceIndexer

All Known Implementing Classes:

IndexFromConfluence, IndexFromRedmine, IndexFromXWiki, IndexWithBreadcrumbs

public interface ResourceIndexer

Indexes the resources available from the REST root URI. The index is represented as a map, indexed by the name of the resource.

Author:

Mauro Talevi

Method Summary

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

Method Detail

indexResources

Map<String,Resource> indexResources(String rootURI)

Indexes resources retrieved from the given root URI

Parameters:

rootURI - the root URI

Returns:

The Map of index Resource objects

indexResources

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

Indexes resources found in the given root path

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