com.redhat.foreman

Class ForemanAPI

java.lang.Object

com.redhat.foreman.ForemanAPI

public class ForemanAPI
extends Object

Foreman API.

Constructor Summary

Constructors

Constructor and Description
ForemanAPI(String url, String user, hudson.util.Secret password) Foreman API Constructor.

Method Summary

Modifier and Type	Method and Description
String	getHostAttributeValue(String hostname, String attribute) Get value for host attribute.
String	getHostParameterValue(String hostname, String parameterName) General utility method to get parameter value for host.
String	getIPForHost(String hostname) Get IP for Host.
String	getLabelsForHost(String hostName) Get Host's Jenkins labels.
String	getRemoteFSForSlave(String hostname) Get Jenkins Slave Remote FS root.
String	getVersion() Get Foreman version.
boolean	isHostFree(String hostName) Determine if a host is reserved.
boolean	isHostReservedByUs(String hostName) Determine if a host is reserved for current Jenkins instance
void	release(String hostName) Release host from Foreman.
com.fasterxml.jackson.databind.JsonNode	reserveHost(String hostname) Reserve host outright.

Methods inherited from class java.lang.Object

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

Constructor Detail

ForemanAPI

public ForemanAPI(String url,
                  String user,
                  hudson.util.Secret password)

Foreman API Constructor.

Parameters:

url - foreman url.

user - user.

password - password.

Method Detail

reserveHost

@CheckForNull
public com.fasterxml.jackson.databind.JsonNode reserveHost(String hostname)
                                                                  throws Exception

Reserve host outright.

Parameters:

hostname - resource in Foreman.

Returns:

host in json form.

Throws:

Exception

release

public void release(String hostName)
             throws Exception

Release host from Foreman.

Parameters:

hostName - name of host to release.

Throws:

Exception - if occurs.

getVersion

@CheckForNull
public String getVersion()
                                throws Exception

Get Foreman version.

Returns:

version.

Throws:

Exception - if occurs.

getHostParameterValue

@CheckForNull
public String getHostParameterValue(String hostname,
                                                  String parameterName)
                                           throws Exception

General utility method to get parameter value for host.

Parameters:

hostname - name of host.

parameterName - name of param.

Returns:

value.

Throws:

Exception - if occurs.

getRemoteFSForSlave

@CheckForNull
public String getRemoteFSForSlave(String hostname)
                                         throws Exception

Get Jenkins Slave Remote FS root.

Parameters:

hostname - name of host.

Returns:

value of slave remote FS root.

Throws:

Exception - if occurs.

getHostAttributeValue

@CheckForNull
public String getHostAttributeValue(String hostname,
                                                  String attribute)

Get value for host attribute.

Parameters:

hostname - name of host.

attribute - attrib to look for.

Returns:

value of attrib.

getIPForHost

@CheckForNull
public String getIPForHost(String hostname)

Get IP for Host.

Parameters:

hostname - name of host.

Returns:

IP.

getLabelsForHost

public String getLabelsForHost(String hostName)
                        throws Exception

Get Host's Jenkins labels.

Parameters:

hostName - name of host.

Returns:

value of label parameter.

Throws:

Exception - if occurs.

isHostFree

public boolean isHostFree(String hostName)
                   throws Exception

Determine if a host is reserved.

Parameters:

hostName - name of host in Foreman.

Returns:

true if not reserved.

Throws:

Exception - if occurs.

isHostReservedByUs

public boolean isHostReservedByUs(String hostName)
                           throws Exception

Determine if a host is reserved for current Jenkins instance

Parameters:

hostName - name of the host in Foreman

Returns:

true if reserved for us

Throws:

Exception - if occurs