org.jenkinsci.plugins.cloudstats

Class CloudStatistics.ProvisioningListener

java.lang.Object

hudson.slaves.CloudProvisioningListener

org.jenkinsci.plugins.cloudstats.CloudStatistics.ProvisioningListener

All Implemented Interfaces:

hudson.ExtensionPoint

Enclosing class:

CloudStatistics

@Extension
public static class CloudStatistics.ProvisioningListener
extends hudson.slaves.CloudProvisioningListener

Listen to ongoing provisioning activities. All activities that are triggered by Jenkins queue load (those that goes through NodeProvisioner) are reported by Jenkins core. This api needs to be called by plugin if and only if the slaves are provisioned differently.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
CloudStatistics.ProvisioningListener()

Method Summary

Methods

Modifier and Type	Method and Description
static CloudStatistics.ProvisioningListener	get()
void	onComplete(hudson.slaves.NodeProvisioner.PlannedNode plannedNode, hudson.model.Node node)
ProvisioningActivity	onComplete(ProvisioningActivity.Id id, hudson.model.Node node) Inform plugin provisioning has completed.
void	onFailure(hudson.slaves.NodeProvisioner.PlannedNode plannedNode, Throwable t)
ProvisioningActivity	onFailure(ProvisioningActivity.Id id, Throwable throwable) Inform plugin provisioning has failed.
void	onStarted(hudson.slaves.Cloud cloud, hudson.model.Label label, Collection<hudson.slaves.NodeProvisioner.PlannedNode> plannedNodes)
ProvisioningActivity	onStarted(ProvisioningActivity.Id id) Inform plugin provisioning has started.

Methods inherited from class hudson.slaves.CloudProvisioningListener

all, canProvision

Methods inherited from class java.lang.Object

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

Constructor Detail

CloudStatistics.ProvisioningListener

public CloudStatistics.ProvisioningListener()

Method Detail

onStarted

@Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class)
public void onStarted(hudson.slaves.Cloud cloud,
                                                                      hudson.model.Label label,
                                                                      Collection<hudson.slaves.NodeProvisioner.PlannedNode> plannedNodes)

Overrides:

onStarted in class hudson.slaves.CloudProvisioningListener

onStarted

@Nonnull
public ProvisioningActivity onStarted(@Nonnull
                                     ProvisioningActivity.Id id)

Inform plugin provisioning has started. This is only needed when provisioned outside NodeProvisioner.

Parameters:

id - Unique identifier of the activity. The plugin is responsible for this to be unique and all subsequent calls are identified by the same Id instance.

onComplete

@Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class)
public void onComplete(hudson.slaves.NodeProvisioner.PlannedNode plannedNode,
                                                                       hudson.model.Node node)

Overrides:

onComplete in class hudson.slaves.CloudProvisioningListener

onComplete

@CheckForNull
public ProvisioningActivity onComplete(@Nonnull
                                           ProvisioningActivity.Id id,
                                           @Nonnull
                                           hudson.model.Node node)

Inform plugin provisioning has completed. This is only needed when provisioned outside NodeProvisioner. The method should be called before the node is added to Jenkins.

onFailure

@Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class)
public void onFailure(hudson.slaves.NodeProvisioner.PlannedNode plannedNode,
                                                                      Throwable t)

Overrides:

onFailure in class hudson.slaves.CloudProvisioningListener

onFailure

@CheckForNull
public ProvisioningActivity onFailure(@Nonnull
                                          ProvisioningActivity.Id id,
                                          @Nonnull
                                          Throwable throwable)

Inform plugin provisioning has failed. This is only needed when provisioned outside NodeProvisioner. No node with id should be added added to jenkins.

get

public static CloudStatistics.ProvisioningListener get()