com.tridion.transport.transportpackage

Class TransportPackage

java.lang.Object

com.tridion.transport.transportpackage.TransportPackage

All Implemented Interfaces:

com.tridion.transport.ProcessingPackage

public class TransportPackage
extends Object
implements com.tridion.transport.ProcessingPackage

A wrapper object for a transport package file on disk which contains instructions and items to deploy or undeploy.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TransportPackage.FileLocation Class for expressing file and directory pair (tuple).

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEPLOY_ACTION DEPLOY_ACTION.
static String	UNDEPLOY_ACTION UNDEPLOY_ACTION.

Constructor Summary

Constructors

Constructor and Description
TransportPackage(File location) Creates a new instance from an existing transport package file.
TransportPackage(File location, BinaryStorageBase binaryStorage) Creates a new instance from an existing transport package file.
TransportPackage(File workFolder, com.tridion.transport.transportpackage.TransactionHeader header) Creates a new TransportPackage (object and File) with the supplied TransactionHeader.
TransportPackage(File workFolder, com.tridion.transport.transportpackage.TransactionHeader header, BinaryStorageBase binaryStorage) Creates a new TransportPackage (object and File) with the supplied TransactionHeader.
TransportPackage(File workFolder, com.tridion.transport.transportpackage.TransactionHeader header, String definedFolder, String control) Creates a new TransportPackage (object and File) with the supplied TransactionHeader.
TransportPackage(File workFolder, com.tridion.transport.transportpackage.TransactionHeader header, String definedFolder, String control, BinaryStorageBase binaryStorage) Creates a new TransportPackage (object and File) with the supplied TransactionHeader.

Method Summary

Modifier and Type	Method and Description
void	addMetaDataFile(com.tridion.transport.transportpackage.MetaDataFile metaDataFile, String name)
String	getAction() Gets the processor instructions action value.
com.fasterxml.jackson.databind.JsonNode	getBinaryComponentJsonNode(String binaryKey)
com.tridion.transport.transportpackage.json.Binaries	getBinaryInstructions()
Locale	getBinaryLocale(com.fasterxml.jackson.databind.JsonNode componentNode)
BinaryStorageBase	getBinaryStorage()
File	getLocation() Gets the location of this transport package on disk.
com.tridion.transport.transportpackage.MetaDataFile	getMetaData(String type, String name) Gets the meta data for this transport package.
com.tridion.transport.transportpackage.MetaDataFile	getMetaDataFile(String type) Gets the meta data for this transport package.
com.tridion.transport.transportpackage.json.Package	getPackageInstructions()
com.tridion.transport.transportpackage.ProcessorInstructions	getProcessorInstructions()
Optional<String>	getRawContent(TransportPackage transportPackage, com.tridion.transport.transportpackage.json.Item item)
Optional<String>	getSchemaTitle(File schemaFile)
com.tridion.transport.TransactionControlType	getTransactionControl() Gets the transaction header's control value.
com.tridion.transport.transportpackage.TransactionHeader	getTransactionHeader() Gets the transaction header.
TCMURI	getTransactionId() Gets the transaction header's transaction id.
boolean	isDataPipeline()
void	setInstructions(com.tridion.transport.transportpackage.ProcessorInstructions instructions)
void	setTransactionHeader(com.tridion.transport.transportpackage.TransactionHeader transactionHeader) Sets the transaction header for this transport package and writes this to disk.
void	toFile(File writeLocation, String name) Writes the transaction header to disk as XML.
String	toString() Returns a string representation of this object.
<R> R	withResource(TransportPackage.FileLocation pair, Function<? super InputStream,? extends R> function)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tridion.transport.ProcessingPackage

getLocationPath

Field Detail

DEPLOY_ACTION

public static final String DEPLOY_ACTION

DEPLOY_ACTION.

See Also:

Constant Field Values

UNDEPLOY_ACTION

public static final String UNDEPLOY_ACTION

UNDEPLOY_ACTION.

See Also:

Constant Field Values

Constructor Detail

TransportPackage

public TransportPackage(File location)

Creates a new instance from an existing transport package file.

Parameters:

location - An existing transport package file.

TransportPackage

public TransportPackage(File location,
                        BinaryStorageBase binaryStorage)

Creates a new instance from an existing transport package file.

Parameters:

location - An existing transport package file.

binaryStorage - Storage implementation.

TransportPackage

public TransportPackage(File workFolder,
                        com.tridion.transport.transportpackage.TransactionHeader header)

Creates a new TransportPackage (object and File) with the supplied TransactionHeader.

Parameters:

workFolder - The base folder under which to create the transport package file.

header - The transaction header.

TransportPackage

