public class

MockIndexPathManager

extends Object
implements IndexPathManager
java.lang.Object
   ↳ com.atlassian.jira.config.util.MockIndexPathManager

Summary

Constants
String DEFAULT_PATH
[Expand]
Inherited Fields
From interface com.atlassian.jira.config.util.IndexPathManager
Public Constructors
MockIndexPathManager()
MockIndexPathManager(String path)
Public Methods
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.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.config.util.IndexPathManager

Constants

public static final String DEFAULT_PATH

Constant Value: "/a/b/index/path"

Public Constructors

public MockIndexPathManager ()

public MockIndexPathManager (String path)

Public Methods

public String getChangeHistoryIndexPath ()

Returns the path of JIRA's change history indexes.

Returns
  • the path of JIRA's change history indexes

public String getCommentIndexPath ()

Returns the path of JIRA's comment indexes.

Returns
  • the path of JIRA's comment indexes

public 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

public 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

public String getIssueIndexPath ()

Returns the path of JIRA's issue indexes.

Returns
  • the path of JIRA's issue indexes

public IndexPathManager.Mode getMode ()

public 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

public String getSharedEntityIndexPath ()

Returns the path of JIRA's shared entity indexes.

Returns
  • the path of JIRA's shared entity indexes

public 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).

public void setIndexRootPath (String indexPath)

Specify an explicit index root path.

Parameters
indexPath the path to use

public void setUseDefaultDirectory ()

Specify that the default location within JIRA Home should be used to store indexes.