com.inedo.proget.api

Class ProGetApi

java.lang.Object

com.inedo.proget.api.ProGetApi

All Implemented Interfaces:

java.io.Serializable

public class ProGetApi
extends java.lang.Object
implements java.io.Serializable

BuildMaster json api interface TODO I think some of these can be moved to universal api now... https://inedo.com/support/documentation/proget/reference/api/native https://inedo.com/support/documentation/proget/reference/universal-feed-api-and-package-format

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ProGetApi(JenkinsLogWriter listener)
ProGetApi(ProGetConfig config, JenkinsLogWriter logWriter)

Method Summary

Modifier and Type	Method and Description
void	canConnect() Check that can connect to ProGet, and check the apiKey if configured.
java.io.File	downloadPackage(java.lang.String feedName, java.lang.String groupName, java.lang.String packageName, java.lang.String version, java.lang.String toFolder, DownloadFormat downloadFormat)
Feed	getFeed(java.lang.String feedName) Gets the details of a feed by its name
Feed[]	getFeeds() Get all active feeds
java.lang.String	getJsonString()
ProGetPackage[]	getPackages(java.lang.String feedId) Gets the packages in a ProGet feed
ProGetPackage[]	getPackages(java.lang.String feedId, java.lang.String groupName) Gets the packages in a ProGet feed
PackageVersion[]	getPackageVersions(java.lang.String feedId, java.lang.String groupName, java.lang.String packageName) Gets the package versions in a ProGet feed
java.lang.String	getVersion()
void	ping() Ensure can ping an endpointGet.
void	setRecordJson(boolean record)
void	uploadPackage(java.lang.String feedName, java.io.File progetPackage)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProGetApi

public ProGetApi(JenkinsLogWriter listener)

ProGetApi

public ProGetApi(ProGetConfig config,
                 JenkinsLogWriter logWriter)

Method Detail

setRecordJson

public void setRecordJson(boolean record)

getJsonString

public java.lang.String getJsonString()

canConnect

public void canConnect()
                throws java.io.IOException

Check that can connect to ProGet, and check the apiKey if configured.

Throws:

java.io.IOException - If cannot connect

ping

public void ping()
          throws java.io.IOException

Ensure can ping an endpointGet.

Throws:

java.io.IOException - If cannot connect

getVersion

public java.lang.String getVersion()
                            throws java.io.IOException

Throws:

java.io.IOException

getFeeds

public Feed[] getFeeds()
                throws java.io.IOException

Get all active feeds

Throws:

java.io.IOException

getFeed

public Feed getFeed(java.lang.String feedName)
             throws java.io.IOException

Gets the details of a feed by its name

Throws:

java.io.IOException

getPackages

public ProGetPackage[] getPackages(java.lang.String feedId)
                            throws java.io.IOException

Gets the packages in a ProGet feed

Throws:

java.io.IOException

getPackages

public ProGetPackage[] getPackages(java.lang.String feedId,
                                   java.lang.String groupName)
                            throws java.io.IOException

Gets the packages in a ProGet feed

Throws:

java.io.IOException

getPackageVersions

public PackageVersion[] getPackageVersions(java.lang.String feedId,
                                           java.lang.String groupName,
                                           java.lang.String packageName)
                                    throws java.io.IOException

Gets the package versions in a ProGet feed

Throws:

java.io.IOException

downloadPackage

public java.io.File downloadPackage(java.lang.String feedName,
                                    java.lang.String groupName,
                                    java.lang.String packageName,
                                    java.lang.String version,
                                    java.lang.String toFolder,
                                    DownloadFormat downloadFormat)
                             throws java.io.IOException

Parameters:

feedName - Required

groupName - Required

packageName - Required

version - Optional - empty string returns latest version

toFolder - Folder to save file to

downloadFormat -

Returns:

Reference to downloaded file

Throws:

java.io.IOException

uploadPackage

public void uploadPackage(java.lang.String feedName,
                          java.io.File progetPackage)
                   throws java.io.IOException

Throws:

java.io.IOException