com.redhat.jenkins.nodesharingbackend

Class Api

java.lang.Object

com.redhat.jenkins.nodesharingbackend.Api

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Action, hudson.model.ModelObject, hudson.model.RootAction

@Extension
 @Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public class Api
extends Object
implements hudson.model.RootAction

Receive and send REST commands from/to executor Jenkinses.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
Api()

Method Summary

Modifier and Type	Method and Description
void	doDiscover(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) Initial request to test the connection/compatibility.
void	doReportWorkload(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) Report workload to be executed on orchestrator for particular executor master.
void	doReturnNode(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) Return node to orchestrator when no longer needed.
String	getDisplayName()
String	getIconFileName()
static Api	getInstance()
String	getUrlName()
Boolean	isUtilized(ExecutorJenkins owner, ShareableNode node) Determine whether the host is still used by particular executor.
NodeStatusResponse.Status	nodeStatus(ExecutorJenkins jenkins, String nodeName)
ReportUsageResponse	reportUsage(ExecutorJenkins owner) Query executor Jenkins to report shared hosts it uses.
boolean	utilizeNode(ExecutorJenkins executor, ShareableNode node) Signal to Executor Jenkins to start using particular node.

Methods inherited from class java.lang.Object

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

Constructor Detail

Api

public Api()

Method Detail

getInstance

@Nonnull
public static Api getInstance()

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface hudson.model.Action

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface hudson.model.Action

Specified by:

getDisplayName in interface hudson.model.ModelObject

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface hudson.model.Action

utilizeNode

public boolean utilizeNode(@Nonnull
                           ExecutorJenkins executor,
                           @Nonnull
                           ShareableNode node)

Signal to Executor Jenkins to start using particular node.

Parameters:

executor - Jenkins instance the node is reserved for.

node - Node to be reserved.

Returns:

true is the client accepted the node, false otherwise.

reportUsage

@Nonnull
public ReportUsageResponse reportUsage(@Nonnull
                                                ExecutorJenkins owner)

Query executor Jenkins to report shared hosts it uses. It should be the Orchestrator who has an authority to say that but this is to query executor's view of things. Most useful when Orchestrator boots after crash with all the reservation info possibly lost or outdated.

Parameters:

owner - Jenkins instance to query.

isUtilized

public Boolean isUtilized(@Nonnull
                          ExecutorJenkins owner,
                          @Nonnull
                          ShareableNode node)

Determine whether the host is still used by particular executor. Ideally, the host is utilized between utilizeNode(ExecutorJenkins, ShareableNode) was send and doReturnNode(StaplerRequest, StaplerResponse) was received but in case of any of the requests failed to be delivered for some reason, there is this way to recheck. Note this has to recognise Jenkins was stopped or plugin was uninstalled so we can not rely on node-sharing API on Executor end.

Parameters:

owner - Jenkins instance to query.

node - The node to query.

Returns:

true if the computer is still connected there, false if we know it is not, null otherwise.

nodeStatus

@Nonnull
public NodeStatusResponse.Status nodeStatus(@Nonnull
                                                     ExecutorJenkins jenkins,
                                                     @Nonnull
                                                     String nodeName)

doDiscover

public void doDiscover(org.kohsuke.stapler.StaplerRequest req,
                       org.kohsuke.stapler.StaplerResponse rsp)
                throws IOException

Initial request to test the connection/compatibility.

Throws:

IOException

doReportWorkload

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

Report workload to be executed on orchestrator for particular executor master. The order of items from orchestrator is preserved though not guaranteed to be exactly the same as the builds ware scheduled on individual executor Jenkinses.

Throws:

IOException

doReturnNode

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

Return node to orchestrator when no longer needed.

Throws:

IOException