public TransportPackage(File workFolder,
                        com.tridion.transport.transportpackage.TransactionHeader header,
                        BinaryStorageBase binaryStorage)

Creates a new TransportPackage (object and File) with the supplied TransactionHeader.

Parameters:

workFolder - The base folder under which to create the transport package file.

header - The transaction header.

binaryStorage - Storage implementation.

TransportPackage

public TransportPackage(File workFolder,
                        com.tridion.transport.transportpackage.TransactionHeader header,
                        String definedFolder,
                        String control)

Creates a new TransportPackage (object and File) with the supplied TransactionHeader.

Parameters:

workFolder - The base folder under which to create the transport package file.

header - The transaction header.

definedFolder - The location where we're supposed to find the transport package.

control - The name of the control to be used as folder name in case the definedFolder does not exist.

TransportPackage

public TransportPackage(File workFolder,
                        com.tridion.transport.transportpackage.TransactionHeader header,
                        String definedFolder,
                        String control,
                        BinaryStorageBase binaryStorage)

Creates a new TransportPackage (object and File) with the supplied TransactionHeader.

Parameters:

workFolder - The base folder under which to create the transport package file.

header - The transaction header.

definedFolder - The location where we're supposed to find the transport package.

control - The name of the control to be used as folder name in case the definedFolder does not exist.

binaryStorage - Storage implementation.

Method Detail

getLocation

public File getLocation()

Gets the location of this transport package on disk.

Specified by:

getLocation in interface com.tridion.transport.ProcessingPackage

Returns:

The transport package file location.

getTransactionId

public TCMURI getTransactionId()

Gets the transaction header's transaction id.

Returns:

The transaction id.

getTransactionControl

public com.tridion.transport.TransactionControlType getTransactionControl()

Gets the transaction header's control value.

Returns:

The control value.

getTransactionHeader

public com.tridion.transport.transportpackage.TransactionHeader getTransactionHeader()

Gets the transaction header.

Returns:

The transaction header or null if something goes wrong generating this.

setTransactionHeader

public void setTransactionHeader(com.tridion.transport.transportpackage.TransactionHeader transactionHeader)

Sets the transaction header for this transport package and writes this to disk.

Parameters:

transactionHeader - The new transaction header.

getProcessorInstructions

public com.tridion.transport.transportpackage.ProcessorInstructions getProcessorInstructions()

getPackageInstructions

public com.tridion.transport.transportpackage.json.Package getPackageInstructions()

getBinaryInstructions

public com.tridion.transport.transportpackage.json.Binaries getBinaryInstructions()
                                                                           throws ProcessingException

Throws:

ProcessingException

getBinaryLocale

public Locale getBinaryLocale(com.fasterxml.jackson.databind.JsonNode componentNode)

getBinaryComponentJsonNode

public com.fasterxml.jackson.databind.JsonNode getBinaryComponentJsonNode(String binaryKey)

getMetaData

public com.tridion.transport.transportpackage.MetaDataFile getMetaData(String type,
                                                                       String name)

Gets the meta data for this transport package.

Parameters:

type - The type of the meta data.

name - The meta data file name.

Returns:

The meta data or null if the meta data file couldn't be found.

addMetaDataFile

public void addMetaDataFile(com.tridion.transport.transportpackage.MetaDataFile metaDataFile,
                            String name)

setInstructions

public void setInstructions(com.tridion.transport.transportpackage.ProcessorInstructions instructions)

getBinaryStorage

public BinaryStorageBase getBinaryStorage()

toString

public String toString()

Returns a string representation of this object.

Overrides:

toString in class Object

Returns:

A string representation of this object.

toFile

public void toFile(File writeLocation,
                   String name)
            throws IOException

Writes the transaction header to disk as XML.

Parameters:

writeLocation - The file location to be written to.

name - The file name.

Throws:

IOException

getAction

public String getAction()

Gets the processor instructions action value.

Returns:

The action value.

getMetaDataFile

public com.tridion.transport.transportpackage.MetaDataFile getMetaDataFile(String type)

Gets the meta data for this transport package.

Parameters:

type - The type of the meta data.

Returns:

The meta data or null if the meta data file couldn't be found.

isDataPipeline

public boolean isDataPipeline()

Returns:

true if data pipeleine approach should be used.

getSchemaTitle

public Optional<String> getSchemaTitle(File schemaFile)

getRawContent

public Optional<String> getRawContent(TransportPackage transportPackage,
                                      com.tridion.transport.transportpackage.json.Item item)
                               throws ProcessingException

Throws:

ProcessingException

withResource

public <R> R withResource(TransportPackage.FileLocation pair,
                          Function<? super InputStream,? extends R> function)
                   throws ProcessingException

Throws:

ProcessingException