com.sdl.delivery.deployer.steps

Class TridionUnzipStep

java.lang.Object

com.sdl.delivery.deployer.steps.TridionUnzipStep

All Implemented Interfaces:

ExecutableStep

public class TridionUnzipStep
extends Object
implements ExecutableStep

Web-specific UnzipStep.

This step should run in Bootstrap pipeline in order to resolve action and verbs at the beginning. Verbs are determined by parsing package type from file name (Binary Id) and reading transaction.xml in unzipped content. On the other hand, action is determined by reading instructions.xml in unzipped content.

Once this step unzips the binary file, it stores unzipped content in TridionConstants.DIRECTORY_UNZIP directory in BinaryStorage.

Problematic cases are:

• StepDataConstants.PACKAGE_IN_WAIT is searched through StepDataProvider. If there are multiple entries found for same Execution Id and this key, then an ProcessingException is thrown and execution is stopped.
• Given Binary Id should be the whole file name, including tcm: URI. If file name is not proper, then an ProcessingException is thrown and execution is stopped.
• If wait state is true then BinaryStorage is checked for corresponding wait package. If not found, then an ProcessingException is thrown and execution is stopped.
• If verb can not be resolved, then an ProcessingException is thrown and execution is stopped. Also unzipped content in BinaryStorage is deleted.

The ExecutableStepResult produced by this step contains following properties:

• StepDataConstants.COMMAND_VERBS Verbs resolved from package. Type: java.util.Set<String>
• StepDataConstants.COMMAND_ACTION Action resolved from package. Type: String
• StepDataConstants.PACKAGE_UNZIP_LOCATION Directory where unzipped content is put. Type: String

Field Summary

Fields inherited from interface com.sdl.delivery.deployer.api.processing.pipeline.ExecutableStep

RETRY_POINT_ELEMENT

Constructor Summary

Constructors

Constructor and Description
TridionUnzipStep()

Method Summary

Modifier and Type	Method and Description
void	configure(com.sdl.delivery.configuration.Configuration configuration) Configure the 'Executable Step' with the given configuration.
com.sdl.delivery.deployer.legacy.transport.LegacyTransportStateHelper	getLegacyTransportStateHelper()
ExecutableStepResult	process(ProcessingContext context, StepDataProvider provider) Actual processing logic to execute in the scope of the 'pipeline step'.
void	setLockRepository(org.springframework.integration.jdbc.lock.LockRepository lockRepository)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sdl.delivery.deployer.api.processing.pipeline.ExecutableStep

retryPoint

Constructor Detail

TridionUnzipStep

public TridionUnzipStep()

Method Detail

setLockRepository

@Autowired
public void setLockRepository(org.springframework.integration.jdbc.lock.LockRepository lockRepository)

configure

public void configure(com.sdl.delivery.configuration.Configuration configuration)
               throws com.sdl.delivery.configuration.ConfigurationException

Description copied from interface: ExecutableStep

Configure the 'Executable Step' with the given configuration.

Specified by:

configure in interface ExecutableStep

Parameters:

configuration - The given configuration.

Throws:

com.sdl.delivery.configuration.ConfigurationException

process

public ExecutableStepResult process(ProcessingContext context,
                                    StepDataProvider provider)
                             throws ProcessingException

Description copied from interface: ExecutableStep

Actual processing logic to execute in the scope of the 'pipeline step'.

Specified by:

process in interface ExecutableStep

Parameters:

context - Contains information about current execution.

provider - Provides access to get step data for a specific deployment execution.

Returns:

The result after executing the processing logic.

Throws:

ProcessingException - When something went wrong executing the processing logic.

getLegacyTransportStateHelper

public com.sdl.delivery.deployer.legacy.transport.LegacyTransportStateHelper getLegacyTransportStateHelper()