Package org.apache.tika.pipes.fetcher.azblob

Class AZBlobFetcher

java.lang.Object

org.apache.tika.pipes.fetcher.AbstractFetcher

org.apache.tika.pipes.fetcher.azblob.AZBlobFetcher

All Implemented Interfaces:

Initializable, Fetcher

public class AZBlobFetcher
extends AbstractFetcher
implements Initializable

Fetches files from Azure blob storage. There are two modes: 1) If you are only using one endpoint and one sas token and one container, configure those in the config file. In this case, your fetchKey will be the path in the container to the blob. 2) If you have different endpoints or sas tokens or containers across your requests, your fetchKey will be the complete SAS url pointing to the blob.

Constructor Summary

Constructors

Constructor	Description
AZBlobFetcher()

Method Summary

Modifier and Type	Method	Description
void	checkInitialization(InitializableProblemHandler problemHandler)
InputStream	fetch(String fetchKey, Metadata metadata)
void	initialize(Map<String,Param> params)	This initializes the az blob container client
void	setContainer(String container)
void	setEndpoint(String endpoint)
void	setExtractUserMetadata(boolean extractUserMetadata)	Whether or not to extract user metadata from the blob object
void	setSasToken(String sasToken)
void	setSpoolToTemp(boolean spoolToTemp)

Methods inherited from class org.apache.tika.pipes.fetcher.AbstractFetcher

getName, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

AZBlobFetcher

public AZBlobFetcher()

Method Detail

fetch

public InputStream fetch(String fetchKey,
                         Metadata metadata)
                  throws TikaException,
                         IOException

Specified by:

fetch in interface Fetcher

Throws:

TikaException

IOException

setSpoolToTemp

@Field
public void setSpoolToTemp(boolean spoolToTemp)

setSasToken

@Field
public void setSasToken(String sasToken)

setEndpoint

@Field
public void setEndpoint(String endpoint)

setContainer

@Field
public void setContainer(String container)

setExtractUserMetadata

@Field
public void setExtractUserMetadata(boolean extractUserMetadata)

Whether or not to extract user metadata from the blob object

Parameters:

extractUserMetadata -

initialize

public void initialize(Map<String,Param> params)
                throws TikaConfigException

This initializes the az blob container client

Specified by:

initialize in interface Initializable

Parameters:

params - params to use for initialization

Throws:

TikaConfigException

checkInitialization

public void checkInitialization(InitializableProblemHandler problemHandler)
                         throws TikaConfigException

Specified by:

checkInitialization in interface Initializable

Parameters:

problemHandler - if there is a problem and no custom initializableProblemHandler has been configured via Initializable parameters, this is called to respond.

Throws:

TikaConfigException