com.atlassian.jira.config.util

Class DefaultIndexPathService

java.lang.Object

com.atlassian.jira.config.util.DefaultIndexPathService

All Implemented Interfaces:

IndexPathService

public class DefaultIndexPathService
extends Object
implements IndexPathService

Since:

v4.0

Constructor Summary

Constructors

Constructor and Description
DefaultIndexPathService(IndexPathManager indexPathManager, PermissionManager permissionManager)

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultIndexPathService

public DefaultIndexPathService(IndexPathManager indexPathManager,
                               PermissionManager permissionManager)

Method Detail

getIndexRootPath

public String getIndexRootPath(JiraServiceContext serviceContext)

Description copied from interface: IndexPathService

Returns the root path of JIRA's indexes.

Specified by:

getIndexRootPath in interface IndexPathService

Parameters:

serviceContext - The JiraServiceContext

Returns:

the root path of JIRA's indexes.

getIssueIndexPath

public String getIssueIndexPath(JiraServiceContext serviceContext)

Description copied from interface: IndexPathService

Returns the path of JIRA's issue indexes.

Specified by:

getIssueIndexPath in interface IndexPathService

Parameters:

serviceContext - The JiraServiceContext

Returns:

the path of JIRA's issue indexes.

getCommentIndexPath

public String getCommentIndexPath(JiraServiceContext serviceContext)

Description copied from interface: IndexPathService

Returns the path of JIRA's comment indexes.

Specified by:

getCommentIndexPath in interface IndexPathService

Parameters:

serviceContext - The JiraServiceContext

Returns:

the path of JIRA's comment indexes.

getPluginIndexRootPath

public String getPluginIndexRootPath(JiraServiceContext serviceContext)

Description copied from interface: IndexPathService

Returns the root path of JIRA's plugin indexes.

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

Specified by:

getPluginIndexRootPath in interface IndexPathService

Parameters:

serviceContext - The JiraServiceContext

Returns:

the root path of JIRA's plugin indexes.

getSharedEntityIndexPath

public String getSharedEntityIndexPath(JiraServiceContext serviceContext)

Description copied from interface: IndexPathService

Returns the path of JIRA's shared entity indexes.

Specified by:

getSharedEntityIndexPath in interface IndexPathService

Parameters:

serviceContext - The JiraServiceContext

Returns:

the path of JIRA's shared entity indexes.

setIndexRootPath

public void setIndexRootPath(JiraServiceContext serviceContext,
                             String indexPath)

Description copied from interface: IndexPathService

Specify an explicit (custom) index root path.

Specified by:

setIndexRootPath in interface IndexPathService

Parameters:

serviceContext - The JiraServiceContext

indexPath - the path to use

setUseDefaultDirectory

public void setUseDefaultDirectory(JiraServiceContext serviceContext)

Description copied from interface: IndexPathService

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

Specified by:

setUseDefaultDirectory in interface IndexPathService

Parameters:

serviceContext - The JiraServiceContext