com.redhat.jenkins.nodesharingfrontend

Class Api

java.lang.Object

com.redhat.jenkins.nodesharingfrontend.Api

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public class Api
extends Object

Receive and send REST commands from/to Orchestrator Jenkins.

Constructor Summary

Constructors

Constructor and Description
Api(ConfigRepo.Snapshot snapshot, String configRepoUrl, SharedNodeCloud cloud, String jenkinsUrl)

Method Summary

Modifier and Type	Method and Description
DiscoverResponse	discover() Request to discover the state of the Orchestrator.
void	doImmediatelyReturnNode() Immediately return node to orchestrator.
void	doNodeStatus(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) Query Executor Jenkins to report the status of shared node.
void	doReportUsage(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
void	doUtilizeNode(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) Request to utilize reserved computer.
void	reportWorkload(ReportWorkloadRequest.Workload workload) Put the queue items to Orchestrator
void	returnNode(SharedNode node) Send request to return node.

Methods inherited from class java.lang.Object

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

Constructor Detail

Api

public Api(@Nonnull
           ConfigRepo.Snapshot snapshot,
           @Nonnull
           String configRepoUrl,
           @Nonnull
           SharedNodeCloud cloud,
           @Nonnull
           String jenkinsUrl)
    throws IllegalStateException

Throws:

IllegalStateException

Method Detail

reportWorkload

public void reportWorkload(@Nonnull
                           ReportWorkloadRequest.Workload workload)

Put the queue items to Orchestrator

discover

@Nonnull
public DiscoverResponse discover()
                                   throws ActionFailed

Request to discover the state of the Orchestrator. Note is is expected this call is made when executor is no longer part of the grid in order to complete existing reservations.

Returns:

Discovery result.

Throws:

ActionFailed

returnNode

public void returnNode(@Nonnull
                       SharedNode node)

Send request to return node. No response needed. Note is is expected this call is made when executor is no longer part of the grid in order to complete existing reservations.

doUtilizeNode

public void doUtilizeNode(@Nonnull
                          org.kohsuke.stapler.StaplerRequest req,
                          @Nonnull
                          org.kohsuke.stapler.StaplerResponse rsp)
                   throws IOException

Request to utilize reserved computer. Response codes: - "200 OK" is used when the node was accepted, the node is expected to be correctly added to Jenkins by the time the request completes with the code. The code is also returned when the node is already helt by this executor. - "410 Gone" when there is no longer the need for such host and orchestrator can reuse it immediately. The node must not be created.

Throws:

IOException

doNodeStatus

public void doNodeStatus(@Nonnull
                         org.kohsuke.stapler.StaplerRequest req,
                         @Nonnull
                         org.kohsuke.stapler.StaplerResponse rsp)
                  throws IOException

Query Executor Jenkins to report the status of shared node.

Throws:

IOException

doReportUsage

public void doReportUsage(@Nonnull
                          org.kohsuke.stapler.StaplerRequest req,
                          @Nonnull
                          org.kohsuke.stapler.StaplerResponse rsp)
                   throws IOException

Throws:

IOException

doImmediatelyReturnNode

public void doImmediatelyReturnNode()

Immediately return node to orchestrator. (Nice to have feature)