flexagon.fd.model2.notification.payload

Class BaseNotificationPayload

java.lang.Object

flexagon.ff.common.core.pojos.BasePOJO

flexagon.fd.model2.notification.payload.BaseNotificationPayload

All Implemented Interfaces:

NotificationPayload, java.io.Serializable

Direct Known Subclasses:

BaseHumanTaskPayload, PipelineNotificationStepPayload, PipelineStepExecFailedPayload, ProjectWorkflowRequestPayload

public abstract class BaseNotificationPayload
extends BasePOJO
implements NotificationPayload

Abstract class from which all Notification Payloads inherit.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected NotificationEventTypeEnum	mNotificationEventTypeEnum
protected java.util.List<EmailAttachment>	mPipelineAttachments
protected java.util.List<java.lang.String>	mPipelineNotes

Fields inherited from interface flexagon.fd.model2.notification.payload.NotificationPayload

DATE_FORMAT

Constructor Summary

Constructors

Constructor and Description
BaseNotificationPayload(NotificationEventTypeEnum pNotificationEventTypeEnum) Creates an instance of the payload.

Method Summary

Modifier and Type	Method and Description
void	addAttachment(byte[] pAttachmentData, java.lang.String pAttachmentName, java.lang.String pContentType) Adds an email attachment with the given name and content type for byte array type data to the Template.
void	addAttachment(java.io.Serializable pAttachmentData) Adds an email attachment with a generated name for any Serlizable type data to the Template
void	addAttachment(java.io.Serializable pAttachmentData, java.lang.String pAttachmentName) Adds an email attachment with the given name for any Serlizable type data to the Template
void	addAttachment(java.io.Serializable pAttachmentData, java.lang.String pAttachmentName, java.lang.String pContentType) Adds an email attachment with the given name and content type for any Serlizable type data to the Template
protected void	addRecipientsByCommittersIfEligible(java.util.List<NotifScmCommit> pNotifScmCommits, java.lang.String pStatus, java.lang.String pAttributeGroupName)
protected void	addRecipientsByGroupId(java.lang.Long pGroupId)
protected void	addRecipientsByGroupIdIfEligible(java.lang.Long pGroupId, java.lang.String pUserAttributeName, java.lang.String pAttributeGroupName) This methods select active users for a group who has their attribute selected
protected void	addRecipientsByGroupNameIfEligible(java.lang.String pGroupName, java.lang.String pUserAttributeName, java.lang.String pAttributeGroupName) This methods select active users for a group who has their attribute selected
protected void	addRecipientsByPipelineRoleMember(java.util.List<java.lang.Long> pPipelineRoleIdList, java.lang.Long pRelDefinitionId)
protected void	addRecipientsByPipelineRoleUserOrEmailMember(java.lang.Long pPipelineRoleId, java.lang.Long pRelDefinitionId, java.lang.String pMemberType)
protected void	addRecipientsBySubscriptions(java.lang.Long pEnvironmentId, java.lang.String pRequestStatus, java.lang.Long pFolderId, java.lang.String pAttributeGroupName)
protected void	addRecipientsByUserIdIfEligible(java.lang.Long pUserId, java.lang.String pUserAttributeName, java.lang.String pAttributeGroupName)
protected void	addRecipientsByUserNameIfEligible(java.lang.String pUserName, java.lang.String pUserAttributeName, java.lang.String pAttributeGroupName)
protected void	addRecipientsForPipelineStepExecFailure(java.lang.Long pRelDefinitionId, OnErrorType pOnError, java.lang.Long pPipelineDefinitionId, java.lang.Long pPipelineStageExecId)
protected PipelineRoleScriptResult	evaluatePipelineRoleScript(java.lang.Long pRelDefinitionId, java.lang.Long pPipelineDefinitionId, java.lang.Long pPipelineStageExecId, java.lang.String pScript)
protected java.lang.Long	getApprovalGateRoleByGateId(java.lang.Long pPipelineGateId)
java.lang.String	getApprovalTaskUrlPath() Returns the URI of the approval tasks page.
java.util.List<EmailAttachment>	getAttachments() Returns a list of email attachments pertaining to the event which has occurred.
protected NotifFolder	getFolderWithHierarchy(java.lang.Long pFolderId)
java.lang.String	getHumanTaskIdentityUuid()
java.lang.String	getHumanTaskUrlPath() Returns the URI of the human tasks page.
protected java.util.List<InputField>	getInputFieldsForStep(PipelineExecutionUnitTypes pType, java.io.Serializable pData)
protected java.lang.Long	getManualStepRoleByStepId(java.lang.Long pPipelineStageStepId)
protected java.lang.String	getPipelineRoleScriptForGate(PipelineExecutionUnitTypes pType, java.io.Serializable pData)
protected java.lang.String	getPipelineRoleScriptForStep(PipelineExecutionUnitTypes pType, java.io.Serializable pData)
protected PipelineStageExecutionSnapshotQueryResultRow	getPipelineStageExecutionSnapshotQueryResultRow(java.lang.Long pPipelineStageExecId)
java.util.List<NotificationRecipient>	getRecipients()
protected java.lang.String	getUserFullName(java.lang.String pUserName)
boolean	hasAttachments() Whether the payload has attachments to be delivered with the notification.
protected boolean	isGroupMemberOfPipelineRole(java.lang.Long pRelDefinitionId, java.lang.Long pGroupId, java.util.List<java.lang.Long> pPipelineRoleIds)
boolean	isSendLogAttachments() Returns whether plugin log attachments should be included in notification.
boolean	isShowNotesAndSendAttachments() Returns whether notes and notes attachments should be included in notification.
protected void	populatePipelineAttachmentsAndNotes(java.lang.Long pGateOrStepId, java.lang.String pObjectType)
void	sendLogAttachments(boolean pSendLogAttachments) Sets whether plugin logs should be attached to the notification.
void	showNotesAndSendAttachments(boolean pShowNotesAndSendAttachments) Sets whether notes and notes attachments should be included in notification.
java.lang.String	showTextForMissingUrlSetup() Returns a warning message if Base Server URL is not configured in System Settings.
protected java.util.List<NotifScmCommit>	toNotifScmCommits(java.util.List<ScmCommitDataObject> pScmCommitDataObjects)
java.lang.String	toString() Returns custom String representation implemented by walking complete object structure.

