Package com.atlassian.bamboo.migration.stream

Class PipelineMapper

java.lang.Object

com.atlassian.bamboo.migration.BambooStAXMappingHelperAbstractImpl<T,I>

com.atlassian.bamboo.migration.BambooStAXMappingListHelperAbstractImpl<PipelineDefinition,PipelineDefinition>

com.atlassian.bamboo.migration.stream.PipelineMapper

All Implemented Interfaces:

BambooRootMapper, BambooStAXMappingHelper<PipelineDefinition,PipelineDefinition>, BambooStAXRootMapper

public class PipelineMapper
extends BambooStAXMappingListHelperAbstractImpl<PipelineDefinition,PipelineDefinition>
implements BambooStAXRootMapper

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.bamboo.migration.BambooStAXMappingHelper

BambooStAXMappingHelper.None

Field Summary

Fields inherited from class com.atlassian.bamboo.migration.BambooStAXMappingHelperAbstractImpl

transactionOperations

Constructor Summary

Constructors

Constructor	Description
PipelineMapper(org.hibernate.SessionFactory sessionFactory, CapabilitySetManager capabilitySetManager, ElasticImageConfigurationDao elasticImageConfigurationDao, @NotNull org.springframework.transaction.support.TransactionOperations transactionOperations)

Method Summary

Modifier and Type	Method	Description
void	afterImportListItem(@NotNull org.codehaus.staxmate.in.SMInputCursor cursor, @NotNull List<PipelineDefinition> pipelineDefinitions, @NotNull PipelineDefinition pipeline, long objectIndex, @NotNull org.hibernate.Session session)	Called after parser completes parsing all child nodes in list's element node.
void	beforeImportListItem(@NotNull org.codehaus.staxmate.in.SMInputCursor cursor, @NotNull List<PipelineDefinition> pipelineDefinitions, @NotNull org.hibernate.Session session)	Called when parser reaches the list's element node.
protected @NotNull PipelineDefinition	createItemInstance(@NotNull org.codehaus.staxmate.in.SMInputCursor inputCursor)	Method returns only placeholder for pipeline data.
void	exportData(@NotNull org.codehaus.staxmate.out.SMOutputElement outputElement, ExportDetailsBean exportDetailsBean)	Perform data export
protected void	exportProperties(@NotNull org.codehaus.staxmate.out.SMOutputElement outputElement, @NotNull PipelineDefinition object, @NotNull org.hibernate.Session session, ExportDetailsBean exportDetailsBean)	Export object properties.
@NotNull String	getXmlElementNodeName()
@NotNull String	getXmlRootNodeName()	Returns local name of the XML parent node that will contain exported/imported object's properties
void	importData(@NotNull org.codehaus.staxmate.in.SMInputCursor inputCursor)	Perform data import
protected void	importProperties(@NotNull PipelineDefinition pipeline, @NotNull org.codehaus.staxmate.in.SMInputCursor inputCursor, @NotNull org.hibernate.Session session)	Import properties to the object.

Methods inherited from class com.atlassian.bamboo.migration.BambooStAXMappingListHelperAbstractImpl

createListRootElement, createRootElement, eventEndElementOfListItemSaveObject, exportListXml, exportListXml, flushIfNeeded, importListXml, importListXml, importListXmlInTransaction

Methods inherited from class com.atlassian.bamboo.migration.BambooStAXMappingHelperAbstractImpl

exportXml, exportXml, getSession, getSessionFactory, importXml, importXml, isShouldExport, saveBambooObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.bamboo.migration.BambooRootMapper

isShouldExport

Methods inherited from interface com.atlassian.bamboo.migration.BambooStAXMappingHelper

exportXml, importXml

Constructor Detail

PipelineMapper

public PipelineMapper(org.hibernate.SessionFactory sessionFactory,
                      CapabilitySetManager capabilitySetManager,
                      ElasticImageConfigurationDao elasticImageConfigurationDao,
                      @NotNull
                      @NotNull org.springframework.transaction.support.TransactionOperations transactionOperations)

Method Detail

getXmlElementNodeName

@NotNull
public @NotNull String getXmlElementNodeName()

Overrides:

getXmlElementNodeName in class BambooStAXMappingListHelperAbstractImpl<PipelineDefinition,PipelineDefinition>

beforeImportListItem

public void beforeImportListItem(@NotNull
                                 @NotNull org.codehaus.staxmate.in.SMInputCursor cursor,
                                 @NotNull
                                 @NotNull List<PipelineDefinition> pipelineDefinitions,
                                 @NotNull
                                 @NotNull org.hibernate.Session session)
                          throws Exception

Description copied from class: BambooStAXMappingListHelperAbstractImpl

Called when parser reaches the list's element node.

Overrides:

