com.thoughtworks.go.plugin.api.material.packagerepository

Interface PackageMaterialPoller

public interface PackageMaterialPoller

PackageMaterialPoller encapsulates all methods which are required to communicate with package repository.

Method Summary

Modifier and Type	Method and Description
Result	checkConnectionToPackage(PackageConfiguration packageConfiguration, RepositoryConfiguration repositoryConfiguration) Checks if the package with the given configuration is available in the repository.
Result	checkConnectionToRepository(RepositoryConfiguration repositoryConfiguration) Checks if the repository with the given configuration is accessible.
PackageRevision	getLatestRevision(PackageConfiguration packageConfiguration, RepositoryConfiguration repositoryConfiguration) Gets the latest modification for the given package and repository configuration
PackageRevision	latestModificationSince(PackageConfiguration packageConfiguration, RepositoryConfiguration repositoryConfiguration, PackageRevision previouslyKnownRevision) Gets the latest modification for the given package and repository configuration since later than the last known revision by GO.

Method Detail

getLatestRevision

PackageRevision getLatestRevision(PackageConfiguration packageConfiguration,
                                  RepositoryConfiguration repositoryConfiguration)

Gets the latest modification for the given package and repository configuration

Parameters:

packageConfiguration - package configuration for which latest modification should be fetched

repositoryConfiguration - repository configuration which contains package configuration

Returns:

PackageRevision for the latest modification

latestModificationSince

PackageRevision latestModificationSince(PackageConfiguration packageConfiguration,
                                        RepositoryConfiguration repositoryConfiguration,
                                        PackageRevision previouslyKnownRevision)

Gets the latest modification for the given package and repository configuration since later than the last known revision by GO.

Parameters:

packageConfiguration - package configuration for which latest modification should be fetched

repositoryConfiguration - repository configuration which contains package configuration

previouslyKnownRevision - last known revision by GO

Returns:

PackageRevision for the modification since last known revision by GO

checkConnectionToRepository

Result checkConnectionToRepository(RepositoryConfiguration repositoryConfiguration)

Checks if the repository with the given configuration is accessible.

Parameters:

repositoryConfiguration - repository configuration for which connectivity should be checked

Returns:

Result of connection check

checkConnectionToPackage

Result checkConnectionToPackage(PackageConfiguration packageConfiguration,
                                RepositoryConfiguration repositoryConfiguration)

Checks if the package with the given configuration is available in the repository.

Parameters:

packageConfiguration - package configuration for which connectivity should be checked

repositoryConfiguration - repository configuration which contains package configuration

Returns:

Result of connection check