com.exalead.papi.framework.operations.container

Class ContainerRecursiveProcessor<SKey extends Key>

java.lang.Object

com.exalead.papi.framework.operations.container.ContainerRecursiveProcessor<SKey>

All Implemented Interfaces:

ConnectorContainerHelper.ContainerConnectorTarget, ConnectorInterface

Direct Known Subclasses:

com.exalead.papi.connectors.filesystem.FilesystemContainerRecursiveProcessor

public class ContainerRecursiveProcessor<SKey extends Key>
extends java.lang.Object
implements ConnectorContainerHelper.ContainerConnectorTarget

ContainerRecursiveProcessor allows to process a document content when the underlying content is a container (ZIP file, PST file..)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ContainerRecursiveProcessor.ContainerHelper Our ConnectorContainerHelper version, allowing to handle filtering and interactions between parent and child.
protected class	ContainerRecursiveProcessor.ContainerPath Overridden ConnectorContainerPath class for root stream.

Field Summary

Fields

Modifier and Type	Field and Description
protected GenericContainerMultiThreadedConnector<SKey>	connector
protected MIMEFilter	containerFilter
protected int	containerTimeoutFetch
protected int	containerTimeoutProcess
protected MIMEFilter	cPathStopFilter
long	fetchSizeLimit
protected ConnectorContainerHelper	helper
protected FileNameFilter	itemFilenameFilter
protected MIMEFilter	itemFilter
protected com.exalead.papi.framework.operations.container.ContainerMainPartFilters	mainPartFilters
protected long	maxInputSize

Constructor Summary

Constructors

Constructor and Description
ContainerRecursiveProcessor(GenericContainerMultiThreadedConnector<SKey> connector) Build a new ContainerRecursiveProcessor class.

Method Summary

Modifier and Type	Method and Description
protected void	addDocument(Document document)
Document	buildDocument(java.lang.String uri, java.lang.String stamp, PartContainer partContainer, MetaContainer metaContainer) Build a Document.
void	checkAbortingOperation() Check the current connector status and, if an aborting command was sent, throws an ConnectorAbortingException exception.
Document	fetch(SKey rootKey, java.lang.String uri) Fetch a container item.
Document	fetch(java.lang.String uri, java.lang.String[] securityTokens, boolean shouldCheckSecurityTokens) Fetch a document.
Document	fetchInternal(java.lang.String uri, java.lang.String[] securityTokens, boolean shouldCheckSecurityTokens) Fetch a document.
static java.util.Map<java.lang.String,java.lang.String>	getConnectorMetas() Get connector-specific metadata
MetaContainer	getDocumentSecurityTokens(java.lang.String uri) Get security tokens.
MetaContainer	getDocumentSecurityTokensInternal(java.lang.String uri) Get security tokens.
org.apache.log4j.Logger	getLogger() Get logger.
protected ConnectorRootStream	getRootItem(SKey key)
protected ConnectorRootStream	getRootItem(SKey key, boolean checkSize)
protected ConnectorRootStream	getRootItem(SKey key, java.lang.String uri)
protected void	log(org.apache.log4j.Level level, java.lang.String msg)
protected void	log(org.apache.log4j.Level level, java.lang.String msg, java.lang.Throwable thrown)
void	onScanAborted() Called by the framework when scan abort is requested.
void	onScanResumed() Called by the framework when scan resume is requested.
void	onScanSuspended() Called by the framework when scan suspend is requested.
protected void	process(PushAPI papi, ConnectorRootStream co)
void	process(PushAPI papi, SKey key) Scan recursively a container (mono-threaded) by its key.
protected static void	safeClose(java.io.Closeable obj) Close a Closeable object, ignoring any IOException.
void	scan(PushAPI papi, java.lang.String scanMode, java.lang.Object scanModeConfig) Scan a connector.
void	scanInternal(ConnectorContainerHelper.ContainerPushAPI papi, java.lang.String scanMode, java.lang.Object scanModeConfig) Scan a connector.
void	selfAbortScan(java.lang.String reason) Stop current Synchronization

Methods inherited from class java.lang.Object

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

Field Detail

helper

protected final ConnectorContainerHelper helper

