com.oracle.cloud.compute.jenkins

Class ComputeCloud

java.lang.Object

hudson.model.AbstractModelObject

hudson.slaves.Cloud

hudson.slaves.AbstractCloudImpl

com.oracle.cloud.compute.jenkins.ComputeCloud

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ComputeCloud.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static String	AGENT_NAME_PREFIX The prefix to add to the names of provisioned agents.
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.
static String	ORCHESTRATION_NAME_PREFIX The prefix to add to the names of created orchestrations.

Fields inherited from class hudson.slaves.Cloud

ALL, name, PROVISION

Constructor Summary

Constructors

Constructor and Description
ComputeCloud(String cloudName, String apiEndpoint, String identityDomainName, String userName, String password, String instanceCapStr, int nextTemplateId, List<? extends ComputeCloudAgentTemplate> templates)

Method Summary

Modifier and Type	Method and Description
boolean	canProvision(hudson.model.Label label)
int	countCurrentComputeCloudAgents()
ComputeCloudClient	createClient()
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	getApiEndpoint()
URI	getApiEndpointUrl()
String	getCloudName()
String	getDisplayName()
protected String	getEncryptedValue(String str)
String	getFullDisplayName() Called by provision.jelly.
String	getIdentityDomainName()
int	getNextTemplateId()
String	getPassword()
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).
ComputeCloudAgentTemplate	getTemplate(hudson.model.Label label)
List<? extends ComputeCloudAgentTemplate>	getTemplates()
ComputeCloudUser	getUser()
String	getUserName()
Collection<hudson.slaves.NodeProvisioner.PlannedNode>	provision(hudson.model.Label label, int excessWorkload)
void	recycleCloudResources(String orchName) recycle orchestration related cloud resources with specified orchestration name
protected void	stopAndDeleteOrchestration(ComputeCloudClient client, long timeoutNanos, String orchName)

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(), ComputeCloud.DescriptorImpl.doCheckCloudName(java.lang.String), Constant Field Values

ORCHESTRATION_NAME_PREFIX

public static final String ORCHESTRATION_NAME_PREFIX

The prefix to add to the names of created orchestrations.

See Also:

Constant Field Values

AGENT_NAME_PREFIX

public static final String AGENT_NAME_PREFIX

The prefix to add to the names of provisioned agents.

See Also:

Constant Field Values

Constructor Detail

ComputeCloud

@DataBoundConstructor
public ComputeCloud(String cloudName,
                                          String apiEndpoint,
                                          String identityDomainName,
                                          String userName,
                                          String password,
                                          String instanceCapStr,
                                          int nextTemplateId,
                                          List<? extends ComputeCloudAgentTemplate> templates)

Method Detail

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface hudson.model.ModelObject

Overrides:

getDisplayName in class hudson.slaves.Cloud

getFullDisplayName

public String getFullDisplayName()

Called by provision.jelly.

Returns:

the full display name

getCloudName

public String getCloudName()

getNextTemplateId

public int getNextTemplateId()

getTemplates

public List<? extends ComputeCloudAgentTemplate> getTemplates()

getApiEndpoint

public String getApiEndpoint()

getApiEndpointUrl

public URI getApiEndpointUrl()

getIdentityDomainName

public String getIdentityDomainName()

getUserName

public String getUserName()

getUser

public ComputeCloudUser getUser()

getEncryptedValue

protected String getEncryptedValue(String str)

getPlainText

protected String getPlainText(String str)

getPassword

public final String getPassword()

provision

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

Specified by:

provision in class hudson.slaves.Cloud

stopAndDeleteOrchestration

protected void stopAndDeleteOrchestration(ComputeCloudClient client,
                                          long timeoutNanos,
                                          String orchName)
                                   throws ComputeCloudClientException,
                                          InterruptedException,
                                          IOException

Throws:

ComputeCloudClientException

InterruptedException

IOException

recycleCloudResources

public void recycleCloudResources(String orchName)
                           throws InterruptedException,
                                  IOException

recycle orchestration related cloud resources with specified orchestration name

Parameters:

orchName - the name of orchestration to be recycled.

Throws:

InterruptedException - if thread is interrupted.

IOException - if request hit IO exception.

countCurrentComputeCloudAgents

public int countCurrentComputeCloudAgents()

getTemplate

public ComputeCloudAgentTemplate 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

createClient

public ComputeCloudClient createClient()

canProvision

public boolean canProvision(hudson.model.Label label)

Specified by:

canProvision in class hudson.slaves.Cloud