com.atlassian.jira.config.util
Class IndexPathManager.PropertiesAdaptor

java.lang.Object
  extended by com.atlassian.jira.config.util.IndexPathManager.PropertiesAdaptor
All Implemented Interfaces:
IndexPathManager
Enclosing interface:
IndexPathManager

public static class IndexPathManager.PropertiesAdaptor
extends Object
implements IndexPathManager

Implementation of IndexPathManager that uses the ApplicationProperties to get the current paths. Nothing outside of this class should ever refer to the JIRA_PATH_INDEX ApplicationProperty. That property needs to be interpreted properly when using JIRA Home.


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.atlassian.jira.config.util.IndexPathManager
IndexPathManager.Directory, IndexPathManager.Mode, IndexPathManager.PropertiesAdaptor
 
Field Summary
 
Fields inherited from interface com.atlassian.jira.config.util.IndexPathManager
INDEXES_DIR
 
Constructor Summary
IndexPathManager.PropertiesAdaptor(ApplicationProperties applicationProperties, JiraHome jiraHome)
           
 
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 rootPath)
          Specify an explicit index root path.
 void setUseDefaultDirectory()
          Specify that the default location within JIRA Home 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

IndexPathManager.PropertiesAdaptor

public IndexPathManager.PropertiesAdaptor(ApplicationProperties applicationProperties,
                                          JiraHome jiraHome)
Method Detail

getIndexRootPath

public String getIndexRootPath()
Description copied from interface: IndexPathManager
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.

Specified by:
getIndexRootPath in interface IndexPathManager
Returns:
the root path of JIRA's indexes

getDefaultIndexRootPath

public String getDefaultIndexRootPath()
Description copied from interface: IndexPathManager
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/.

Specified by:
getDefaultIndexRootPath in interface IndexPathManager
Returns:
the default root index path

setIndexRootPath

public void setIndexRootPath(String rootPath)
Description copied from interface: IndexPathManager
Specify an explicit index root path.

Specified by:
setIndexRootPath in interface IndexPathManager
Parameters:
rootPath - the path to use

setUseDefaultDirectory

public void setUseDefaultDirectory()
Description copied from interface: IndexPathManager
Specify that the default location within JIRA Home should be used to store indexes.

Specified by:
setUseDefaultDirectory in interface IndexPathManager

getUseDefaultDirectory

public boolean getUseDefaultDirectory()
Description copied from interface: IndexPathManager
Whether we are using the default index directory (within JIRA Home).

Specified by:
getUseDefaultDirectory in interface IndexPathManager
Returns:
true if we are using the default index directory (within JIRA Home).

getMode

public IndexPathManager.Mode getMode()
Specified by:
getMode in interface IndexPathManager

getIssueIndexPath

public String getIssueIndexPath()
Description copied from interface: IndexPathManager
Returns the path of JIRA's issue indexes.

Specified by:
getIssueIndexPath in interface IndexPathManager
Returns:
the path of JIRA's issue indexes

getCommentIndexPath

public String getCommentIndexPath()
Description copied from interface: IndexPathManager
Returns the path of JIRA's comment indexes.

Specified by:
getCommentIndexPath in interface IndexPathManager
Returns:
the path of JIRA's comment indexes

getChangeHistoryIndexPath

public String getChangeHistoryIndexPath()
Description copied from interface: IndexPathManager
Returns the path of JIRA's change history indexes.

Specified by:
getChangeHistoryIndexPath in interface IndexPathManager
Returns:
the path of JIRA's change history indexes

getSharedEntityIndexPath

public String getSharedEntityIndexPath()
Description copied from interface: IndexPathManager
Returns the path of JIRA's shared entity indexes.

Specified by:
getSharedEntityIndexPath in interface IndexPathManager
Returns:
the path of JIRA's shared entity indexes

getPluginIndexRootPath

public String getPluginIndexRootPath()
Description copied from interface: IndexPathManager
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 IndexPathManager
Returns:
the root path of JIRA's plugin indexes


Copyright © 2002-2014 Atlassian. All Rights Reserved.