Package org.apache.tika.pipes.pipesiterator.s3

Class S3PipesIterator

java.lang.Object

org.apache.tika.config.ConfigBase

org.apache.tika.pipes.pipesiterator.PipesIterator

org.apache.tika.pipes.pipesiterator.s3.S3PipesIterator

All Implemented Interfaces:

Iterable<org.apache.tika.pipes.FetchEmitTuple>, Callable<Integer>, org.apache.tika.config.Initializable

public class S3PipesIterator
extends org.apache.tika.pipes.pipesiterator.PipesIterator
implements org.apache.tika.config.Initializable

Field Summary

Fields inherited from class org.apache.tika.pipes.pipesiterator.PipesIterator

COMPLETED_SEMAPHORE, DEFAULT_MAX_WAIT_MS, DEFAULT_QUEUE_SIZE

Constructor Summary

Constructors

Constructor	Description
S3PipesIterator()

Method Summary

Modifier and Type	Method	Description
void	checkInitialization(org.apache.tika.config.InitializableProblemHandler problemHandler)
protected void	enqueue()
void	initialize(Map<String,org.apache.tika.config.Param> params)	This initializes the s3 client.
void	setAccessKey(String accessKey)
void	setBucket(String bucket)
void	setCredentialsProvider(String credentialsProvider)
void	setEndpointConfigurationService(String endpointConfigurationService)
void	setFileNamePattern(String fileNamePattern)
void	setFileNamePattern(Pattern fileNamePattern)
void	setMaxConnections(int maxConnections)
void	setPathStyleAccessEnabled(boolean pathStyleAccessEnabled)
void	setPrefix(String prefix)
void	setProfile(String profile)
void	setRegion(String region)
void	setSecretKey(String secretKey)

Methods inherited from class org.apache.tika.pipes.pipesiterator.PipesIterator

build, call, getEmitterName, getFetcherName, getHandlerConfig, getOnParseException, iterator, setEmitterName, setFetcherName, setHandlerType, setMaxEmbeddedResources, setMaxWaitMs, setOnParseException, setOnParseException, setParseMode, setParseMode, setQueueSize, setThrowOnWriteLimitReached, setWriteLimit, tryToAdd

Methods inherited from class org.apache.tika.config.ConfigBase

buildComposite, buildComposite, buildSingle, buildSingle, configure, handleSettings

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

S3PipesIterator

public S3PipesIterator()

Method Detail

setEndpointConfigurationService

@Field
public void setEndpointConfigurationService(String endpointConfigurationService)

setBucket

@Field
public void setBucket(String bucket)

setRegion

@Field
public void setRegion(String region)

setProfile

@Field
public void setProfile(String profile)

setPrefix

@Field
public void setPrefix(String prefix)

setAccessKey

@Field
public void setAccessKey(String accessKey)

setMaxConnections

@Field
public void setMaxConnections(int maxConnections)

setSecretKey

@Field
public void setSecretKey(String secretKey)

setCredentialsProvider

@Field
public void setCredentialsProvider(String credentialsProvider)

setFileNamePattern

@Field
public void setFileNamePattern(String fileNamePattern)

setFileNamePattern

@Field
public void setFileNamePattern(Pattern fileNamePattern)

setPathStyleAccessEnabled

@Field
public void setPathStyleAccessEnabled(boolean pathStyleAccessEnabled)

initialize

public void initialize(Map<String,org.apache.tika.config.Param> params)
                throws org.apache.tika.exception.TikaConfigException

This initializes the s3 client. Note, we wrap S3's RuntimeExceptions, e.g. AmazonClientException in a TikaConfigException.

Specified by:

initialize in interface org.apache.tika.config.Initializable

Overrides:

initialize in class org.apache.tika.pipes.pipesiterator.PipesIterator

Parameters:

params - params to use for initialization

Throws:

org.apache.tika.exception.TikaConfigException

checkInitialization

public void checkInitialization(org.apache.tika.config.InitializableProblemHandler problemHandler)
                         throws org.apache.tika.exception.TikaConfigException

Specified by:

checkInitialization in interface org.apache.tika.config.Initializable

Overrides:

checkInitialization in class org.apache.tika.pipes.pipesiterator.PipesIterator

Throws:

org.apache.tika.exception.TikaConfigException

enqueue

protected void enqueue()
                throws InterruptedException,
                       IOException,
                       TimeoutException

Specified by:

enqueue in class org.apache.tika.pipes.pipesiterator.PipesIterator

Throws:

InterruptedException

IOException

TimeoutException