org.rhq.enterprise.server.plugins.url
Interface IndexParser

All Known Implementing Classes:

SimpleIndexParser, XmlIndexParser

public interface IndexParser

Parses an index file that provides the metadata about content found in a content source.

Author:

John Mazzitelli

Method Summary

java.util.Map<java.lang.String,RemotePackageInfo>

parse(java.io.InputStream indexStream, UrlProvider contentSource) Given an input stream containing the index data, this will parse that data and return the parsed information.

Method Detail

parse

java.util.Map<java.lang.String,RemotePackageInfo> parse(java.io.InputStream indexStream,
                                                        UrlProvider contentSource)
                                                        throws java.lang.Exception

Given an input stream containing the index data, this will parse that data and return the parsed information.

Parameters:

indexStream - stream containing the index data (it is not necessary for this method to close this)

contentSource - the content source where the index file came from

Returns:

map containing the package metadata info, keyed on each package's location

Throws:

java.lang.Exception - if failed to parse the index file