org.rhq.enterprise.server.plugin.pc.content
Interface DistributionSource

public interface DistributionSource

Indicates a content provider has the capability to provide distributions into the server. Distribution synchronization will be done through the calls defined in this interface.

Author:

Pradeep Kilambi

Method Summary

java.lang.String	getDistFileRemoteLocation(java.lang.String repoName, java.lang.String label, java.lang.String relativeFilename)
java.io.InputStream	getInputStream(java.lang.String location) Get an input stream for the specified distribution.
void	synchronizeDistribution(java.lang.String repoName, DistributionSyncReport report, java.util.Collection<DistributionDetails> existingDistros) Requests that this distribution source perform a synchronization with its external repository.

Method Detail

synchronizeDistribution

void synchronizeDistribution(java.lang.String repoName,
                             DistributionSyncReport report,
                             java.util.Collection<DistributionDetails> existingDistros)
                             throws java.lang.Exception

Requests that this distribution source perform a synchronization with its external repository.

Parameters:

repoName - repo name used to look up distributions

report - used to accumulate the collection of distros

Throws:

java.lang.Exception - if the source is unable to perform the synchronization, for instance if the external source cannot be connected to.

getInputStream

java.io.InputStream getInputStream(java.lang.String location)
                                   throws java.lang.Exception

Get an input stream for the specified distribution.

Parameters:

location - The location of the distribution.

Returns:

An initialized input stream. The caller is responsible for closing the stream.

Throws:

java.lang.Exception - if failed to obtain the stream to the remote distribution data

getDistFileRemoteLocation

java.lang.String getDistFileRemoteLocation(java.lang.String repoName,
                                           java.lang.String label,
                                           java.lang.String relativeFilename)

Parameters:

repoName - Name of repository

label - Distribution Label

relativeFilename - relative path of file to fetch

Returns:

a remote location that can be passed into getInputStream to fetch a file from this source.