Package com.axis.jenkins.plugins.eiffel.eiffelbroadcaster.pipeline

Class SendEiffelEventStep

java.lang.Object

hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>

org.jenkinsci.plugins.workflow.steps.Step

com.axis.jenkins.plugins.eiffel.eiffelbroadcaster.pipeline.SendEiffelEventStep

All Implemented Interfaces:

ExtensionPoint, Describable<org.jenkinsci.plugins.workflow.steps.Step>

public class SendEiffelEventStep
extends org.jenkinsci.plugins.workflow.steps.Step

Defines a pipeline step for sending an Eiffel event expressed as a Map. By default the event passed by the user will be decorated with a CONTEXT link to the current build's EiffelActivityTriggeredEvent. Optionally a CAUSE link can be created instead or the link can be omitted entirely.

 def event = [
     "meta": [
         "type": "EiffelCompositionDefinedEvent",
         "version": "3.0.0",
     ],
     "data": [
         "name": "my-composition",
     ],
 ]
 def sent = sendEiffelEvent event: event, activityLinkType: "CAUSE"
 echo "This event was sent: ${sent}"
 

This step returns immediately as soon as the event has been validated and put on the internal outbound queue. The actual delivery of the event to the broker might not have happened at the time of the return.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SendEiffelEventStep.Descriptor

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static String	ERROR_MESSAGE_PREFIX

Constructor Summary

Constructors

Constructor	Description
SendEiffelEventStep(Map event)

Method Summary

Modifier and Type	Method	Description
EiffelEvent.Link.Type	getActivityLinkType()
Map	getEvent()
boolean	getLinkToActivity()
boolean	getPublishArtifact()
String	getSignatureCredentialsId()
HashAlgorithm	getSignatureHashAlgorithm()
void	setActivityLinkType(EiffelEvent.Link.Type activityLinkType)
void	setLinkToActivity(boolean linkToActivity)
void	setPublishArtifact(boolean publishArtifact)
void	setSignatureCredentialsId(String signatureCredentialsId)
void	setSignatureHashAlgorithm(String signatureHashAlgorithm)
org.jenkinsci.plugins.workflow.steps.StepExecution	start(org.jenkinsci.plugins.workflow.steps.StepContext stepContext)

Methods inherited from class org.jenkinsci.plugins.workflow.steps.Step

getDescriptor

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_MESSAGE_PREFIX

public static final String ERROR_MESSAGE_PREFIX

See Also:

Constant Field Values

Constructor Detail

SendEiffelEventStep

@DataBoundConstructor
public SendEiffelEventStep(@NonNull
                           Map event)

Method Detail

start

public org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext stepContext)
                                                         throws Exception

Specified by:

start in class org.jenkinsci.plugins.workflow.steps.Step

Throws:

Exception

getEvent

@NonNull
public Map getEvent()

getLinkToActivity

public boolean getLinkToActivity()

setLinkToActivity

@DataBoundSetter
public void setLinkToActivity(boolean linkToActivity)

getActivityLinkType

public EiffelEvent.Link.Type getActivityLinkType()

setActivityLinkType

@DataBoundSetter
public void setActivityLinkType(EiffelEvent.Link.Type activityLinkType)

getPublishArtifact

public boolean getPublishArtifact()

setPublishArtifact

@DataBoundSetter
public void setPublishArtifact(boolean publishArtifact)

getSignatureCredentialsId

public String getSignatureCredentialsId()

setSignatureCredentialsId

@DataBoundSetter
public void setSignatureCredentialsId(String signatureCredentialsId)

getSignatureHashAlgorithm

public HashAlgorithm getSignatureHashAlgorithm()

setSignatureHashAlgorithm

@DataBoundSetter
public void setSignatureHashAlgorithm(String signatureHashAlgorithm)