org.apache.solr.core

Class HdfsDirectoryFactory

java.lang.Object

org.apache.solr.core.DirectoryFactory

org.apache.solr.core.CachingDirectoryFactory

org.apache.solr.core.HdfsDirectoryFactory

All Implemented Interfaces:

Closeable, AutoCloseable, SolrInfoMBean, NamedListInitializedPlugin

public class HdfsDirectoryFactory
extends CachingDirectoryFactory
implements SolrInfoMBean

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.solr.core.CachingDirectoryFactory

CachingDirectoryFactory.CacheValue, CachingDirectoryFactory.CloseListener

Nested classes/interfaces inherited from class org.apache.solr.core.DirectoryFactory

DirectoryFactory.DirContext

Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoMBean

SolrInfoMBean.Category

Field Summary

Fields

Modifier and Type	Field and Description
static String	BLOCKCACHE_DIRECT_MEMORY_ALLOCATION
static String	BLOCKCACHE_ENABLED
static String	BLOCKCACHE_GLOBAL
static String	BLOCKCACHE_READ_ENABLED
static String	BLOCKCACHE_SLAB_COUNT
static String	BLOCKCACHE_WRITE_ENABLED
static String	CONFIG_DIRECTORY
static String	HDFS_HOME
static String	KERBEROS_ENABLED
static String	KERBEROS_KEYTAB
static String	KERBEROS_PRINCIPAL
static org.slf4j.Logger	LOG
static Metrics	metrics
static String	NRTCACHINGDIRECTORY_ENABLE
static String	NRTCACHINGDIRECTORY_MAXCACHEMB
static String	NRTCACHINGDIRECTORY_MAXMERGESIZEMB
static String	NUMBEROFBLOCKSPERBANK

Fields inherited from class org.apache.solr.core.CachingDirectoryFactory

byDirectoryCache, byPathCache, closeListeners, removeEntries

Fields inherited from class org.apache.solr.core.DirectoryFactory

IOCONTEXT_NO_CACHE

Constructor Summary

Constructors

Constructor and Description
HdfsDirectoryFactory()

Method Summary

Methods

Modifier and Type	Method and Description
protected Directory	create(String path, LockFactory lockFactory, DirectoryFactory.DirContext dirContext) Creates a new Directory for a given path.
protected LockFactory	createLockFactory(String rawLockType) Creates a new LockFactory for a given path.
boolean	exists(String path) Returns true if a Directory exists for a given path.
SolrInfoMBean.Category	getCategory() Purpose of this Class
String	getConfDir()
String	getDataHome(CoreDescriptor cd)
String	getDescription() Simple one or two line description
URL[]	getDocs() Documentation URL list.
String	getName() Simple common usage name, e.g.
String	getSource() CVS Source, SVN Source, etc
NamedList<?>	getStatistics() Any statistics this instance would like to be publicly available via the Solr Administration interface.
String	getVersion() Simple common usage version, e.g.
void	init(NamedList args)
boolean	isAbsolute(String path)
boolean	isPersistent()
boolean	isSharedStorage()
protected void	removeDirectory(CachingDirectoryFactory.CacheValue cacheValue)
boolean	searchersReserveCommitPoints() If your implementation can count on delete-on-last-close semantics or throws an exception when trying to remove a file in use, return false (eg NFS).

Methods inherited from class org.apache.solr.core.CachingDirectoryFactory

addCloseListener, close, doneWithDirectory, get, getLivePaths, incRef, normalize, release, remove, remove, remove, remove, stripTrailingSlash

Methods inherited from class org.apache.solr.core.DirectoryFactory

empty, move, sizeOf, sizeOfDirectory

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static org.slf4j.Logger LOG

BLOCKCACHE_SLAB_COUNT

public static final String BLOCKCACHE_SLAB_COUNT

See Also:

Constant Field Values

BLOCKCACHE_DIRECT_MEMORY_ALLOCATION

public static final String BLOCKCACHE_DIRECT_MEMORY_ALLOCATION

See Also:

Constant Field Values

BLOCKCACHE_ENABLED

public static final String BLOCKCACHE_ENABLED

See Also:

Constant Field Values

BLOCKCACHE_GLOBAL

public static final String BLOCKCACHE_GLOBAL

See Also:

Constant Field Values

BLOCKCACHE_READ_ENABLED

public static final String BLOCKCACHE_READ_ENABLED

See Also:

Constant Field Values

BLOCKCACHE_WRITE_ENABLED

public static final String BLOCKCACHE_WRITE_ENABLED

See Also:

Constant Field Values

NRTCACHINGDIRECTORY_ENABLE

public static final String NRTCACHINGDIRECTORY_ENABLE

See Also:

Constant Field Values

NRTCACHINGDIRECTORY_MAXMERGESIZEMB

public static final String NRTCACHINGDIRECTORY_MAXMERGESIZEMB