connector

protected GenericContainerMultiThreadedConnector<SKey extends Key> connector

containerFilter

protected MIMEFilter containerFilter

cPathStopFilter

protected MIMEFilter cPathStopFilter

mainPartFilters

protected com.exalead.papi.framework.operations.container.ContainerMainPartFilters mainPartFilters

itemFilter

protected MIMEFilter itemFilter

itemFilenameFilter

protected FileNameFilter itemFilenameFilter

maxInputSize

protected long maxInputSize

containerTimeoutProcess

protected int containerTimeoutProcess

containerTimeoutFetch

protected int containerTimeoutFetch

fetchSizeLimit

public long fetchSizeLimit

Constructor Detail

ContainerRecursiveProcessor

public ContainerRecursiveProcessor(GenericContainerMultiThreadedConnector<SKey> connector)

Build a new ContainerRecursiveProcessor class.

Parameters:

connector - the upstream MultiThreadedConnector class

Method Detail

fetchInternal

public Document fetchInternal(java.lang.String uri,
                              java.lang.String[] securityTokens,
                              boolean shouldCheckSecurityTokens)
                       throws java.lang.Exception

Description copied from interface: ConnectorContainerHelper.ContainerConnectorTarget

Fetch a document. This method is called by the framework for fetch operations.

Specified by:

fetchInternal in interface ConnectorContainerHelper.ContainerConnectorTarget

Parameters:

uri - The document URI.

securityTokens - User security tokens.

shouldCheckSecurityTokens - Should secutiry tokens be checked ?

Returns:

The document.

Throws:

java.lang.Exception - upon error.

getDocumentSecurityTokensInternal

public MetaContainer getDocumentSecurityTokensInternal(java.lang.String uri)
                                                throws java.io.IOException

Description copied from interface: ConnectorContainerHelper.ContainerConnectorTarget

Get security tokens.

Specified by:

getDocumentSecurityTokensInternal in interface ConnectorContainerHelper.ContainerConnectorTarget

Parameters:

uri - The document URI.

Returns:

The security tokens.

Throws:

java.io.IOException

getLogger

public org.apache.log4j.Logger getLogger()

Description copied from interface: ConnectorContainerHelper.ContainerConnectorTarget

Get logger.

Specified by:

getLogger in interface ConnectorContainerHelper.ContainerConnectorTarget

Returns:

The logger.

scanInternal

public void scanInternal(ConnectorContainerHelper.ContainerPushAPI papi,
                         java.lang.String scanMode,
                         java.lang.Object scanModeConfig)
                  throws java.lang.Exception

Description copied from interface: ConnectorContainerHelper.ContainerConnectorTarget

Scan a connector.

Specified by:

scanInternal in interface ConnectorContainerHelper.ContainerConnectorTarget

Parameters:

papi - The PushAPI to be used to interact with the Push Server.

scanMode - The scan mode

scanModeConfig - Scan mode configuration

Throws:

java.lang.Exception - Upon error

checkAbortingOperation

public void checkAbortingOperation()
                            throws ConnectorAbortingException

Description copied from interface: ConnectorInterface

Check the current connector status and, if an aborting command was sent, throws an ConnectorAbortingException exception. Note: this function calls getStatus() and ensures the state is not ConnectorStatus.ABORTING

Specified by:

checkAbortingOperation in interface ConnectorInterface

Throws:

ConnectorAbortingException

fetch

public Document fetch(java.lang.String uri,
                      java.lang.String[] securityTokens,
                      boolean shouldCheckSecurityTokens)
               throws java.lang.Exception

Description copied from interface: ConnectorInterface

Fetch a document.

Specified by:

fetch in interface ConnectorInterface

Parameters:

uri - The document URI.

securityTokens - User security tokens.

shouldCheckSecurityTokens - Should security tokens be checked ?

Returns:

The document.

Throws:

java.lang.Exception - upon error.

getDocumentSecurityTokens

public MetaContainer getDocumentSecurityTokens(java.lang.String uri)
                                        throws java.io.IOException

Description copied from interface: ConnectorInterface

Get security tokens.

Specified by:

