com.atlassian.jira.config.util
Interface AttachmentPathManager

All Known Implementing Classes:
AttachmentPathManager.PropertiesAdaptor

public interface AttachmentPathManager

Responsible for determining the current location of JIRA attachments.

Since:
4.0

Nested Class Summary
static class AttachmentPathManager.Mode
           
static class AttachmentPathManager.PropertiesAdaptor
          Implementation of AttachmentPathManager that uses the ApplicationProperties to get the current paths.
 
Field Summary
static java.lang.String ATTACHMENTS_DIR
           
 
Method Summary
 void disableAttachments()
          Turns "Allow Attachments" to off.
 java.lang.String getAttachmentPath()
          Returns the path used to store attachments
 java.lang.String getDefaultAttachmentPath()
          Returns the attachment path that will be used by default if JIRA is so configured.
 AttachmentPathManager.Mode getMode()
           
 boolean getUseDefaultDirectory()
          Returns true if attachments are stored within JIRA Home
 void setCustomAttachmentPath(java.lang.String indexPath)
          Set a custom location to store attachments
 void setUseDefaultDirectory()
          Use the default location within JIRA Home to store attachments
 

Field Detail

ATTACHMENTS_DIR

static final java.lang.String ATTACHMENTS_DIR
Method Detail

getDefaultAttachmentPath

java.lang.String getDefaultAttachmentPath()
Returns the attachment path that will be used by default if JIRA is so configured. This will live as a subdirectory of jira-home.

Returns:
the attachment path that will be used by default if JIRA is so configured.

getAttachmentPath

java.lang.String getAttachmentPath()
Returns the path used to store attachments

Returns:
the path used to store attachments

setCustomAttachmentPath

void setCustomAttachmentPath(java.lang.String indexPath)
Set a custom location to store attachments

Parameters:
indexPath - path to store attachments

setUseDefaultDirectory

void setUseDefaultDirectory()
Use the default location within JIRA Home to store attachments


getUseDefaultDirectory

boolean getUseDefaultDirectory()
Returns true if attachments are stored within JIRA Home

Returns:
true if attachments are stored within JIRA Home

disableAttachments

void disableAttachments()
Turns "Allow Attachments" to off.


getMode

AttachmentPathManager.Mode getMode()


Copyright © 2002-2010 Atlassian. All Rights Reserved.