org.rhq.enterprise.server.plugins.url
Class UrlProvider

java.lang.Object
  org.rhq.enterprise.server.plugins.url.UrlProvider

All Implemented Interfaces:

ContentProvider, PackageSource

Direct Known Subclasses:

HttpProvider

public class UrlProvider
extends Object
implements ContentProvider, PackageSource

This is a basic implementation of a content source that provides primative package synchronization with a URL-based content source, such as an HTTP server. In order for this URL content source to properly scan and find content in the remote server, an index file must exist that provides metadata about each file. There are two forms of the index metadata file. The simple form is a list of each file relative to the root URL location. This index file can include paths to subdirectories under the root URL. The index file must be named "content-index.txt" unless overridden by the content source's configuration setting. The metadata stored in this simple index file describes the packages. Each line in the simple index file must be a single filename, followed by the MD5 of the files:

 release-v1.0.zip|abe347586edbc6723461253457687bef
 release-v2.0.zip|456834fed6edb3452346125345768723d
 patches/patch-123.jar|56bc47586e5456edfb6a2534e7687345
 patches/patch-4567.jar|dcb567886eabc6723461253457687bef
 

Note that this is a very inefficient type of content source because of the lack of metadata. Because the only thing we know is the URL to a piece of content and nothing else, the only way to determine things like version number is to possible download the content to scan it. The other index file supported is an XML file that contains the full set of metadata needed to fully define a package. Its XML file has a schema - look at the schema for the full syntax. Subclasses can override this class if they want to support more full-featured metadata (for example, an RSS feed found at the index URL). The index file can be specified as a full URL - if it is not, it will be assumed relative to the root URL.

Author:

John Mazzitelli

Constructor Summary

UrlProvider()

Method Summary

protected ContentProviderPackageDetails	createPackage(RemotePackageInfo rpi) Created the package details given the remote package information.
protected RemotePackageInfo.SupportedPackageType	determinePackageType(RemotePackageInfo rpi)
protected ContentProviderPackageDetails	findPackage(List<ContentProviderPackageDetails> packages, ContentProviderPackageDetails pkg)
protected InputStream	getIndexInputStream() Returns the stream that contains the index file content.
protected URL	getIndexUrl()
InputStream	getInputStream(String location)
protected Map<String,RemotePackageInfo>	getRemotePackageInfosFromIndex() Returns info on all the files listed in the index file.
protected URL	getRootUrl()
protected String	getRootUrlString() Returns a stringified version of root URL that is used to build a full URL to content.
protected Map<String,RemotePackageInfo.SupportedPackageType>	getSupportedPackageTypes()
SyncProgressWeight	getSyncProgressWeight()
void	initialize(Configuration configuration)
protected void	initializePackageTypes(Configuration config)
protected void	setIndexUrl(URL indexURL)
protected void	setRootUrl(URL url)
protected void	setSupportedPackageTypes(Map<String,RemotePackageInfo.SupportedPackageType> supportedPackageTypes)
void	shutdown()
void	synchronizePackages(String repoName, PackageSyncReport report, Collection<ContentProviderPackageDetails> existingPackages)
protected void	syncPackage(PackageSyncReport report, List<ContentProviderPackageDetails> packages, RemotePackageInfo rpi) Builds up the report of packages by adding to it the content that is being processed.
void	testConnection()

Methods inherited from class java.lang.Object

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

Constructor Detail

UrlProvider

public UrlProvider()

Method Detail

getRootUrlString

protected String getRootUrlString()

Returns a stringified version of root URL that is used to build a full URL to content. This will be ensured to end with a "/".

Returns:

root URL string that ends with a trailing "/".

getRootUrl

protected URL getRootUrl()

setRootUrl

protected void setRootUrl(URL url)

getIndexUrl

protected URL getIndexUrl()

setIndexUrl

protected void setIndexUrl(URL indexURL)

getSupportedPackageTypes

protected Map<String,RemotePackageInfo.SupportedPackageType> getSupportedPackageTypes()

setSupportedPackageTypes

protected void setSupportedPackageTypes(Map<String,RemotePackageInfo.SupportedPackageType> supportedPackageTypes)

initialize

public void initialize(Configuration configuration)
                throws Exception

Specified by:

initialize in interface ContentProvider

Throws:

Exception

shutdown

public void shutdown()

Specified by:

shutdown in interface ContentProvider

synchronizePackages

public void synchronizePackages(String repoName,
                                PackageSyncReport report,
                                Collection<ContentProviderPackageDetails> existingPackages)
                         throws SyncException

Specified by:

synchronizePackages in interface PackageSource

Throws:

SyncException

testConnection

public void testConnection()
                    throws Exception

Specified by:

testConnection in interface ContentProvider

Throws:

Exception

getInputStream

public InputStream getInputStream(String location)
                           throws Exception

Specified by:

getInputStream in interface PackageSource

Throws:

Exception

getIndexInputStream

protected InputStream getIndexInputStream()
                                   throws Exception

Returns the stream that contains the index file content.

Returns:

index file content stream

Throws:

Exception

getRemotePackageInfosFromIndex

protected Map<String,RemotePackageInfo> getRemotePackageInfosFromIndex()
                                                                throws Exception

Returns info on all the files listed in the index file.

Returns:

map of Strings/Infos, where each string is the location relative to the root URL. Each string in the map keys is guaranteed not to have a leading slash.

Throws:

Exception - if the index file is missing or cannot be processed

syncPackage

protected void syncPackage(PackageSyncReport report,
                           List<ContentProviderPackageDetails> packages,
                           RemotePackageInfo rpi)
                    throws Exception

Builds up the report of packages by adding to it the content that is being processed. As content is found, their associated packages are removed from packages if they exist leaving only packages remaining that do not exist on the remote system.

Parameters:

report - the report that we are building up

packages - existing packages not yet found on the remote system but exist in server inventory

rpi - information about the package that needs to be synced

Throws:

Exception - if the sync fails

createPackage

protected ContentProviderPackageDetails createPackage(RemotePackageInfo rpi)
                                               throws Exception

Created the package details given the remote package information.

Parameters:

rpi - information about the remote package

Returns:

the full details about the package

Throws:

Exception

findPackage

protected ContentProviderPackageDetails findPackage(List<ContentProviderPackageDetails> packages,
                                                    ContentProviderPackageDetails pkg)

initializePackageTypes

protected void initializePackageTypes(Configuration config)

determinePackageType

protected RemotePackageInfo.SupportedPackageType determinePackageType(RemotePackageInfo rpi)

getSyncProgressWeight

public SyncProgressWeight getSyncProgressWeight()

Specified by:

getSyncProgressWeight in interface ContentProvider