getDocumentSecurityTokens in interface ConnectorInterface

Parameters:

uri - The document URI.

Returns:

The security tokens.

Throws:

java.io.IOException

scan

public void scan(PushAPI papi,
                 java.lang.String scanMode,
                 java.lang.Object scanModeConfig)
          throws java.lang.Exception

Description copied from interface: ConnectorInterface

Scan a connector.

Specified by:

scan in interface ConnectorInterface

Parameters:

papi - The PushAPI to be used to interact with the Push Server.

scanMode - The scan mode

scanModeConfig - Scan mode configuration

Throws:

java.lang.Exception - Upon error

selfAbortScan

public void selfAbortScan(java.lang.String reason)

Description copied from interface: ConnectorInterface

Stop current Synchronization

Specified by:

selfAbortScan in interface ConnectorInterface

Parameters:

reason - the reason why the abort was issued ; may be null

safeClose

protected static void safeClose(java.io.Closeable obj)

Close a Closeable object, ignoring any IOException.

process

public void process(PushAPI papi,
                    SKey key)

Scan recursively a container (mono-threaded) by its key. The given key must reference a valid container (ZIP item, PST item..) Handle updates if the container was already processed The processing is recursive, and done synchronously with the Push API.

Parameters:

key - The connector's key to process

fetch

public Document fetch(SKey rootKey,
                      java.lang.String uri)
               throws java.lang.Exception

Fetch a container item.

Parameters:

rootKey - the root key of the top level physical container

uri - the uri of the container item to be fetched

Throws:

java.lang.Exception

process

protected void process(PushAPI papi,
                       ConnectorRootStream co)
                throws java.lang.Exception

Throws:

java.lang.Exception

addDocument

protected void addDocument(Document document)
                    throws PushAPIException

Throws:

PushAPIException

getRootItem

protected ConnectorRootStream getRootItem(SKey key,
                                          boolean checkSize)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getRootItem

protected ConnectorRootStream getRootItem(SKey key)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getRootItem

protected ConnectorRootStream getRootItem(SKey key,
                                          java.lang.String uri)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getConnectorMetas

public static java.util.Map<java.lang.String,java.lang.String> getConnectorMetas()

Get connector-specific metadata

buildDocument

public Document buildDocument(java.lang.String uri,
                              java.lang.String stamp,
                              PartContainer partContainer,
                              MetaContainer metaContainer)
                       throws PushAPIException

Description copied from interface: ConnectorContainerHelper.ContainerConnectorTarget

Build a Document. This function is called by the framework each time a container document needs to be created.

Specified by:

buildDocument in interface ConnectorContainerHelper.ContainerConnectorTarget

Parameters:

uri - Document URI

stamp - Document stamp

partContainer - Document parts container

metaContainer - Document meta container

Returns:

The created document

Throws:

PushAPIException - Upon error

log

protected void log(org.apache.log4j.Level level,
                   java.lang.String msg)

log

protected void log(org.apache.log4j.Level level,
                   java.lang.String msg,
                   java.lang.Throwable thrown)

onScanAborted

public void onScanAborted()

Description copied from interface: ConnectorInterface

Called by the framework when scan abort is requested. This method must not change the state of the connector, only wake up some calls which might be blocking. The scan will only be considered as aborted when the scan() method has returned.

Specified by:

onScanAborted in interface ConnectorInterface

onScanSuspended

public void onScanSuspended()
                     throws java.lang.Exception

Description copied from interface: ConnectorInterface

Called by the framework when scan suspend is requested. This method must not change the state of the connector, only wake up some calls which might be blocking. It is then the responsibility of the connector to set the status of the connector to SUSPENDED when effectively taken into account.

Specified by:

onScanSuspended in interface ConnectorInterface

Throws:

java.lang.Exception

onScanResumed

public void onScanResumed()
                   throws java.lang.Exception

Description copied from interface: ConnectorInterface

Called by the framework when scan resume is requested. This method must not change the state of the connector, only wake up some calls which might be blocking. It is then the responsibility of the connector to set the status of the connector to WORKING when effectively taken into account.

Specified by:

onScanResumed in interface ConnectorInterface

Throws:

java.lang.Exception