com.redhat.jenkins.nodesharingfrontend

Class SharedNodeCloud

java.lang.Object

hudson.model.AbstractModelObject

hudson.slaves.Cloud

com.redhat.jenkins.nodesharingfrontend.SharedNodeCloud

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.slaves.Cloud>, hudson.model.ModelObject, hudson.search.SearchableModelObject, hudson.search.SearchItem, hudson.security.AccessControlled

public class SharedNodeCloud
extends hudson.slaves.Cloud

Shared Node Cloud implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SharedNodeCloud.ConfigRepoUpdater
static class	SharedNodeCloud.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	isWsCleanupAvailable

Fields inherited from class hudson.slaves.Cloud

ALL, name, PROVISION

Constructor Summary

Constructors

Constructor and Description
SharedNodeCloud(String configRepoUrl, String orchestratorCredentialsId) Constructor for Config Page.
SharedNodeCloud(String configRepoUrl, String orchestratorCredentialsId, boolean disabled) Constructor for Config Page.

Method Summary

Modifier and Type	Method and Description
boolean	canProvision(hudson.model.Label label)
SharedNode	createNode(NodeDefinition definition)
boolean	disabled(boolean disabled) Set temporary disabled status to the new state.
static Collection<SharedNodeCloud>	getAll() Get all configured SharedNodeClouds.
Api	getApi() Get associated API object.
static SharedNodeCloud	getByName(String name) Get Shared node cloud using provided name.
String	getConfigRepoUrl() Get Config repo url.
ConfigRepo.Snapshot	getLatestConfig() Get latest config repo snapshot.
String	getName() Get Cloud name.
String	getNodeName(String nodeName) Make unique name per Cloud.
NodeStatusResponse.Status	getNodeStatus(String nodeName) Get the node status.
String	getOrchestratorCredentialsId()
boolean	isDisabled() Check whether cloud is temporary disabled.
boolean	isOperational() The cloud is considered operational once it can get data from Config Repo and talk to orchestrator.
Collection<hudson.slaves.NodeProvisioner.PlannedNode>	provision(hudson.model.Label label, int excessWorkload)

Methods inherited from class hudson.slaves.Cloud

all, checkPermission, getACL, getDescriptor, getDisplayName, getSearchUrl, hasPermission

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, getSearchName, makeSearchIndex, requirePOST, sendError, sendError, sendError, sendError, sendError

Methods inherited from class java.lang.Object

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

Field Detail

isWsCleanupAvailable

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static boolean isWsCleanupAvailable

Constructor Detail

SharedNodeCloud

public SharedNodeCloud(@Nonnull
                       String configRepoUrl,
                       @Nonnull
                       String orchestratorCredentialsId)

Constructor for Config Page.

Parameters:

configRepoUrl - ConfigRepo url

orchestratorCredentialsId - Orchestrator credential.

SharedNodeCloud

@DataBoundConstructor
public SharedNodeCloud(@Nonnull
                                             String configRepoUrl,
                                             @Nonnull
                                             String orchestratorCredentialsId,
                                             boolean disabled)

Constructor for Config Page.

Parameters:

configRepoUrl - ConfigRepo url

orchestratorCredentialsId - Orchestrator credential.

disabled - true if cloud is disabled temporary.

Method Detail

getApi

@Nonnull
public final Api getApi()
                          throws IllegalStateException

Get associated API object.

Throws:

IllegalStateException - In case cloud is not able to obtain the config.

getName

@Nonnull
public String getName()

Get Cloud name.

Returns:

name.

getConfigRepoUrl

@Nonnull
public String getConfigRepoUrl()

Get Config repo url.

Returns:

configRepoUrl.

getOrchestratorCredentialsId

@Nonnull
public String getOrchestratorCredentialsId()

getLatestConfig

@CheckForNull
public ConfigRepo.Snapshot getLatestConfig()

Get latest config repo snapshot.

Returns:

Snapshot or null when there are problems reading it.

getNodeName

@Nonnull
public String getNodeName(@Nonnull
                                   String nodeName)

Make unique name per Cloud.

Parameters:

nodeName - node name from the config repo.

Returns:

the node name.

getNodeStatus

@Nonnull
public NodeStatusResponse.Status getNodeStatus(@Nonnull
                                                        String nodeName)

Get the node status.

Parameters:

nodeName - The node name.

Returns:

The node status.

createNode

@Nonnull
public SharedNode createNode(@Nonnull
                                      NodeDefinition definition)
                               throws IllegalArgumentException

Throws:

IllegalArgumentException

canProvision

public boolean canProvision(hudson.model.Label label)

Specified by:

canProvision in class hudson.slaves.Cloud

provision

@Nonnull
public Collection<hudson.slaves.NodeProvisioner.PlannedNode> provision(@CheckForNull
                                                                                hudson.model.Label label,
                                                                                int excessWorkload)

Specified by:

provision in class hudson.slaves.Cloud

getByName

@CheckForNull
public static SharedNodeCloud getByName(@Nonnull
                                                      String name)
                                               throws IllegalArgumentException

Get Shared node cloud using provided name.

Parameters:

name - Cloud name.

Returns:

a Shared node cloud or null if not found.

Throws:

IllegalArgumentException

getAll

@Nonnull
public static Collection<SharedNodeCloud> getAll()

Get all configured SharedNodeClouds.

isOperational

public boolean isOperational()

The cloud is considered operational once it can get data from Config Repo and talk to orchestrator.

isDisabled

public boolean isDisabled()

Check whether cloud is temporary disabled.

Returns:

true if cloud is temporary disabled.

disabled

public boolean disabled(boolean disabled)

Set temporary disabled status to the new state.

Parameters:

disabled - new disabled status.

Returns:

old disabled status.