Summary: Methods | [Expand All]
@PublicApi public interface

IndexPathService

com.atlassian.jira.config.util.IndexPathService
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

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.

See Also

Summary

Public Methods
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.

Public Methods

public String getCommentIndexPath (JiraServiceContext serviceContext)

Returns the path of JIRA's comment indexes.

Parameters
serviceContext The JiraServiceContext
Returns
  • the path of JIRA's comment indexes.

public String getIndexRootPath (JiraServiceContext serviceContext)

Returns the root path of JIRA's indexes.

Parameters
serviceContext The JiraServiceContext
Returns
  • the root path of JIRA's indexes.

public String getIssueIndexPath (JiraServiceContext serviceContext)

Returns the path of JIRA's issue indexes.

Parameters
serviceContext The JiraServiceContext
Returns
  • the path of JIRA's issue indexes.

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

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

public void setIndexRootPath (JiraServiceContext serviceContext, String indexPath)

Specify an explicit (custom) index root path.

Parameters
serviceContext The JiraServiceContext
indexPath the path to use

public void setUseDefaultDirectory (JiraServiceContext serviceContext)

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

Parameters
serviceContext The JiraServiceContext