org.jenkinsci.plugins.koji.xmlrpc

Class KojiClient

java.lang.Object

org.jenkinsci.plugins.koji.xmlrpc.KojiClient

public class KojiClient
extends Object

Singleton used for XML-RPC communication with Koji.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getBuildInfo(String buildId) Retrieves information about a given build.
static KojiClient	getKojiClient(String kojiInstanceURL) Get the KojiClient Singleton instance.
String	getKojiInstanceURL()
Map<String,String>	getLatestBuilds(String tag, String pkg) Gets latest builds.
String	getSession() Gets information about logged user.
List<Map<String,String>>	listTaggedBuilds(org.jenkinsci.plugins.koji.xmlrpc.KojiClient.BuildParams buildParams) Method for detailed queries.
KojiSession	login(String userName, String password) Login to XML-RPC service using plain authentication.
String	sayHello() Greet the remote Koji instance and test the communication.
void	setDebug(boolean debug)
void	setServerURL(String kojiInstanceURL)

Methods inherited from class java.lang.Object

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

Method Detail

getKojiInstanceURL

public String getKojiInstanceURL()

getKojiClient

public static KojiClient getKojiClient(String kojiInstanceURL)
                                throws MalformedURLException

Get the KojiClient Singleton instance. If user changes global config with Koji Hub URL, it's eventually modified here.

Parameters:

kojiInstanceURL - URL of remote Koji instance.

Throws:

MalformedURLException

login

public KojiSession login(String userName,
                         String password)
                  throws org.apache.xmlrpc.XmlRpcException

Login to XML-RPC service using plain authentication. This authentication is the only supported via Koji XML-RPC API.

Parameters:

userName - Username

password - Password

Returns:

KojiSession.

Throws:

org.apache.xmlrpc.XmlRpcException - In case issue with login happens.

getLatestBuilds

public Map<String,String> getLatestBuilds(String tag,
                                          String pkg)
                                   throws org.apache.xmlrpc.XmlRpcException

Gets latest builds.

Parameters:

tag - Koji tag

pkg - Koji package

Returns:

Map of properties for latest build.

Throws:

org.apache.xmlrpc.XmlRpcException

getBuildInfo

public Map<String,String> getBuildInfo(String buildId)
                                throws org.apache.xmlrpc.XmlRpcException

Retrieves information about a given build.

Parameters:

buildId - BuildId can be Name-Version-Release (NVR) or numeric buildId.

Returns:

A map containing all information about given build.

Throws:

org.apache.xmlrpc.XmlRpcException

getSession

public String getSession()

Gets information about logged user.

Returns:

Session identification.

listTaggedBuilds

public List<Map<String,String>> listTaggedBuilds(org.jenkinsci.plugins.koji.xmlrpc.KojiClient.BuildParams buildParams)
                                          throws org.apache.xmlrpc.XmlRpcException

Method for detailed queries.

Parameters:

buildParams - Accepts BuildParams object holding various properties.

Throws:

org.apache.xmlrpc.XmlRpcException

sayHello

public String sayHello()

Greet the remote Koji instance and test the communication.

Returns:

setServerURL

public void setServerURL(String kojiInstanceURL)

setDebug

public void setDebug(boolean debug)