See Also:

Constant Field Values

NRTCACHINGDIRECTORY_MAXCACHEMB

public static final String NRTCACHINGDIRECTORY_MAXCACHEMB

See Also:

Constant Field Values

NUMBEROFBLOCKSPERBANK

public static final String NUMBEROFBLOCKSPERBANK

See Also:

Constant Field Values

KERBEROS_ENABLED

public static final String KERBEROS_ENABLED

See Also:

Constant Field Values

KERBEROS_KEYTAB

public static final String KERBEROS_KEYTAB

See Also:

Constant Field Values

KERBEROS_PRINCIPAL

public static final String KERBEROS_PRINCIPAL

See Also:

Constant Field Values

HDFS_HOME

public static final String HDFS_HOME

See Also:

Constant Field Values

CONFIG_DIRECTORY

public static final String CONFIG_DIRECTORY

See Also:

Constant Field Values

metrics

public static Metrics metrics

Constructor Detail

HdfsDirectoryFactory

public HdfsDirectoryFactory()

Method Detail

init

public void init(NamedList args)

Specified by:

init in interface NamedListInitializedPlugin

Overrides:

init in class CachingDirectoryFactory

createLockFactory

protected LockFactory createLockFactory(String rawLockType)
                                 throws IOException

Description copied from class: DirectoryFactory

Creates a new LockFactory for a given path.

Specified by:

createLockFactory in class DirectoryFactory

Parameters:

rawLockType - A string value as passed in config. Every factory should at least support 'none' to disable locking.

Throws:

IOException - If there is a low-level I/O error.

create

protected Directory create(String path,
               LockFactory lockFactory,
               DirectoryFactory.DirContext dirContext)
                    throws IOException

Description copied from class: DirectoryFactory

Creates a new Directory for a given path.

Specified by:

create in class DirectoryFactory

Throws:

IOException - If there is a low-level I/O error.

exists

public boolean exists(String path)

Description copied from class: DirectoryFactory

Returns true if a Directory exists for a given path.

Overrides:

exists in class CachingDirectoryFactory

removeDirectory

protected void removeDirectory(CachingDirectoryFactory.CacheValue cacheValue)
                        throws IOException

Overrides:

removeDirectory in class CachingDirectoryFactory

Throws:

IOException

isAbsolute

public boolean isAbsolute(String path)

Overrides:

isAbsolute in class DirectoryFactory

Parameters:

path - the path to check

Returns:

true if absolute, as in not relative

isPersistent

public boolean isPersistent()

Specified by:

isPersistent in class DirectoryFactory

Returns:

true if data is kept after close.

isSharedStorage

public boolean isSharedStorage()

Overrides:

isSharedStorage in class DirectoryFactory

Returns:

true if storage is shared.

searchersReserveCommitPoints

public boolean searchersReserveCommitPoints()

Description copied from class: DirectoryFactory

If your implementation can count on delete-on-last-close semantics or throws an exception when trying to remove a file in use, return false (eg NFS). Otherwise, return true. Defaults to returning false.

Overrides:

searchersReserveCommitPoints in class DirectoryFactory

Returns:

true if factory impl requires that Searcher's explicitly reserve commit points.

getDataHome

public String getDataHome(CoreDescriptor cd)
                   throws IOException

Overrides:

getDataHome in class DirectoryFactory

Throws:

IOException

getConfDir

public String getConfDir()

getName

public String getName()

Description copied from interface: SolrInfoMBean

Simple common usage name, e.g. BasicQueryHandler, or fully qualified clas name.

Specified by:

getName in interface SolrInfoMBean

getVersion

public String getVersion()

Description copied from interface: SolrInfoMBean

Simple common usage version, e.g. 2.0

Specified by:

getVersion in interface SolrInfoMBean

getDescription

public String getDescription()

Description copied from interface: SolrInfoMBean

Simple one or two line description

Specified by:

getDescription in interface SolrInfoMBean

getCategory

public SolrInfoMBean.Category getCategory()

Description copied from interface: SolrInfoMBean

Purpose of this Class

Specified by:

getCategory in interface SolrInfoMBean

getSource

public String getSource()

Description copied from interface: SolrInfoMBean

CVS Source, SVN Source, etc

Specified by:

getSource in interface SolrInfoMBean

getDocs

public URL[] getDocs()

Description copied from interface: SolrInfoMBean

Documentation URL list.

Suggested documentation URLs: Homepage for sponsoring project, FAQ on class usage, Design doc for class, Wiki, bug reporting URL, etc...

Specified by:

getDocs in interface SolrInfoMBean

getStatistics

public NamedList<?> getStatistics()

Description copied from interface: SolrInfoMBean

Any statistics this instance would like to be publicly available via the Solr Administration interface.

Any Object type may be stored in the list, but only the toString() representation will be used.

Specified by:

getStatistics in interface SolrInfoMBean