Class AbstractZipTransformer

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.transformer.AbstractTransformer

org.springframework.integration.zip.transformer.AbstractZipTransformer

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, InitializingBean, ApplicationContextAware, ExpressionCapable, GenericTransformer<Message<?>, Message<?>>, NamedComponent, Transformer

Direct Known Subclasses:

UnZipTransformer, ZipTransformer

public abstract class AbstractZipTransformer
extends AbstractTransformer

Base class for transformers that provide Zip compression.

Since:

6.1

Author:

Gunnar Hillert, Artem Bilan

Field Summary

Fields

Modifier and Type	Field	Description
protected Charset	charset
protected boolean	deleteFiles
protected FileNameGenerator	fileNameGenerator
protected File	workDirectory
protected ZipResultType	zipResultType

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport

EXPRESSION_PARSER, logger

Constructor Summary

Constructors

Constructor	Description
AbstractZipTransformer()

Method Summary

Modifier and Type	Method	Description
protected Object	doTransform(Message<?> message)	Subclasses must implement this method to provide the transformation logic.
protected abstract Object	doZipTransform(Message<?> message)	Subclasses must implement this method to provide the Zip transformation logic.
protected void	onInit()	Subclasses may implement this for initialization logic.
void	setDeleteFiles(boolean deleteFiles)	If the payload is an instance of File, this property specifies whether to delete the File after transformation.
void	setWorkDirectory(File workDirectory)	Set the work-directory.
void	setZipResultType(ZipResultType zipResultType)	Define the format of the data returned after transformation.

Methods inherited from class org.springframework.integration.transformer.AbstractTransformer

transform

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentName, getComponentType, getConversionService, getExpression, getIntegrationProperties, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

Methods inherited from class java.lang.Object

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

Field Details

charset

protected Charset charset

fileNameGenerator

protected FileNameGenerator fileNameGenerator

zipResultType

protected ZipResultType zipResultType

workDirectory

protected File workDirectory

deleteFiles

protected boolean deleteFiles

Constructor Details

AbstractZipTransformer

public AbstractZipTransformer()

Method Details

setDeleteFiles

public void setDeleteFiles(boolean deleteFiles)

If the payload is an instance of File, this property specifies whether to delete the File after transformation. Default is false.

Parameters:

deleteFiles - Defaults to false if not set

setWorkDirectory

public void setWorkDirectory(File workDirectory)

Set the work-directory. The work directory is used when the ZipResultType is set to ZipResultType.FILE. By default, this property is set to the System temporary directory containing a subdirectory "ziptransformer".

Parameters:

workDirectory - Must not be null and must not represent a file.

setZipResultType

public void setZipResultType(ZipResultType zipResultType)

Define the format of the data returned after transformation. Available options are:

• File
• Byte Array

Defaults to ZipResultType.FILE.

Parameters:

zipResultType - Must not be null

onInit

protected void onInit()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class IntegrationObjectSupport

doTransform

protected Object doTransform(Message<?> message)

Description copied from class: AbstractTransformer

Subclasses must implement this method to provide the transformation logic. If the return value is itself a Message, it will be used as the result. Otherwise, any non-null return value will be used as the payload of the result Message.

Specified by:

doTransform in class AbstractTransformer

Parameters:

message - the message and its payload must not be null.

Returns:

The result of the transformation.

doZipTransform

protected abstract Object doZipTransform(Message<?> message)

Subclasses must implement this method to provide the Zip transformation logic.

Parameters:

message - The message will never be null.

Returns:

The result of the Zip transformation.