com.redhat.foreman

Class ForemanAPI

java.lang.Object

com.redhat.foreman.ForemanAPI

public class ForemanAPI
extends Object

Foreman API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ForemanAPI.ActionFailed Action or query performed by the library has failed.
static class	ForemanAPI.CommunicationError Problem while talking to Foreman.
static class	ForemanAPI.ProtocolMismatch Library does not comprehend Foreman reply.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getAllReservedHosts() Get the list of all already reserved hosts from Foreman for this Jenkins.
HostInfo	getHostInfo(String hostname) Get host info.
String	getVersion() Get Foreman version.
void	release(String hostName) Release host from Foreman.
HostInfo	reserveHost(HostInfo host) 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 HostInfo reserveHost(HostInfo host)
                     throws Exception

Reserve host outright.

Returns:

Updated HostInfo representing reserved host.

Throws:

Exception

release

public void release(@Nonnull
           String hostName)
             throws ForemanAPI.ActionFailed

Release host from Foreman.

Parameters:

hostName - name of host to release.

Throws:

ForemanAPI.ActionFailed

getVersion

@Nonnull
public String getVersion()
                  throws ForemanAPI.ActionFailed

Get Foreman version.

Returns:

version string.

Throws:

ForemanAPI.ActionFailed

getHostInfo

@CheckForNull
public HostInfo getHostInfo(@Nonnull
                                String hostname)
                     throws ForemanAPI.ActionFailed

Get host info.

Returns:

HostInfo of or null in case foreman does no longer have this host configured.

Throws:

ForemanAPI.ActionFailed

getAllReservedHosts

@Nonnull
public List<String> getAllReservedHosts()
                                 throws Exception

Get the list of all already reserved hosts from Foreman for this Jenkins.

Returns:

list of all reserved hosts.

Throws:

Exception - if occurs.