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

Class LocalFetcher

java.lang.Object

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

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

com.norconex.crawler.fs.fetch.impl.local.LocalFetcher

All Implemented Interfaces:

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

public class LocalFetcher
extends AbstractNioFetcher<LocalFetcherConfig>

Fetcher for a local file system, backed by the JDK's default FileSystemProvider. Mounted file systems and mapped drives not requiring special configuration to access can also be considered "local". Paths starting with any of the following will be recognized as local file system:

• file:///some/directory
• file:///C:/some/directory
• /some/directory
• C:\some\directory
• C:/some/directory

Access Control List (ACL)

This fetcher will try to extract access control information for each file of a local file system. If you have no need for them, you can disable acquiring them with LocalFetcherConfig.setAclDisabled(boolean).

Archive files as file systems

Archive files (zip, tar, jar, etc.) are no longer handled by this fetcher. Use ArchiveFetcher instead, which supports both local and remote archives and provides credential configuration for inner remote file systems.

Field Summary

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

PROPERTY

Constructor Summary

Constructors

Constructor	Description
LocalFetcher()

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	fetchMetadata(Doc doc, @NonNull Path path, @NonNull BasicFileAttributes attrs)
LocalFetcherConfig	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, getOrOpenFileSystem

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

accept, accept, fetcherStartup

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

LocalFetcher

public LocalFetcher()

Method Details

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<LocalFetcherConfig>

Parameters:

fetchRequest - the fetch request to evaluate (never null)

Returns:

true if accepted

resolvePath

protected Path resolvePath(String reference)

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<LocalFetcherConfig>

Parameters:

reference - the reference to resolve

Returns:

the resolved path

fetchMetadata

protected void fetchMetadata(Doc doc,
 @NonNull
 @NonNull Path path,
 @NonNull
 @NonNull BasicFileAttributes attrs)
                      throws IOException

Overrides:

fetchMetadata in class AbstractNioFetcher<LocalFetcherConfig>

Throws:

IOException

toString

public String toString()

Overrides:

toString in class AbstractNioFetcher<LocalFetcherConfig>

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractNioFetcher<LocalFetcherConfig>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class AbstractNioFetcher<LocalFetcherConfig>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractNioFetcher<LocalFetcherConfig>

getConfiguration

public LocalFetcherConfig getConfiguration()