org.jenkinsci.plugins.mesos

Class MesosCloud

java.lang.Object

hudson.model.AbstractModelObject

hudson.slaves.Cloud

org.jenkinsci.plugins.mesos.MesosCloud

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 MesosCloud
extends hudson.slaves.Cloud

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MesosCloud.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.slaves.Cloud

ALL, name, PROVISION

Constructor Summary

Constructors

Modifier	Constructor and Description
	MesosCloud(String name, MesosCloud source) Copy constructor.
	MesosCloud(String nativeLibraryPath, String master, String description, String frameworkName, String slavesUser, String principal, String secret, List<MesosSlaveInfo> slaveInfos, boolean checkpoint, boolean onDemandRegistration, String jenkinsURL)
protected	MesosCloud(String cloudName, String nativeLibraryPath, String master, String description, String frameworkName, String slavesUser, String principal, String secret, List<MesosSlaveInfo> slaveInfos, boolean checkpoint, boolean onDemandRegistration, String jenkinsURL) Constructor, which also allows to specify a custom name.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canProvision(hudson.model.Label label)
boolean	equals(Object o)
static MesosCloud	get()
com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials	getCredentials() Returns the credentials object associated with the stored credentialsId.
String	getCredentialsId()
String	getDescription()
MesosCloud.DescriptorImpl	getDescriptor()
String	getFrameworkName()
String	getJenkinsURL()
String	getMaster()
String	getNativeLibraryPath()
String	getPrincipal() Deprecated. Use MesosCloud#getCredentials().getUsername() instead.
String	getSecret() Deprecated. Use MesosCloud#getCredentials().getPassword() instead.
net.sf.json.JSONObject	getSlaveAttributeForLabel(String labelName) Retrieves the slaveattribute corresponding to label name.
List<MesosSlaveInfo>	getSlaveInfos()
String	getSlavesUser()
int	hashCode()
static void	init() We want to start the Mesos scheduler as part of the initialization of Jenkins and after the cloud class values have been restored from persistence.If this is the very first time, this method will be NOOP as MesosCloud is not registered yet.
boolean	isCheckpoint()
boolean	isOnDemandRegistration()
Collection<hudson.slaves.NodeProvisioner.PlannedNode>	provision(hudson.model.Label label, int excessWorkload)
protected Object	readResolve()
void	restartMesos()
void	setCredentialsId(String credentialsId)
void	setDescription(String description)
void	setFrameworkName(String frameworkName)
void	setJenkinsURL(String jenkinsURL)
void	setMaster(String master)
void	setNativeLibraryPath(String nativeLibraryPath)
void	setOnDemandRegistration(boolean onDemandRegistration)
void	setPrincipal(String principal) Deprecated. Define credentials and use MesosCloud#setCredentialsId instead.
void	setSecret(String secret) Deprecated. Define credentials and use MesosCloud#setCredentialsId instead.
void	setSlaveInfos(List<MesosSlaveInfo> slaveInfos)
void	setSlavesUser(String slavesUser)

Methods inherited from class hudson.slaves.Cloud

all, checkPermission, getACL, 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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MesosCloud

@DataBoundConstructor
public MesosCloud(String nativeLibraryPath,
                               String master,
                               String description,
                               String frameworkName,
                               String slavesUser,
                               String principal,
                               String secret,
                               List<MesosSlaveInfo> slaveInfos,
                               boolean checkpoint,
                               boolean onDemandRegistration,
                               String jenkinsURL)
           throws NumberFormatException

Throws:

NumberFormatException

MesosCloud

protected MesosCloud(String cloudName,
          String nativeLibraryPath,
          String master,
          String description,
          String frameworkName,
          String slavesUser,
          String principal,
          String secret,
          List<MesosSlaveInfo> slaveInfos,
          boolean checkpoint,
          boolean onDemandRegistration,
          String jenkinsURL)
              throws NumberFormatException

Constructor, which also allows to specify a custom name.

Throws:

NumberFormatException - Numeric parameter parsing error

Since:

0.9.0

MesosCloud

public MesosCloud(@Nonnull
          String name,
          @Nonnull
          MesosCloud source)

Copy constructor. Allows to create copies of the original mesos cloud. Since it's a singleton by design, this method also allows specifying a new name.

Parameters:

name - Name of the cloud to be created

source - Source Mesos cloud implementation

Since:

0.9.0

Method Detail

init

@Initializer(after=JOB_LOADED)
public static void init()

We want to start the Mesos scheduler as part of the initialization of Jenkins and after the cloud class values have been restored from persistence.If this is the very first time, this method will be NOOP as MesosCloud is not registered yet.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

restartMesos

public void restartMesos()

getCredentials

public com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials getCredentials()

Returns the credentials object associated with the stored credentialsId.

Returns:

The credentials object associated with the stored credentialsId. May be null if credentialsId is null or if there is no credentials associated with the given id.

provision

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

Specified by:

provision in class hudson.slaves.Cloud

getSlaveInfos

public List<MesosSlaveInfo> getSlaveInfos()

setSlaveInfos

public void setSlaveInfos(List<MesosSlaveInfo> slaveInfos)

canProvision

public boolean canProvision(hudson.model.Label label)

Specified by:

canProvision in class hudson.slaves.Cloud

getNativeLibraryPath

public String getNativeLibraryPath()

setNativeLibraryPath

public void setNativeLibraryPath(String nativeLibraryPath)

getMaster

public String getMaster()

setMaster

public void setMaster(String master)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getFrameworkName

public String getFrameworkName()

setFrameworkName

public void setFrameworkName(String frameworkName)

getSlavesUser

public String getSlavesUser()

setSlavesUser

public void setSlavesUser(String slavesUser)

getPrincipal

@Deprecated
public String getPrincipal()

Deprecated. Use MesosCloud#getCredentials().getUsername() instead.

Returns:

setPrincipal

@Deprecated
public void setPrincipal(String principal)

Deprecated. Define credentials and use MesosCloud#setCredentialsId instead.

Parameters:

principal -

getCredentialsId

public String getCredentialsId()

Returns:

The credentialsId to use for this mesos cloud

setCredentialsId

@DataBoundSetter
public void setCredentialsId(String credentialsId)

getSecret

@Deprecated
public String getSecret()

Deprecated. Use MesosCloud#getCredentials().getPassword() instead.

Returns:

setSecret

@Deprecated
public void setSecret(String secret)

Deprecated. Define credentials and use MesosCloud#setCredentialsId instead.

Parameters:

secret -

isOnDemandRegistration

public boolean isOnDemandRegistration()

setOnDemandRegistration

public void setOnDemandRegistration(boolean onDemandRegistration)

getDescriptor

public MesosCloud.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.slaves.Cloud>

Overrides:

getDescriptor in class hudson.slaves.Cloud

get

public static MesosCloud get()

isCheckpoint

public boolean isCheckpoint()

Returns:

the checkpoint

getSlaveAttributeForLabel

public net.sf.json.JSONObject getSlaveAttributeForLabel(String labelName)

Retrieves the slaveattribute corresponding to label name.

Parameters:

labelName - The Jenkins label name.

Returns:

slaveattribute as a JSONObject.

readResolve

protected Object readResolve()

getJenkinsURL

public String getJenkinsURL()

setJenkinsURL

public void setJenkinsURL(String jenkinsURL)