com.oracle.cloud.baremetal.jenkins

Class BaremetalCloud

java.lang.Object

hudson.model.AbstractModelObject

hudson.slaves.Cloud

hudson.slaves.AbstractCloudImpl

com.oracle.cloud.baremetal.jenkins.BaremetalCloud

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 BaremetalCloud
extends hudson.slaves.AbstractCloudImpl

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaremetalCloud.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static String	INSTANCE_NAME_PREFIX The prefix to add to the names of created instances.
static String	NAME_PREFIX The prefix to add to names provided by the user in the UI to ensure that names of clouds in different plugins do not conflict.

Fields inherited from class hudson.slaves.Cloud

ALL, name, PROVISION

Constructor Summary

Constructors

Constructor and Description
BaremetalCloud(String cloudName, String fingerprint, String apikey, String passphrase, String tenantId, String userId, String regionId, String instanceCapStr, int nextTemplateId, List<? extends BaremetalCloudAgentTemplate> templates)

Method Summary

Modifier and Type	Method and Description
boolean	canProvision(hudson.model.Label label)
org.kohsuke.stapler.HttpResponse	doIndex() The breadcrumb on the provision.jelly page contains a link to this object.
void	doProvision(int templateId, org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) Called by computerSet.jelly when explicitly provisioning a new node via the nodes page.
String	getApikey()
BaremetalCloudClient	getClient()
String	getCloudName()
String	getDisplayName()
protected String	getEncryptedValue(String str)
String	getFingerprint()
int	getNextTemplateId()
String	getPassphrase()
protected String	getPlainText(String str)
Class<?>	getProvisionSidePanelClass() Called by provision.jelly to show a sidepanel.
String	getProvisionStartedMessage(javax.servlet.http.HttpServletRequest req) Display a provisioning message based on request attributes set by doProvision(int, org.kohsuke.stapler.StaplerRequest, org.kohsuke.stapler.StaplerResponse).
String	getRegionId()
BaremetalCloudAgentTemplate	getTemplate(hudson.model.Label label)
List<? extends BaremetalCloudAgentTemplate>	getTemplates()
String	getTenantId()
String	getUserId()
Collection<hudson.slaves.NodeProvisioner.PlannedNode>	provision(hudson.model.Label label, int excessWorkload)
void	recycleCloudResources(String instanceId)

Methods inherited from class hudson.slaves.AbstractCloudImpl

getInstanceCap, getInstanceCapStr, setInstanceCap, setInstanceCapStr

Methods inherited from class hudson.slaves.Cloud

all, checkPermission, getACL, getDescriptor, 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

NAME_PREFIX

public static final String NAME_PREFIX

The prefix to add to names provided by the user in the UI to ensure that names of clouds in different plugins do not conflict. We use the term "name" to mean the full name with a prefix (to match Cloud.name), and we use the term "cloud name" to be the short name without a prefix.

See Also:

cloudNameToName(java.lang.String), nameToCloudName(java.lang.String), getCloudName(), BaremetalCloud.DescriptorImpl.doCheckCloudName(java.lang.String), Constant Field Values

INSTANCE_NAME_PREFIX

public static final String INSTANCE_NAME_PREFIX

The prefix to add to the names of created instances.

See Also:

Constant Field Values

Constructor Detail

BaremetalCloud

@DataBoundConstructor
public BaremetalCloud(String cloudName,
                                            String fingerprint,
                                            String apikey,
                                            String passphrase,
                                            String tenantId,
                                            String userId,
                                            String regionId,
                                            String instanceCapStr,
                                            int nextTemplateId,
                                            List<? extends BaremetalCloudAgentTemplate> templates)

Method Detail

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface hudson.model.ModelObject

Overrides:

getDisplayName in class hudson.slaves.Cloud

getCloudName

public String getCloudName()

getFingerprint

public String getFingerprint()

getApikey

public String getApikey()

getPassphrase

public String getPassphrase()

getTenantId

public String getTenantId()

getUserId

public String getUserId()

getRegionId

public String getRegionId()

getNextTemplateId

public int getNextTemplateId()

getTemplates

public List<? extends BaremetalCloudAgentTemplate> getTemplates()

getEncryptedValue

protected String getEncryptedValue(String str)

getPlainText

protected String getPlainText(String str)

provision

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

Specified by:

provision in class hudson.slaves.Cloud

recycleCloudResources

public void recycleCloudResources(String instanceId)
                           throws IOException

Throws:

IOException

getTemplate

public BaremetalCloudAgentTemplate getTemplate(hudson.model.Label label)

doProvision

public void doProvision(@QueryParameter
                        int templateId,
                        org.kohsuke.stapler.StaplerRequest req,
                        org.kohsuke.stapler.StaplerResponse rsp)
                 throws javax.servlet.ServletException,
                        IOException

Called by computerSet.jelly when explicitly provisioning a new node via the nodes page.

Parameters:

templateId - template id

req - request

rsp - response

Throws:

javax.servlet.ServletException - if a servlet exception occurs

IOException - if a IO error occurs

getProvisionSidePanelClass

public Class<?> getProvisionSidePanelClass()

Called by provision.jelly to show a sidepanel.

Returns:

provision side panel class

getProvisionStartedMessage

public String getProvisionStartedMessage(javax.servlet.http.HttpServletRequest req)

Display a provisioning message based on request attributes set by doProvision(int, org.kohsuke.stapler.StaplerRequest, org.kohsuke.stapler.StaplerResponse).

Parameters:

req - request

Returns:

provision started message

doIndex

public org.kohsuke.stapler.HttpResponse doIndex()
                                         throws IOException

The breadcrumb on the provision.jelly page contains a link to this object. We have no data to display, so redirect the user to the computer set page.

Returns:

the http response

Throws:

IOException - if an IO error occurs

getClient

public BaremetalCloudClient getClient()

canProvision

public boolean canProvision(hudson.model.Label label)

Specified by:

canProvision in class hudson.slaves.Cloud