Methods inherited from class flexagon.ff.common.core.pojos.BasePOJO

areEqual

Methods inherited from class java.lang.Object

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

Methods inherited from interface flexagon.fd.model2.notification.payload.NotificationPayload

addRecipients, getId

Field Detail

mNotificationEventTypeEnum

protected NotificationEventTypeEnum mNotificationEventTypeEnum

mPipelineNotes

protected transient java.util.List<java.lang.String> mPipelineNotes

mPipelineAttachments

protected transient java.util.List<EmailAttachment> mPipelineAttachments

Constructor Detail

BaseNotificationPayload

public BaseNotificationPayload(NotificationEventTypeEnum pNotificationEventTypeEnum)

Creates an instance of the payload.

Parameters:

pNotificationEventTypeEnum - The event type for the payload

Method Detail

getRecipients

public java.util.List<NotificationRecipient> getRecipients()

Specified by:

getRecipients in interface NotificationPayload

addRecipientsByCommittersIfEligible

protected void addRecipientsByCommittersIfEligible(java.util.List<NotifScmCommit> pNotifScmCommits,
                                                   java.lang.String pStatus,
                                                   java.lang.String pAttributeGroupName)
                                            throws java.sql.SQLException

Throws:

java.sql.SQLException

addRecipientsForPipelineStepExecFailure

protected void addRecipientsForPipelineStepExecFailure(java.lang.Long pRelDefinitionId,
                                                       OnErrorType pOnError,
                                                       java.lang.Long pPipelineDefinitionId,
                                                       java.lang.Long pPipelineStageExecId)
                                                throws java.sql.SQLException

Throws:

java.sql.SQLException

evaluatePipelineRoleScript

protected PipelineRoleScriptResult evaluatePipelineRoleScript(java.lang.Long pRelDefinitionId,
                                                              java.lang.Long pPipelineDefinitionId,
                                                              java.lang.Long pPipelineStageExecId,
                                                              java.lang.String pScript)
                                                       throws java.sql.SQLException

