com.atlassian.jira.config.util
Interface IndexPathService

All Known Implementing Classes:

DefaultIndexPathService

public interface IndexPathService

Service that provides access to JIRA's Lucene indexing paths. Only System Administrators have sufficient privileges to see these as they are all host-OS file paths.

Since:

v4.0

See Also:

IndexPathManager

Method Summary

String	getCommentIndexPath(JiraServiceContext serviceContext) Returns the path of JIRA's comment indexes.
String	getIndexRootPath(JiraServiceContext serviceContext) Returns the root path of JIRA's indexes.
String	getIssueIndexPath(JiraServiceContext serviceContext) Returns the path of JIRA's issue indexes.
String	getPluginIndexRootPath(JiraServiceContext serviceContext) Returns the root path of JIRA's plugin indexes.
String	getSharedEntityIndexPath(JiraServiceContext serviceContext) Returns the path of JIRA's shared entity indexes.
void	setIndexRootPath(JiraServiceContext serviceContext, String indexPath) Specify an explicit (custom) index root path.
void	setUseDefaultDirectory(JiraServiceContext serviceContext) Specify that the default location within JiraHome should be used to store indexes.

Method Detail

getIndexRootPath

String getIndexRootPath(JiraServiceContext serviceContext)

Returns the root path of JIRA's indexes.

Parameters:

serviceContext - The JiraServiceContext

Returns:

the root path of JIRA's indexes.

getIssueIndexPath

String getIssueIndexPath(JiraServiceContext serviceContext)

Returns the path of JIRA's issue indexes.

Parameters:

serviceContext - The JiraServiceContext

Returns:

the path of JIRA's issue indexes.

getCommentIndexPath

String getCommentIndexPath(JiraServiceContext serviceContext)

Returns the path of JIRA's comment indexes.

Parameters:

serviceContext - The JiraServiceContext

Returns:

the path of JIRA's comment indexes.

getPluginIndexRootPath

String getPluginIndexRootPath(JiraServiceContext serviceContext)

Returns the root path of JIRA's plugin indexes.

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

Parameters:

serviceContext - The JiraServiceContext

Returns:

the root path of JIRA's plugin indexes.

getSharedEntityIndexPath

String getSharedEntityIndexPath(JiraServiceContext serviceContext)

Returns the path of JIRA's shared entity indexes.

Parameters:

serviceContext - The JiraServiceContext

Returns:

the path of JIRA's shared entity indexes.

setIndexRootPath

void setIndexRootPath(JiraServiceContext serviceContext,
                      String indexPath)

Specify an explicit (custom) index root path.

Parameters:

serviceContext - The JiraServiceContext

indexPath - the path to use

setUseDefaultDirectory

void setUseDefaultDirectory(JiraServiceContext serviceContext)

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

Parameters:

serviceContext - The JiraServiceContext