Package jenkins.plugins.openstack.compute

Class JCloudsCloud

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.Actionable

hudson.slaves.Cloud

jenkins.plugins.openstack.compute.JCloudsCloud

All Implemented Interfaces:

ExtensionPoint, Describable<Cloud>, ModelObject, SearchableModelObject, SearchItem, AccessControlled, ModelObjectWithContextMenu, SlaveOptions.Holder

public class JCloudsCloud
extends Cloud
implements SlaveOptions.Holder

The JClouds version of the Jenkins Cloud.

Author:

Vijay Kiran

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JCloudsCloud.DescriptorImpl
static final class	JCloudsCloud.LoginFailure
static final class	JCloudsCloud.ProvisioningFailedException	The request to provision was not fulfilled.

Nested classes/interfaces inherited from class hudson.slaves.Cloud

Cloud.CloudState

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface jenkins.model.ModelObjectWithContextMenu

ModelObjectWithContextMenu.ContextMenu, ModelObjectWithContextMenu.ContextMenuVisibility, ModelObjectWithContextMenu.MenuItem, ModelObjectWithContextMenu.MenuItemType

Field Summary

Fields inherited from class hudson.slaves.Cloud

ALL, name, PROVISION

Constructor Summary

Constructors

Constructor	Description
JCloudsCloud(String name, String endPointUrl, boolean ignoreSsl, String zone, long cleanfreq, SlaveOptions slaveOptions, List<JCloudsSlaveTemplate> templates, String credentialsId)

Method Summary

Modifier and Type	Method	Description
boolean	canProvision(Cloud.CloudState cs)
void	doProvision(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, String name)	Provisions a new node manually (by clicking a button in the computer list).
static JCloudsCloud	getByName(String name)
long	getCleanfreq()
long	getCleanfreqToMillis()
static List<JCloudsCloud>	getClouds()
String	getCredentialsId()
SlaveOptions	getEffectiveSlaveOptions()	Get effective options declared by this object.
String	getEndPointUrl()
boolean	getIgnoreSsl()
long	getLastCleanTime()
Openstack	getOpenstack()	Get connected OpenStack client wrapper.
SlaveOptions	getRawSlaveOptions()	Get configured options held by this object.
JCloudsSlaveTemplate	getTemplate(String name)
List<JCloudsSlaveTemplate>	getTemplates()
String	getZone()
Collection<NodeProvisioner.PlannedNode>	provision(Cloud.CloudState cs, int excessWorkload)
void	setCleanfreq(long cleanfreq)
void	setLastCleanTime(long timeMillis)
String	slaveIsWaitingFor(JCloudsSlave slave)
String	toString()

Methods inherited from class hudson.slaves.Cloud

all, canProvision, doConfigSubmit, doDoDelete, getACL, getDescriptor, getDisplayName, getIcon, getIconAltText, getIconClassName, getSearchUrl, getUrl, provision, reconfigure, reconfigure, registerPermissions

Methods inherited from class hudson.model.Actionable

addAction, addOrReplaceAction, doContextMenu, doContextMenu, getAction, getAction, getActions, getActions, getAllActions, getDynamic, getDynamic, removeAction, removeActions, replaceAction, replaceActions

Methods inherited from class hudson.model.AbstractModelObject

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.security.AccessControlled

checkAnyPermission, checkPermission, hasAnyPermission, hasPermission, hasPermission, hasPermission2

Methods inherited from interface hudson.search.SearchItem

getSearchGroup, getSearchIcon

Constructor Details

JCloudsCloud

@DataBoundConstructor
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
public JCloudsCloud(@Nonnull
 String name,
 @Nonnull
 String endPointUrl,
 boolean ignoreSsl,
 @CheckForNull
 String zone,
 long cleanfreq,
 @CheckForNull
 SlaveOptions slaveOptions,
 @CheckForNull
 List<JCloudsSlaveTemplate> templates,
 @Nonnull
 String credentialsId)

Method Details

getClouds

@Nonnull
public static List<JCloudsCloud> getClouds()

getByName

@Nonnull
public static JCloudsCloud getByName(@Nonnull
 String name)
                              throws IllegalArgumentException

Throws:

IllegalArgumentException - If the OpenStack cloud with given name does not exist.

getEffectiveSlaveOptions

@Nonnull
public SlaveOptions getEffectiveSlaveOptions()

Description copied from interface: SlaveOptions.Holder

Get effective options declared by this object. This is supposed to correctly evaluate all the overriding.

Specified by:

getEffectiveSlaveOptions in interface SlaveOptions.Holder

getRawSlaveOptions

@Nonnull
public SlaveOptions getRawSlaveOptions()

Description copied from interface: SlaveOptions.Holder

Get configured options held by this object. This holds only the user configured diffs compared to parent.

Specified by:

getRawSlaveOptions in interface SlaveOptions.Holder

getTemplates

@Nonnull
public List<JCloudsSlaveTemplate> getTemplates()

getEndPointUrl

@Nonnull
public String getEndPointUrl()

getZone

@CheckForNull
public String getZone()

setLastCleanTime

public void setLastCleanTime(long timeMillis)

getLastCleanTime

public long getLastCleanTime()

getCleanfreq

@CheckForNull
public long getCleanfreq()

getCleanfreqToMillis

@CheckForNull
public long getCleanfreqToMillis()

setCleanfreq

@DataBoundSetter
public void setCleanfreq(@Nonnull
 long cleanfreq)

provision

public Collection<NodeProvisioner.PlannedNode> provision(Cloud.CloudState cs,
 int excessWorkload)

Overrides:

provision in class Cloud

slaveIsWaitingFor

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
@CheckForNull
public String slaveIsWaitingFor(@Nonnull
 JCloudsSlave slave)
                         throws JCloudsCloud.ProvisioningFailedException

Throws:

JCloudsCloud.ProvisioningFailedException

canProvision

public boolean canProvision(Cloud.CloudState cs)

Overrides:

canProvision in class Cloud

getTemplate

@CheckForNull
public JCloudsSlaveTemplate getTemplate(String name)

doProvision

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public void doProvision(org.kohsuke.stapler.StaplerRequest req,
 org.kohsuke.stapler.StaplerResponse rsp,
 @QueryParameter
 String name)
                 throws IOException

Provisions a new node manually (by clicking a button in the computer list).

Parameters:

req - StaplerRequest

rsp - StaplerResponse

name - Name of the template to provision

Throws:

IOException

getOpenstack

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
@Nonnull
public Openstack getOpenstack()
                       throws JCloudsCloud.LoginFailure

Get connected OpenStack client wrapper.

Throws:

JCloudsCloud.LoginFailure - In case the details are incomplete or rejected by OpenStack.

getCredentialsId

public String getCredentialsId()

getIgnoreSsl

@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
public boolean getIgnoreSsl()

toString

public String toString()

Overrides:

toString in class Object