Throws:

java.sql.SQLException

addRecipientsByPipelineRoleMember

protected void addRecipientsByPipelineRoleMember(java.util.List<java.lang.Long> pPipelineRoleIdList,
                                                 java.lang.Long pRelDefinitionId)
                                          throws java.sql.SQLException

Throws:

java.sql.SQLException

addRecipientsByPipelineRoleUserOrEmailMember

protected void addRecipientsByPipelineRoleUserOrEmailMember(java.lang.Long pPipelineRoleId,
                                                            java.lang.Long pRelDefinitionId,
                                                            java.lang.String pMemberType)
                                                     throws java.sql.SQLException

Throws:

java.sql.SQLException

addRecipientsByUserNameIfEligible

protected void addRecipientsByUserNameIfEligible(java.lang.String pUserName,
                                                 java.lang.String pUserAttributeName,
                                                 java.lang.String pAttributeGroupName)
                                          throws java.sql.SQLException

Throws:

java.sql.SQLException

addRecipientsByUserIdIfEligible

protected void addRecipientsByUserIdIfEligible(java.lang.Long pUserId,
                                               java.lang.String pUserAttributeName,
                                               java.lang.String pAttributeGroupName)
                                        throws java.sql.SQLException

Throws:

java.sql.SQLException

addRecipientsByGroupNameIfEligible

protected void addRecipientsByGroupNameIfEligible(java.lang.String pGroupName,
                                                  java.lang.String pUserAttributeName,
                                                  java.lang.String pAttributeGroupName)

This methods select active users for a group who has their attribute selected

Parameters:

pGroupName -

pUserAttributeName -

addRecipientsByGroupIdIfEligible

protected void addRecipientsByGroupIdIfEligible(java.lang.Long pGroupId,
                                                java.lang.String pUserAttributeName,
                                                java.lang.String pAttributeGroupName)

This methods select active users for a group who has their attribute selected

Parameters:

pGroupId -

pUserAttributeName -

addRecipientsByGroupId

protected void addRecipientsByGroupId(java.lang.Long pGroupId)

isGroupMemberOfPipelineRole

protected boolean isGroupMemberOfPipelineRole(java.lang.Long pRelDefinitionId,
                                              java.lang.Long pGroupId,
                                              java.util.List<java.lang.Long> pPipelineRoleIds)
                                       throws java.sql.SQLException

Throws:

java.sql.SQLException

getApprovalGateRoleByGateId

protected java.lang.Long getApprovalGateRoleByGateId(java.lang.Long pPipelineGateId)
                                              throws java.sql.SQLException

Throws:

java.sql.SQLException

getManualStepRoleByStepId

protected java.lang.Long getManualStepRoleByStepId(java.lang.Long pPipelineStageStepId)
                                            throws java.sql.SQLException

Throws:

java.sql.SQLException

addRecipientsBySubscriptions

protected void addRecipientsBySubscriptions(java.lang.Long pEnvironmentId,
                                            java.lang.String pRequestStatus,
                                            java.lang.Long pFolderId,
                                            java.lang.String pAttributeGroupName)
                                     throws java.sql.SQLException

Throws:

java.sql.SQLException

getApprovalTaskUrlPath

public java.lang.String getApprovalTaskUrlPath()

Returns the URI of the approval tasks page.

Returns:

The URI of the approval tasks page.

getHumanTaskUrlPath

public java.lang.String getHumanTaskUrlPath()

Returns the URI of the human tasks page.

Returns:

The URI of the human tasks page.

sendLogAttachments

public void sendLogAttachments(boolean pSendLogAttachments)

Sets whether plugin logs should be attached to the notification.

Parameters:

pSendLogAttachments - Whether plugin logs should be attached to the notification.

getFolderWithHierarchy

protected NotifFolder getFolderWithHierarchy(java.lang.Long pFolderId)

getUserFullName

protected java.lang.String getUserFullName(java.lang.String pUserName)

showTextForMissingUrlSetup

public java.lang.String showTextForMissingUrlSetup()

Returns a warning message if Base Server URL is not configured in System Settings.

