com.atlassian.bamboo.plan.branch
Interface BranchMonitoringConfiguration

All Superinterfaces:
ConvertibleFromConfig, OptionallyConvertibleFromConfig, java.io.Serializable
All Known Implementing Classes:
BranchMonitoringConfigurationImpl

public interface BranchMonitoringConfiguration
extends OptionallyConvertibleFromConfig, java.io.Serializable

This interface is used to store plan's branches monitor settings - the thing that monitors the repository for new branches in SCM and manages branches for that plan in Bamboo


Field Summary
static int DEFAULT_TIME_OF_INACTIVITY_DAYS
           
 
Method Summary
 org.apache.commons.configuration.HierarchicalConfiguration getCustomConfiguration()
          Return custom configuration related to branch detection in the particular plan.
 BranchIntegrationConfiguration getDefaultBranchIntegrationConfiguration()
           
 BranchNotificationStrategy getDefaultBranchNotificationStrategy()
           
 java.lang.String getMatchingPattern()
          Returns the regexp - every matching branch will be considered for auto branch creation
 int getTimeOfInactivityInDays()
           
 boolean isCleanupEnabled()
           
 boolean isMonitoringEnabled()
           
 boolean isRemoteJiraBranchLinkingEnabled()
          Whether Bamboo will attempt to create the remote issue links in JIRA when it finds an issue key in the branch name.
 void setCustomConfiguration(org.apache.commons.configuration.HierarchicalConfiguration customConfiguration)
           
 void setDefaultBranchIntegrationConfiguration(BranchIntegrationConfiguration defaultBranchIntegrationConfiguration)
           
 void setDefaultBranchNotificationStrategy(BranchNotificationStrategy branchNotificationStrategy)
           
 void setMatchingPattern(java.lang.String matchingExpression)
           
 void setMonitoringEnabled(boolean enabled)
           
 void setRemoteJiraBranchLinkingEnabled(boolean remoteJiraBranchLinkingEnabled)
           
 void setTimeOfInactivityInDays(int timeOfInactivityInDays)
           
 
Methods inherited from interface com.atlassian.bamboo.fieldvalue.OptionallyConvertibleFromConfig
isValid
 
Methods inherited from interface com.atlassian.bamboo.fieldvalue.ConvertibleFromConfig
populateFromConfig, toConfiguration
 

Field Detail

DEFAULT_TIME_OF_INACTIVITY_DAYS

static final int DEFAULT_TIME_OF_INACTIVITY_DAYS
See Also:
Constant Field Values
Method Detail

isMonitoringEnabled

boolean isMonitoringEnabled()

setMonitoringEnabled

void setMonitoringEnabled(boolean enabled)

getMatchingPattern

java.lang.String getMatchingPattern()
Returns the regexp - every matching branch will be considered for auto branch creation

Returns:
regular expression for matching open branches

setMatchingPattern

void setMatchingPattern(@NotNull
                        java.lang.String matchingExpression)

isCleanupEnabled

boolean isCleanupEnabled()
Returns:
true if inactive branches should be auto removed from plan after a while (i.e. 30 days)

getTimeOfInactivityInDays

int getTimeOfInactivityInDays()

setTimeOfInactivityInDays

void setTimeOfInactivityInDays(int timeOfInactivityInDays)

getCustomConfiguration

@NotNull
org.apache.commons.configuration.HierarchicalConfiguration getCustomConfiguration()
Return custom configuration related to branch detection in the particular plan. The custom configuration may hold for example "branchRootOverride" for the SvnRepositories. That custom configuration object is given to the Repository classes when detecting/creating new branches.


setCustomConfiguration

void setCustomConfiguration(org.apache.commons.configuration.HierarchicalConfiguration customConfiguration)

getDefaultBranchNotificationStrategy

BranchNotificationStrategy getDefaultBranchNotificationStrategy()

setDefaultBranchNotificationStrategy

void setDefaultBranchNotificationStrategy(BranchNotificationStrategy branchNotificationStrategy)

getDefaultBranchIntegrationConfiguration

BranchIntegrationConfiguration getDefaultBranchIntegrationConfiguration()

setDefaultBranchIntegrationConfiguration

void setDefaultBranchIntegrationConfiguration(BranchIntegrationConfiguration defaultBranchIntegrationConfiguration)

isRemoteJiraBranchLinkingEnabled

boolean isRemoteJiraBranchLinkingEnabled()
Whether Bamboo will attempt to create the remote issue links in JIRA when it finds an issue key in the branch name. Bamboo will always create the link from Bamboo to JIRA regardless of this setting.

Returns:
true if Bamboo should try to create remote issue links in JIRA

setRemoteJiraBranchLinkingEnabled

void setRemoteJiraBranchLinkingEnabled(boolean remoteJiraBranchLinkingEnabled)


Copyright © 2013 Atlassian Software Systems Pty Ltd. All Rights Reserved.