com.atlassian.jira.config.util
Interface IndexPathManager

All Known Implementing Classes:
IndexPathManager.PropertiesAdaptor, MockIndexPathManager

@PublicApi
public interface IndexPathManager

Responsible for determining the current location of JIRA indexes.


Nested Class Summary
static class IndexPathManager.Directory
           
static class IndexPathManager.Mode
           
static class IndexPathManager.PropertiesAdaptor
          Implementation of IndexPathManager that uses the ApplicationProperties to get the current paths.
 
Field Summary
static String INDEXES_DIR
           
 
Method Summary
 String getChangeHistoryIndexPath()
          Returns the path of JIRA's change history indexes.
 String getCommentIndexPath()
          Returns the path of JIRA's comment indexes.
 String getDefaultIndexRootPath()
          This returns the root index directory that JIRA will use by default, if it is configured to do so.
 String getIndexRootPath()
          Returns the root path of JIRA's indexes.
 String getIssueIndexPath()
          Returns the path of JIRA's issue indexes.
 IndexPathManager.Mode getMode()
           
 String getPluginIndexRootPath()
          Returns the root path of JIRA's plugin indexes.
 String getSharedEntityIndexPath()
          Returns the path of JIRA's shared entity indexes.
 boolean getUseDefaultDirectory()
          Whether we are using the default index directory (within JIRA Home).
 void setIndexRootPath(String indexPath)
          Specify an explicit index root path.
 void setUseDefaultDirectory()
          Specify that the default location within JIRA Home should be used to store indexes.
 

Field Detail

INDEXES_DIR

static final String INDEXES_DIR
Method Detail

getIndexRootPath

String getIndexRootPath()
Returns the root path of JIRA's indexes. If JIRA is configured to "Use the Default Index Directory", then the absolute path of that default directory is returned.

Returns:
the root path of JIRA's indexes

getDefaultIndexRootPath

String getDefaultIndexRootPath()
This returns the root index directory that JIRA will use by default, if it is configured to do so. This directory is a sub-directory of the configured jira-home and is defined in the Atlassian home directory specification to live under [jira-home]/caches/indexes/.

Returns:
the default root index path

getIssueIndexPath

String getIssueIndexPath()
Returns the path of JIRA's issue indexes.

Returns:
the path of JIRA's issue indexes

getCommentIndexPath

String getCommentIndexPath()
Returns the path of JIRA's comment indexes.

Returns:
the path of JIRA's comment indexes

getChangeHistoryIndexPath

String getChangeHistoryIndexPath()
Returns the path of JIRA's change history indexes.

Returns:
the path of JIRA's change history indexes

getPluginIndexRootPath

String getPluginIndexRootPath()
Returns the root path of JIRA's plugin indexes.

NOTE: Each Plugin should create a new directory under this path

Returns:
the root path of JIRA's plugin indexes

getSharedEntityIndexPath

String getSharedEntityIndexPath()
Returns the path of JIRA's shared entity indexes.

Returns:
the path of JIRA's shared entity indexes

setIndexRootPath

void setIndexRootPath(String indexPath)
Specify an explicit index root path.

Parameters:
indexPath - the path to use

setUseDefaultDirectory

void setUseDefaultDirectory()
Specify that the default location within JIRA Home should be used to store indexes.


getUseDefaultDirectory

boolean getUseDefaultDirectory()
Whether we are using the default index directory (within JIRA Home).

Returns:
true if we are using the default index directory (within JIRA Home).

getMode

IndexPathManager.Mode getMode()


Copyright © 2002-2013 Atlassian. All Rights Reserved.