org.mule.extension.compression.internal

Class CompressionOperations

java.lang.Object

org.mule.extension.compression.internal.CompressionOperations

public class CompressionOperations
extends Object

Compression and Decompression operations

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
CompressionOperations()

Method Summary

Modifier and Type	Method and Description
org.mule.runtime.extension.api.runtime.operation.Result<InputStream,Void>	compress(org.mule.runtime.api.metadata.TypedValue<InputStream> content, CompressorStrategy compressor) Compresses a given content using the configured format, ZIP or GZIP.
InputStream	decompress(org.mule.runtime.api.metadata.TypedValue<InputStream> compressed, DecompressorStrategy decompressor) Decompresses a given single entry compressed content which is assumed to be in an specific format (ZIP or GZIP).

Methods inherited from class java.lang.Object

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

Constructor Detail

CompressionOperations

public CompressionOperations()

Method Detail

compress

@MediaType(value="*/*",
           strict=false)
 @Summary(value="Compresses a given content using an specific format")
 @Throws(value=CompressErrorProvider.class)
public org.mule.runtime.extension.api.runtime.operation.Result<InputStream,Void> compress(@Content
                                                                                                                                                                                                                                                              org.mule.runtime.api.metadata.TypedValue<InputStream> content,
                                                                                                                                                                                                                                                              @ParameterDsl(allowReferences=false) @Expression(value=NOT_SUPPORTED)
                                                                                                                                                                                                                                                              CompressorStrategy compressor)

Compresses a given content using the configured format, ZIP or GZIP.

If a problem occur while compressing the content a COULD_NOT_COMPRESS error will be thrown.

Parameters:

content - the content to be compressed

compressor - the compression strategy

decompress

@MediaType(value="*/*",
           strict=false)
 @Throws(value=DecompressErrorProvider.class)
 @Summary(value="Decompresses a single entry compressed content")
public InputStream decompress(@Content
                                                                                                                                                                                               org.mule.runtime.api.metadata.TypedValue<InputStream> compressed,
                                                                                                                                                                                               @ParameterDsl(allowReferences=false) @Expression(value=NOT_SUPPORTED)
                                                                                                                                                                                               DecompressorStrategy decompressor)

Decompresses a given single entry compressed content which is assumed to be in an specific format (ZIP or GZIP).

If the given content is not in the configured format an INVALID_ARCHIVE error will be thrown.

Compressed archives can have multiple entries, this operation can handle only single entry archives because if the archive would contain more than one the operation wouldn't know which should return, if the content has more than one entry an TOO_MANY_ENTRIES error will be thrown. For multiple entry archives use the `extract` operation of this module, which will let you choose only formats that accept multiple entries.

Parameters:

compressed - the content to be decompressed

decompressor - the decompression strategy