Returns:

A warning message if Base Server URL is not configured in System Settings.

getHumanTaskIdentityUuid

public java.lang.String getHumanTaskIdentityUuid()

Specified by:

getHumanTaskIdentityUuid in interface NotificationPayload

isSendLogAttachments

public boolean isSendLogAttachments()

Returns whether plugin log attachments should be included in notification.

Returns:

Whether plugin log attachments should be included in notification.

showNotesAndSendAttachments

public void showNotesAndSendAttachments(boolean pShowNotesAndSendAttachments)

Sets whether notes and notes attachments should be included in notification.

Parameters:

pShowNotesAndSendAttachments - Whether notes and notes attachments should be included in notification.

isShowNotesAndSendAttachments

public boolean isShowNotesAndSendAttachments()

Returns whether notes and notes attachments should be included in notification.

Returns:

Whether notes and notes attachments should be included in notification.

hasAttachments

public boolean hasAttachments()

Description copied from interface: NotificationPayload

Whether the payload has attachments to be delivered with the notification.

Specified by:

hasAttachments in interface NotificationPayload

Returns:

Whether the payload has attachments to be delivered with the notification.

addAttachment

public void addAttachment(java.io.Serializable pAttachmentData,
                          java.lang.String pAttachmentName)

Adds an email attachment with the given name for any Serlizable type data to the Template

Parameters:

pAttachmentName - The name of the attachment.

pAttachmentData - The attachment data.

addAttachment

public void addAttachment(java.io.Serializable pAttachmentData)

Adds an email attachment with a generated name for any Serlizable type data to the Template

Parameters:

pAttachmentData - The attachment data.

addAttachment

public void addAttachment(java.io.Serializable pAttachmentData,
                          java.lang.String pAttachmentName,
                          java.lang.String pContentType)

Adds an email attachment with the given name and content type for any Serlizable type data to the Template

Parameters:

pAttachmentData - The attachment data.

pAttachmentName - The attachment name.

pContentType - The attachment content type.

addAttachment

public void addAttachment(byte[] pAttachmentData,
                          java.lang.String pAttachmentName,
                          java.lang.String pContentType)

Adds an email attachment with the given name and content type for byte array type data to the Template.

Parameters:

pAttachmentData - The attachment data.

pAttachmentName - The attachment name.

pContentType - The attachment content type.

getAttachments

public java.util.List<EmailAttachment> getAttachments()
                                               throws java.sql.SQLException

Description copied from interface: NotificationPayload

Returns a list of email attachments pertaining to the event which has occurred.

Specified by:

getAttachments in interface NotificationPayload

Returns:

A list of email attachements.

Throws:

java.sql.SQLException

toString

public java.lang.String toString()

Description copied from class: BasePOJO

Returns custom String representation implemented by walking complete object structure.

Overrides:

toString in class BasePOJO

Returns:

a String representation of this object

populatePipelineAttachmentsAndNotes

protected void populatePipelineAttachmentsAndNotes(java.lang.Long pGateOrStepId,
                                                   java.lang.String pObjectType)
                                            throws java.sql.SQLException

Throws:

java.sql.SQLException

getPipelineStageExecutionSnapshotQueryResultRow

protected PipelineStageExecutionSnapshotQueryResultRow getPipelineStageExecutionSnapshotQueryResultRow(java.lang.Long pPipelineStageExecId)
                                                                                                throws java.sql.SQLException

Throws:

java.sql.SQLException

toNotifScmCommits

protected java.util.List<NotifScmCommit> toNotifScmCommits(java.util.List<ScmCommitDataObject> pScmCommitDataObjects)

getPipelineRoleScriptForGate

protected java.lang.String getPipelineRoleScriptForGate(PipelineExecutionUnitTypes pType,
                                                        java.io.Serializable pData)

getPipelineRoleScriptForStep

protected java.lang.String getPipelineRoleScriptForStep(PipelineExecutionUnitTypes pType,
                                                        java.io.Serializable pData)

getInputFieldsForStep

protected java.util.List<InputField> getInputFieldsForStep(PipelineExecutionUnitTypes pType,
                                                           java.io.Serializable pData)