public interface IBuildEngine extends IBuildEngineHandle, IAuditable, IBuildItem
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEFAULT_ENGINE_ID
The default engine id.
|
static IItemType |
ITEM_TYPE
The item type for this item.
|
static java.lang.String |
PROPERTY_ACTIVE
The name of the active property.
|
static java.lang.String |
PROPERTY_BUILD_ENGINE_ACTIVITY
The name of the build engine activity property.
|
static java.lang.String |
PROPERTY_CONFIGURATION_ELEMENTS
The name of the configuration elements property.
|
static java.lang.String |
PROPERTY_DESCRIPTION
The name of the description property.
|
static java.lang.String |
PROPERTY_ENGINE_CONTACT_INTERVAL
The name of the engine contact interval property.
|
static java.lang.String |
PROPERTY_ID
The name of the id property.
|
static java.lang.String |
PROPERTY_PROCESS_AREA
The name of the build engine process area property.
|
static java.lang.String |
PROPERTY_PROPERTIES
The name of the properties property.
|
static java.lang.String |
PROPERTY_SUPPORTED_BUILD_DEFINITIONS
The name of the supported build definitions property.
|
static java.lang.String |
PROPERTY_SUPPORTS_CANCELLATION
The name of the supports cancellation property.
|
static java.lang.String |
PROPERTY_USE_TEAM_SCHEDULER
The name of the use team scheduler property.
|
PROPERTIES_COMPLETE, PROPERTIES_REQUIRED
MERGE_PREDECESSOR_STATE_PROPERTY, PREDECESSOR_STATE_PROPERTY
CONTEXT_ID_PROPERTY, ITEM_ID_PROPERTY, MAX_LARGE_STRING_BYTES, MAX_MEDIUM_STRING_BYTES, MAX_SMALL_STRING_BYTES, MODIFIED_BY_PROPERTY, MODIFIED_PROPERTY, STATE_ID_PROPERTY
Modifier and Type | Method and Description |
---|---|
IBuildEngine |
copyEngine()
Make a copy of this engine.
|
IBuildEngineActivityHandle |
getBuildEngineActivity()
Retrieves the handle to the build engine activity.
|
IBuildConfigurationElement |
getConfigurationElement(java.lang.String elementId)
Get the configuration element with the given id.
|
java.util.List |
getConfigurationElements()
Get the configuration elements for this build engine.
|
java.lang.String |
getConfigurationPropertyValue(java.lang.String elementId,
java.lang.String name,
java.lang.String defaultValue)
Get the value of the configuration property with the given name in the
configuration element with the given id.
|
java.lang.String |
getDescription()
Retrieves the description of the build engine.
|
java.lang.String |
getId()
Get the build engine id.
|
int |
getMonitoringThreshold()
Gets the monitoring threshold.
|
IProcessAreaHandle |
getProcessArea()
Retrieves the process area handle for the build engine.
|
java.util.List |
getProperties()
Get the properties for the engine.
|
IBuildProperty |
getProperty(java.lang.String name)
Get the property with the given name.
|
java.lang.String |
getPropertyValue(java.lang.String name,
java.lang.String defaultValue)
Get the value of the property with the given name.
|
java.util.List |
getSupportedBuildDefinitions()
Retrieves the build definitions supported by this build engine.
|
void |
initializeConfiguration(IBuildConfigurationElement element)
Initialize the build engine from the given configuration element.
|
void |
initializeConfiguration(IBuildEngineTemplate template)
Initialize the build engine from the given template.
|
boolean |
isActive()
Indicates if the service is currently active or not.
|
boolean |
isRequestProcessingEnabled()
Get request processing enablement.
|
boolean |
isThresholdMonitoringEnabled()
Indicates if the engine is participating in threshold monitoring.
|
void |
setActive(boolean active)
Sets whether or not the service is active.
|
void |
setConfigurationProperty(java.lang.String elementId,
java.lang.String name,
java.lang.String value)
Set the value of the configuration property with the given name in the
configuration element with the given id.
|
void |
setDescription(java.lang.String description)
Sets the description of the build engine.
|
void |
setId(java.lang.String id)
Set the build engine id.
|
void |
setMonitoringThreshold(int thresholdMinutes)
Sets the monitoring threshold.
|
void |
setProcessArea(IProcessAreaHandle processAreaHandle)
Sets the process area handle for the build engine.
|
void |
setProperty(java.lang.String name,
java.lang.String value)
Set the value of the property with the given name.
|
void |
setRequestProcessingEnabled(boolean enabled)
Set request processing enablement.
|
boolean |
supportsBuildDefinition(IBuildDefinitionHandle buildDefinitionHandle)
Determines if the build engine supports the specified build definition.
|
getMergePredecessorState, getPredecessorState
isNewItem
getContextId, getItemHandle, getModifiedBy, getRedactedCopy, getRequestedModified, getRequestedStateId, getStateHandle, getWorkingCopy, hasHistory, isComplete, isPropertySet, isRedactedCopy, isWorkingCopy, modified, setContextId, setRequestedModified, setRequestedStateId
equals, getAdapter, getFullState, getItemId, getItemType, getOrigin, getStateId, hasFullState, hasStateId, isAuditable, isConfigurationAware, isImmutable, isSimple, isUnmanaged, makeImmutable, protect, sameItemId, sameStateId, size
static final IItemType ITEM_TYPE
static final java.lang.String PROPERTY_ACTIVE
static final java.lang.String PROPERTY_BUILD_ENGINE_ACTIVITY
static final java.lang.String PROPERTY_DESCRIPTION
static final java.lang.String PROPERTY_ENGINE_CONTACT_INTERVAL
static final java.lang.String PROPERTY_ID
static final java.lang.String PROPERTY_PROCESS_AREA
static final java.lang.String PROPERTY_SUPPORTED_BUILD_DEFINITIONS
static final java.lang.String PROPERTY_SUPPORTS_CANCELLATION
static final java.lang.String PROPERTY_USE_TEAM_SCHEDULER
static final java.lang.String PROPERTY_PROPERTIES
static final java.lang.String DEFAULT_ENGINE_ID
static final java.lang.String PROPERTY_CONFIGURATION_ELEMENTS
boolean isActive()
true
is the service is active.void setActive(boolean active)
active
- Flag indicating if the service is active or not.int getMonitoringThreshold()
Note: In order to retrieve this the fetch of the engine must have
included the PROPERTY_PROPERTIES
.
void setMonitoringThreshold(int thresholdMinutes)
thresholdMinutes
- The monitoring threshold in minutes.boolean isThresholdMonitoringEnabled()
Note: In order to retrieve this the fetch of the engine must have
included the PROPERTY_PROPERTIES
.
true
if the engine is participating in threshold
monitoring.java.util.List getSupportedBuildDefinitions()
IBuildDefinitionHandle
.java.lang.String getId()
void setId(java.lang.String id)
id
- the build engine idIBuildEngineActivityHandle getBuildEngineActivity()
IProcessAreaHandle getProcessArea()
void setProcessArea(IProcessAreaHandle processAreaHandle)
processAreaHandle
- The process area handle to set in the build engine.java.util.List getProperties()
IBuildProperty
.IBuildProperty getProperty(java.lang.String name)
name
- The property name.null
if a property with the given
name does not exist.java.lang.String getPropertyValue(java.lang.String name, java.lang.String defaultValue)
name
- The property name.defaultValue
- The default value (may be null
).void setProperty(java.lang.String name, java.lang.String value)
name
- The property name.value
- The property value.boolean isRequestProcessingEnabled()
void setRequestProcessingEnabled(boolean enabled)
enabled
- Whether or not the engine has request processing enabled.boolean supportsBuildDefinition(IBuildDefinitionHandle buildDefinitionHandle)
PROPERTY_SUPPORTED_BUILD_DEFINITIONS
property.buildDefinitionHandle
- The handle to the build definition of interest.true
if the build engine supports the specified
build definition.java.lang.String getDescription()
void setDescription(java.lang.String description)
description
- The description of the build engine.java.util.List getConfigurationElements()
List
whose elements are of type
IBuildConfigurationElement
.IBuildConfigurationElement getConfigurationElement(java.lang.String elementId)
elementId
- The element id.null
if an element
with the given id does not exist.java.lang.String getConfigurationPropertyValue(java.lang.String elementId, java.lang.String name, java.lang.String defaultValue)
elementId
- The configuration element id.name
- The configuration property name.defaultValue
- The default value (may be null
)void setConfigurationProperty(java.lang.String elementId, java.lang.String name, java.lang.String value)
elementId
- The configuration element id.name
- The configuration property name.value
- The configuration property value.IBuildEngine copyEngine()
void initializeConfiguration(IBuildConfigurationElement element)
If an element with the same id is already present in the engine, it is overwritten at its current position.
This method may be called more than once with different configuration elements.
element
- The configuration element to initialize the engine with.void initializeConfiguration(IBuildEngineTemplate template)
This method may be called more than once with different templates.
template
- The template to initialize the engine with.