Package com.norconex.crawler.fs.fetch.impl.sftp

Class SftpFetcher

java.lang.Object

com.norconex.crawler.core.fetch.AbstractFetcher<SftpFetcherConfig>

com.norconex.crawler.fs.fetch.impl.AbstractNioFetcher<SftpFetcherConfig>

com.norconex.crawler.fs.fetch.impl.sftp.SftpFetcher

All Implemented Interfaces:

Configurable<SftpFetcherConfig>, EventListener<Event>, Fetcher, EventListener, Consumer<Event>

public class SftpFetcher
extends AbstractNioFetcher<SftpFetcherConfig>

SFTP fetcher (sftp://), backed by the sftp-fs NIO.2 file system provider.

See Also:

• FtpFetcher

Field Summary

Fields inherited from interface com.norconex.commons.lang.config.Configurable

PROPERTY

Constructor Summary

Constructors

Constructor	Description
SftpFetcher()

Method Summary

Modifier and Type	Method	Description
protected boolean	acceptRequest(@NonNull FetchRequest fetchRequest)	Optional method for subclasses to override when in need for additional acceptance logic beyond reference filters (which this abstract class provides).
protected boolean	canEqual(Object other)
boolean	equals(Object o)
protected void	fetcherStartup(CrawlerSession crawler)	Invoked once per fetcher instance, when the crawler starts.
SftpFetcherConfig	getConfiguration()
int	hashCode()
protected Path	resolvePath(String reference)	Resolves a crawler reference (as found on Doc.getReference()) into a NIO.2 Path.
String	toString()

Methods inherited from class com.norconex.crawler.fs.fetch.impl.AbstractNioFetcher

fetch, fetchChildPaths, fetchContent, fetcherShutdown, fetchFileObject, fetchMetadata, getOrOpenFileSystem

Methods inherited from class com.norconex.crawler.core.fetch.AbstractFetcher

accept, accept

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Consumer

andThen

Constructor Details

SftpFetcher

public SftpFetcher()

Method Details

fetcherStartup

protected void fetcherStartup(CrawlerSession crawler)

Description copied from class: AbstractFetcher

Invoked once per fetcher instance, when the crawler starts. Default implementation does nothing.

Overrides:

fetcherStartup in class AbstractFetcher<SftpFetcherConfig>

Parameters:

crawler - crawler

acceptRequest

protected boolean acceptRequest(@NonNull
 @NonNull FetchRequest fetchRequest)

Description copied from class: AbstractFetcher

Optional method for subclasses to override when in need for additional acceptance logic beyond reference filters (which this abstract class provides). This method is only invoked if there are no reference filters configured on this class, or all of them accepts the request document. Default implementation does nothing (always return true).

Overrides:

acceptRequest in class AbstractFetcher<SftpFetcherConfig>

Parameters:

fetchRequest - the fetch request to evaluate (never null)

Returns:

true if accepted

resolvePath

protected Path resolvePath(String reference)
                    throws IOException

Description copied from class: AbstractNioFetcher

Resolves a crawler reference (as found on Doc.getReference()) into a NIO.2 Path.

Specified by:

resolvePath in class AbstractNioFetcher<SftpFetcherConfig>

Parameters:

reference - the reference to resolve

Returns:

the resolved path

Throws:

IOException - if the reference cannot be resolved

toString

public String toString()

Overrides:

toString in class AbstractNioFetcher<SftpFetcherConfig>

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractNioFetcher<SftpFetcherConfig>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class AbstractNioFetcher<SftpFetcherConfig>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractNioFetcher<SftpFetcherConfig>

getConfiguration

public SftpFetcherConfig getConfiguration()