org.alfresco.repo.content.transform

Class ArchiveContentTransformer

java.lang.Object

org.alfresco.repo.content.transform.ContentTransformerHelper

org.alfresco.repo.content.transform.AbstractContentTransformerLimits

org.alfresco.repo.content.transform.AbstractContentTransformer2

org.alfresco.repo.content.transform.AbstractRemoteContentTransformer

org.alfresco.repo.content.transform.TikaPoweredContentTransformer

org.alfresco.repo.content.transform.ArchiveContentTransformer

All Implemented Interfaces:

ContentWorker, ContentTransformer, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

public class ArchiveContentTransformer
extends TikaPoweredContentTransformer

This class transforms archive files (zip, tar etc) to text, which enables indexing and searching of archives as well as webpreviewing. The transformation can simply list the names of the entries within the archive, or it can also include the textual content of the entries themselves. The former is suggested for web preview, the latter for indexing. This behaviour is controlled by the recurse flag.

Since:

3.4

Author:

Neil McErlean, Nick Burch

Field Summary

Fields

Modifier and Type	Field and Description
static ArrayList<String>	SUPPORTED_MIMETYPES We support all the archive mimetypes that the Tika package parser can handle

Fields inherited from class org.alfresco.repo.content.transform.TikaPoweredContentTransformer

documentSelector, LINE_BREAK, sourceMimeTypes, WRONG_FORMAT_MESSAGE_ID

Fields inherited from class org.alfresco.repo.content.transform.AbstractContentTransformerLimits

transformerDebug

Fields inherited from class org.alfresco.repo.content.transform.ContentTransformerHelper

transformerConfig

Constructor Summary

Constructors

Constructor and Description
ArchiveContentTransformer()

Method Summary

Modifier and Type	Method and Description
protected org.apache.tika.parser.ParseContext	buildParseContext(org.apache.tika.metadata.Metadata metadata, String targetMimeType, TransformationOptions options) By default returns a ParseContent that does not recurse
protected org.apache.tika.parser.Parser	getParser() Returns the correct Tika Parser to process the document.
protected String	getTransform()
void	setIncludeContents(String includeContents)
void	setTikaConfig(org.apache.tika.config.TikaConfig tikaConfig) Injects the TikaConfig to use
protected void	transformRemote(RemoteTransformerClient remoteTransformerClient, org.alfresco.service.cmr.repository.ContentReader reader, org.alfresco.service.cmr.repository.ContentWriter writer, TransformationOptions options, String sourceMimetype, String targetMimetype, String sourceExtension, String targetExtension, String targetEncoding)

Methods inherited from class org.alfresco.repo.content.transform.TikaPoweredContentTransformer

getComments, getContentHandler, getDocumentSelector, getLogger, isTransformableMimetype, setDocumentSelector, transformLocal

Methods inherited from class org.alfresco.repo.content.transform.AbstractRemoteContentTransformer

afterPropertiesSet, isAvailable, isTransformable, register, setAvailable, setRemoteTransformerClient, transformInternal

Methods inherited from class org.alfresco.repo.content.transform.AbstractContentTransformer2

checkTransformable, getExecutorService, getRetryTransformOnDifferentMimeType, getStrictMimeTypeCheck, getTransformationTime, getTransformationTime, isTransformationLimitedInternally, recordError, recordTime, recordTime, setAdditionalThreadTimout, setExecutorService, setRegisterTransformer, setRegistry, setRetryTransformOnDifferentMimeType, setStrictMimeTypeCheck, setUseTimeoutThread, toString, transform, transform, transform

Methods inherited from class org.alfresco.repo.content.transform.AbstractContentTransformerLimits

getLimits, getLimits, getLimits, getMaxPages, getMaxSourceSizeKBytes, getMaxSourceSizeKBytes, getPageLimit, getReadLimitKBytes, getReadLimitTimeMs, getTimeoutMs, isPageLimitSupported, isTransformable, isTransformableSize, setLimits, setMaxPages, setMaxSourceSizeKBytes, setMimetypeLimits, setPageLimit, setPageLimitsSupported, setReaderLimits, setReadLimitKBytes, setReadLimitTimeMs, setTimeoutMs, setTransformerDebug

Methods inherited from class org.alfresco.repo.content.transform.ContentTransformerHelper

deprecatedSetter, equals, getBeanName, getCommentsOnlySupports, getExtensionOrAny, getMimetype, getMimetypeService, getName, getSimpleName, hashCode, isExplicitTransformation, isSupportedTransformation, onlySupports, setBeanName, setExplicitTransformations, setMimetypeService, setSupportedTransformations, setTransformerConfig, setUnsupportedTransformations

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.alfresco.repo.content.transform.ContentTransformer

getName, isExplicitTransformation

Field Detail

SUPPORTED_MIMETYPES

public static ArrayList<String> SUPPORTED_MIMETYPES

We support all the archive mimetypes that the Tika package parser can handle

Constructor Detail

ArchiveContentTransformer

public ArchiveContentTransformer()

Method Detail

setTikaConfig

public void setTikaConfig(org.apache.tika.config.TikaConfig tikaConfig)

Injects the TikaConfig to use

Parameters:

tikaConfig - The Tika Config to use

setIncludeContents

public void setIncludeContents(String includeContents)

getParser

protected org.apache.tika.parser.Parser getParser()

Description copied from class: TikaPoweredContentTransformer

Returns the correct Tika Parser to process the document. If you don't know which you want, use TikaAutoContentTransformer which makes use of the Tika auto-detection.

Specified by:

getParser in class TikaPoweredContentTransformer

buildParseContext

protected org.apache.tika.parser.ParseContext buildParseContext(org.apache.tika.metadata.Metadata metadata,
                                                                String targetMimeType,
                                                                TransformationOptions options)

Description copied from class: TikaPoweredContentTransformer

By default returns a ParseContent that does not recurse

Overrides:

buildParseContext in class TikaPoweredContentTransformer

getTransform

protected String getTransform()

Specified by:

getTransform in class TikaPoweredContentTransformer

transformRemote

protected void transformRemote(RemoteTransformerClient remoteTransformerClient,
                               org.alfresco.service.cmr.repository.ContentReader reader,
                               org.alfresco.service.cmr.repository.ContentWriter writer,
                               TransformationOptions options,
                               String sourceMimetype,
                               String targetMimetype,
                               String sourceExtension,
                               String targetExtension,
                               String targetEncoding)
                        throws Exception

Overrides:

transformRemote in class TikaPoweredContentTransformer

Throws:

Exception