beforeImportListItem in class BambooStAXMappingListHelperAbstractImpl<PipelineDefinition,PipelineDefinition>

Parameters:

cursor - inputCursor pointing to the list's element opening node

pipelineDefinitions - list of elements being imported

session - Hibernate session object

Throws:

Exception - when something went wrong

afterImportListItem

public void afterImportListItem(@NotNull
                                @NotNull org.codehaus.staxmate.in.SMInputCursor cursor,
                                @NotNull
                                @NotNull List<PipelineDefinition> pipelineDefinitions,
                                @NotNull
                                @NotNull PipelineDefinition pipeline,
                                long objectIndex,
                                @NotNull
                                @NotNull org.hibernate.Session session)
                         throws Exception

Description copied from class: BambooStAXMappingListHelperAbstractImpl

Called after parser completes parsing all child nodes in list's element node.

Overrides:

afterImportListItem in class BambooStAXMappingListHelperAbstractImpl<PipelineDefinition,PipelineDefinition>

Parameters:

cursor - cursor pointing to the list's element opening node

pipelineDefinitions - list of elements being imported

pipeline - object that has been imported

objectIndex - one-based index of the object being parsed

session - Hibernate session object

Throws:

Exception - when something went wrong

getXmlRootNodeName

@NotNull
public @NotNull String getXmlRootNodeName()

Description copied from interface: BambooStAXMappingHelper

Returns local name of the XML parent node that will contain exported/imported object's properties

Specified by:

getXmlRootNodeName in interface BambooStAXMappingHelper<PipelineDefinition,PipelineDefinition>

Specified by:

getXmlRootNodeName in interface BambooStAXRootMapper

Overrides:

getXmlRootNodeName in class BambooStAXMappingListHelperAbstractImpl<PipelineDefinition,PipelineDefinition>

Returns:

local name of the XML parent node

exportData

public void exportData(@NotNull
                       @NotNull org.codehaus.staxmate.out.SMOutputElement outputElement,
                       ExportDetailsBean exportDetailsBean)
                throws Exception

Description copied from interface: BambooStAXRootMapper

Perform data export

Specified by:

exportData in interface BambooStAXRootMapper

Parameters:

outputElement - parent node for mapper's root node, usually root element of the XML file

Throws:

Exception - when something went wrong

importData

public void importData(@NotNull
                       @NotNull org.codehaus.staxmate.in.SMInputCursor inputCursor)
                throws Exception

Description copied from interface: BambooStAXRootMapper

Perform data import

Specified by:

importData in interface BambooStAXRootMapper

Parameters:

inputCursor - mapper's root node, usually child of root element of the XML file

Throws:

Exception - when something went wrong

createItemInstance

@NotNull
protected @NotNull PipelineDefinition createItemInstance(@NotNull
                                                         @NotNull org.codehaus.staxmate.in.SMInputCursor inputCursor)
                                                  throws Exception

Method returns only placeholder for pipeline data. Final instance is created when type of instance could be determined - so at the end of pipeline element.

Specified by:

createItemInstance in class BambooStAXMappingHelperAbstractImpl<PipelineDefinition,PipelineDefinition>

Parameters:

inputCursor - input cursor that points to the parent node containing object properties

Returns:

Throws:

Exception

XMLStreamException - when something went wrong

exportProperties

protected void exportProperties(@NotNull
                                @NotNull org.codehaus.staxmate.out.SMOutputElement outputElement,
                                @NotNull
                                @NotNull PipelineDefinition object,
                                @NotNull
                                @NotNull org.hibernate.Session session,
                                ExportDetailsBean exportDetailsBean)
                         throws Exception

Description copied from class: BambooStAXMappingHelperAbstractImpl

Export object properties. Implementing classed should override this method to export custom properties.

Overrides:

exportProperties in class BambooStAXMappingHelperAbstractImpl<PipelineDefinition,PipelineDefinition>

Parameters:

outputElement - the parent node

object - object being exported

session - Hibernate session object

Throws:

Exception - when something went wrong

importProperties

protected void importProperties(@NotNull
                                @NotNull PipelineDefinition pipeline,
                                @NotNull
                                @NotNull org.codehaus.staxmate.in.SMInputCursor inputCursor,
                                @NotNull
                                @NotNull org.hibernate.Session session)
                         throws Exception

Description copied from class: BambooStAXMappingHelperAbstractImpl

Import properties to the object. Due to nature of XML parsing this method is called for each child node in the node that was passed to importXml method

Overrides:

importProperties in class BambooStAXMappingHelperAbstractImpl<PipelineDefinition,PipelineDefinition>

Parameters:

pipeline - object being imported

inputCursor - input cursor pointing to the child node of node that was passed to importXml method

session - Hibernate session object

Throws:

Exception - when something went wrong