com.ibm.devops.dra

Class PublishSQ

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

com.ibm.devops.dra.AbstractDevOpsAction

com.ibm.devops.dra.PublishSQ

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Publisher>, hudson.tasks.BuildStep, jenkins.tasks.SimpleBuildStep

public class PublishSQ
extends AbstractDevOpsAction
implements jenkins.tasks.SimpleBuildStep

Authenticate with Bluemix and then upload the result file to DRA

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PublishSQ.OptionalBuildInfo
static class	PublishSQ.PublishSQImpl Descriptor for PublishSQ.

Nested classes/interfaces inherited from class hudson.tasks.Publisher

hudson.tasks.Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface jenkins.tasks.SimpleBuildStep

jenkins.tasks.SimpleBuildStep.LastBuildAction, jenkins.tasks.SimpleBuildStep.LastBuildActionFactory

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class com.ibm.devops.dra.AbstractDevOpsAction

API_KEY, APP_NAME, CONTROL_CENTER, DEFAULT_ENV, DLMS, ENV, GATE_SERVICE, LOGGER, PASSWORD, RESULT_FAIL, RESULT_SUCCESS, TOOLCHAIN_ID, USERNAME

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
PublishSQ(HashMap<String,String> envVarsMap, HashMap<String,String> paramsMap)
PublishSQ(String credentialsId, String toolchainName, String buildJobName, String applicationName, String SQHostName, String SQAuthToken, String SQProjectKey, PublishSQ.OptionalBuildInfo additionalBuildInfo)

Method Summary

Modifier and Type	Method and Description
com.google.gson.JsonObject	createDLMSPayload(String hostname, String projectKey, String authToken) Combines all SQ information into one gson that can be sent to DLMS
com.google.gson.JsonArray	createPayloadUrls(String SQHostname, String SQKey) Constructs the urls that should be sent with the DLMS message
String	getApplicationName() We'll use this from the config.jelly.
String	getBuildJobName()
String	getBuildNumber()
String	getCredentialsId()
PublishSQ.PublishSQImpl	getDescriptor()
hudson.tasks.BuildStepMonitor	getRequiredMonitorService()
String	getSQAuthToken()
String	getSQHostName()
String	getSQProjectKey()
String	getToolchainName()
void	perform(hudson.model.Run build, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener)
void	setApplicationName(String applicationName)
void	setBuildNumber(String buildNumber)

Methods inherited from class com.ibm.devops.dra.AbstractDevOpsAction

chooseAppsUrl, chooseIAMAPI, chooseOrganizationsUrl, chooseSpacesUrl, chooseTargetAPI, constructBuildNumber, expandVariable, getAllEndpoints, getAppId, getBluemixToken, getBuildNumber, getDecisionFromDRA, getDeploymentRiskUrl, getIAMToken, getIBMCloudToken, getOrgId, getOTCBrokerServer, getPolicyList, getReportUrl, getSpaceId, getTokenForFreeStyleJob, passEnvToNextBuildStep, printDebugLog, publishDecision, setDLMSUrl, setGateServiceUrl, setRequiredEnvVars

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectActions, perform, perform, prebuild

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.tasks.BuildStep

getProjectAction, getProjectActions, perform, prebuild

Constructor Detail

PublishSQ

@DataBoundConstructor
public PublishSQ(String credentialsId,
                                       String toolchainName,
                                       String buildJobName,
                                       String applicationName,
                                       String SQHostName,
                                       String SQAuthToken,
                                       String SQProjectKey,
                                       PublishSQ.OptionalBuildInfo additionalBuildInfo)

PublishSQ

public PublishSQ(HashMap<String,String> envVarsMap,
                 HashMap<String,String> paramsMap)

Method Detail

setBuildNumber

public void setBuildNumber(String buildNumber)

setApplicationName

@DataBoundSetter
public void setApplicationName(String applicationName)

getApplicationName

public String getApplicationName()

We'll use this from the config.jelly.

getToolchainName

public String getToolchainName()

getCredentialsId

public String getCredentialsId()

getBuildJobName

public String getBuildJobName()

getSQHostName

public String getSQHostName()

getSQAuthToken

public String getSQAuthToken()

getSQProjectKey

public String getSQProjectKey()

getBuildNumber

public String getBuildNumber()

perform

public void perform(@Nonnull
                    hudson.model.Run build,
                    @Nonnull
                    hudson.FilePath workspace,
                    @Nonnull
                    hudson.Launcher launcher,
                    @Nonnull
                    hudson.model.TaskListener listener)
             throws InterruptedException,
                    IOException

Specified by:

perform in interface jenkins.tasks.SimpleBuildStep

Throws:

InterruptedException

IOException

createPayloadUrls

public com.google.gson.JsonArray createPayloadUrls(String SQHostname,
                                                   String SQKey)

Constructs the urls that should be sent with the DLMS message

Parameters:

SQHostname - hostname of the SQ instance

SQKey - project key of the SQ instance

Returns:

an array of URLs that should be sent to dlms along with the payload

createDLMSPayload

public com.google.gson.JsonObject createDLMSPayload(String hostname,
                                                    String projectKey,
                                                    String authToken)
                                             throws Exception

Combines all SQ information into one gson that can be sent to DLMS

Parameters:

hostname -

projectKey -

authToken -

Returns:

Throws:

Exception

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface hudson.tasks.BuildStep

getDescriptor

public PublishSQ.PublishSQImpl getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.Publisher>

Overrides:

getDescriptor in class hudson.tasks.Recorder