com.redhat.foreman

Class ForemanSharedNodeCloud

java.lang.Object

hudson.model.AbstractModelObject

hudson.slaves.Cloud

com.redhat.foreman.ForemanSharedNodeCloud

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

Foreman Shared Node Cloud implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ForemanSharedNodeCloud.DescriptorImpl Descriptor for Foreman Cloud.
static class	ForemanSharedNodeCloud.ForemanSharedNodeWorker Update the inventory periodically.

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

Constructor and Description
ForemanSharedNodeCloud(String name) Constructor with name.
ForemanSharedNodeCloud(String cloudName, String url, String user, hudson.util.Secret password, String credentialsId, Integer sshConnectionTimeOut) Constructor for Config Page.

Method Summary

Modifier and Type	Method and Description
static DisposableImpl	addDisposableEvent(String cloudName, String hostName)
boolean	canProvision(hudson.model.Label label)
Collection<HostInfo>	getAllHosts()
static ForemanSharedNodeCloud	getByName(String name) Get Cloud using provided name.
String	getCloudName() Get Foreman Cloud Name.
String	getCredentialsId() Get credentials for SSH connection.
hudson.util.Secret	getPassword() Foreman password.
Integer	getSshConnectionTimeOut() Get SSH connection time in seconds.
String	getUrl() Get Foreman url.
String	getUser() Get Foreman user.
boolean	isOperational()
Collection<hudson.slaves.NodeProvisioner.PlannedNode>	provision(hudson.model.Label label, int excessWorkload)
void	setCloudName(String cloudName) Set Foreman Cloud Name.
void	setCredentialsId(String credentialsId) Setter for credentialsId.
boolean	setOperational() Set the ForemanSharedNodeCloud to Operational state (Operational == true).
boolean	setOperational(boolean status) Set the ForemanSharedNodeCloud to desired Operation state (Operation == status).
void	setPassword(hudson.util.Secret password) Set Foreman password.
void	setUrl(String url) Set Foreman url.
void	setUser(String user) Set Foreman user.

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

Constructor Detail

ForemanSharedNodeCloud

public ForemanSharedNodeCloud(String name)

Constructor with name.

Parameters:

name - Name of cloud.

ForemanSharedNodeCloud

@DataBoundConstructor
public ForemanSharedNodeCloud(String cloudName,
                                                    String url,
                                                    String user,
                                                    hudson.util.Secret password,
                                                    String credentialsId,
                                                    Integer sshConnectionTimeOut)

Constructor for Config Page.

Parameters:

cloudName - name of cloud.

url - Foreman URL.

user - user to connect with.

password - password to connect with.

credentialsId - creds to use to connect to slave.

sshConnectionTimeOut - timeout for SSH connection in secs.

Method Detail

setCredentialsId

@DataBoundSetter
public void setCredentialsId(String credentialsId)

Setter for credentialsId.

Parameters:

credentialsId - to use to connect to slaves with.

canProvision

public boolean canProvision(hudson.model.Label label)

Specified by:

canProvision in class hudson.slaves.Cloud

provision

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 ForemanSharedNodeCloud getByName(String name)
                                                      throws IllegalArgumentException

Get Cloud using provided name.

Parameters:

name - Cloud name.

Returns:

a Foreman Cloud.

Throws:

IllegalArgumentException - if occurs.

addDisposableEvent

public static DisposableImpl addDisposableEvent(String cloudName,
                                                String hostName)

getCloudName

public String getCloudName()

Get Foreman Cloud Name.

Returns:

name.

setCloudName

public void setCloudName(String cloudName)

Set Foreman Cloud Name.

Parameters:

cloudName - name of cloud.

getUrl

public String getUrl()

Get Foreman url.

Returns:

url.

setUrl

public void setUrl(String url)

Set Foreman url.

Parameters:

url - url.

getUser

public String getUser()

Get Foreman user.

Returns:

user.

setUser

public void setUser(String user)

Set Foreman user.

Parameters:

user - user.

getPassword

public hudson.util.Secret getPassword()

Foreman password.

Returns:

password as Secret.

setPassword

public void setPassword(hudson.util.Secret password)

Set Foreman password.

Parameters:

password - Secret.

getCredentialsId

public String getCredentialsId()

Get credentials for SSH connection.

Returns:

credential id.

getSshConnectionTimeOut

public Integer getSshConnectionTimeOut()

Get SSH connection time in seconds.

Returns:

timeout in secs.

getAllHosts

@Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class)
public Collection<HostInfo> getAllHosts()

isOperational

public boolean isOperational()

Returns:

current Operational state.

setOperational

public boolean setOperational()

Set the ForemanSharedNodeCloud to Operational state (Operational == true).

Returns:

previous state.

setOperational

public boolean setOperational(boolean status)

Set the ForemanSharedNodeCloud to desired Operation state (Operation == status).

Parameters:

status - desired Operational state.

Returns:

previous Operational state.