Package com.xebialabs.xlrelease.script

Class DefaultScriptService

java.lang.Object

com.xebialabs.xlrelease.script.DefaultScriptService

All Implemented Interfaces:

com.xebialabs.xlrelease.script.GenericTaskScriptLogic, ScriptService

public abstract class DefaultScriptService
extends Object
implements ScriptService, com.xebialabs.xlrelease.script.GenericTaskScriptLogic

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DefaultScriptService.BaseScriptTaskResults
static class	DefaultScriptService.CustomScriptTaskResults
static class	DefaultScriptService.ScriptTaskOutputWriter
static class	DefaultScriptService.ScriptTaskResults
static class	DefaultScriptService.VariablesUpdateHolder

Field Summary

Fields

Modifier and Type	Field	Description
final AuthenticationService	authenticationService
protected CommentService	commentService
final com.xebialabs.platform.script.jython.ThreadLocalWriterDecorator	executionLog
static final String	MATCHED_EVENT_MSG
static final String	MDC_KEY_TASK
protected com.xebialabs.xlrelease.security.PermissionChecker	permissions
static final String	PRESERVE_OUTPUT_ON_ERROR
static final String	RESULT_ATTRIBUTE
protected com.xebialabs.xlrelease.script.ScriptExecutor	scriptExecutor
protected ScriptLifeCycle	scriptLifeCycle
static final String	TYPE_CUSTOM_SCRIPT_TASK
protected com.xebialabs.xlrelease.config.XlrConfig	xlrConfig

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DefaultScriptService(ScriptLifeCycle scriptLifeCycle, com.xebialabs.xlrelease.script.ScriptExecutor scriptExecutor, AuthenticationService authenticationService, ReleaseService releaseService, ScriptVariables scriptVariables, com.xebialabs.xlrelease.security.PermissionChecker permissions, CommentService commentService, com.xebialabs.xlrelease.config.XlrConfig xlrConfig, AttachmentService attachmentService, com.xebialabs.xlrelease.service.ConfigurationVariableService configurationVariableService, com.xebialabs.xlrelease.service.ConfigurationService configurationService, ScheduledExecutorService timeoutExecutor, ScheduledExecutorService auxiliaryExecutor, ScheduledExecutorService pollingExecutor)

Method Summary

Modifier and Type	Method	Description
void	closeWriter()	Closing a writer will also flush execution log so that comment with writers contents is added to the task.
<T extends com.xebialabs.xlrelease.domain.CustomScriptTask> com.xebialabs.xlrelease.script.CustomScriptTaskResult	executeCustomScriptTask(T task)
com.xebialabs.xlrelease.script.FacetCheckResult	executeFacetCheck(com.xebialabs.xlrelease.domain.Task task)
com.xebialabs.xlrelease.script.FailureHandlerResult	executeFailureHandler(com.xebialabs.xlrelease.domain.Task task)
com.xebialabs.xlrelease.script.PreconditionResult	executePrecondition(com.xebialabs.xlrelease.domain.Task task)
Object	executeScript(com.xebialabs.xlrelease.script.XlrScriptContext scriptContext)
<T extends com.xebialabs.xlrelease.domain.ResolvableScriptTask> com.xebialabs.xlrelease.script.ScriptTaskResult	executeScriptTask(T task)
Collection<Object>	executeScriptValueProvider(com.xebialabs.xlrelease.domain.variables.ScriptValueProviderConfiguration valueProviderConfiguration)
Object	executeScriptWithLifecycle(com.xebialabs.xlrelease.script.XlrScriptContext scriptContext)
void	finishScript(String executionId)
void	registerScriptExecution(String ciId, String executionId)
ExecutionOutputWriter	registerWriterForTask(com.xebialabs.xlrelease.domain.Task task, com.xebialabs.xlrelease.utils.SensitiveValueScrubber scrubber)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.xebialabs.xlrelease.script.GenericTaskScriptLogic

executeGenericTaskScript

Methods inherited from interface com.xebialabs.xlrelease.script.ScriptService

accepts, engine

Field Details

MDC_KEY_TASK

public static final String MDC_KEY_TASK

See Also:

• Constant Field Values

RESULT_ATTRIBUTE

public static final String RESULT_ATTRIBUTE

See Also:

• Constant Field Values

MATCHED_EVENT_MSG

public static final String MATCHED_EVENT_MSG

See Also:

• Constant Field Values

TYPE_CUSTOM_SCRIPT_TASK

public static final String TYPE_CUSTOM_SCRIPT_TASK

See Also:

• Constant Field Values

PRESERVE_OUTPUT_ON_ERROR

public static final String PRESERVE_OUTPUT_ON_ERROR

See Also:

• Constant Field Values

scriptLifeCycle

protected ScriptLifeCycle scriptLifeCycle

scriptExecutor

protected com.xebialabs.xlrelease.script.ScriptExecutor scriptExecutor

executionLog

public final com.xebialabs.platform.script.jython.ThreadLocalWriterDecorator executionLog

authenticationService

public final AuthenticationService authenticationService

permissions

protected com.xebialabs.xlrelease.security.PermissionChecker permissions

commentService

protected CommentService commentService

xlrConfig

protected com.xebialabs.xlrelease.config.XlrConfig xlrConfig

Constructor Details

DefaultScriptService

protected DefaultScriptService(ScriptLifeCycle scriptLifeCycle,
 com.xebialabs.xlrelease.script.ScriptExecutor scriptExecutor,
 AuthenticationService authenticationService,
 ReleaseService releaseService,
 ScriptVariables scriptVariables,
 com.xebialabs.xlrelease.security.PermissionChecker permissions,
 CommentService commentService,
 com.xebialabs.xlrelease.config.XlrConfig xlrConfig,
 AttachmentService attachmentService,
 com.xebialabs.xlrelease.service.ConfigurationVariableService configurationVariableService,
 com.xebialabs.xlrelease.service.ConfigurationService configurationService,
 ScheduledExecutorService timeoutExecutor,
 ScheduledExecutorService auxiliaryExecutor,
 ScheduledExecutorService pollingExecutor)

Method Details

executeScript

public Object executeScript(com.xebialabs.xlrelease.script.XlrScriptContext scriptContext)
                     throws Exception

Specified by:

executeScript in interface ScriptService

Throws:

Exception

executeScriptWithLifecycle

public Object executeScriptWithLifecycle(com.xebialabs.xlrelease.script.XlrScriptContext scriptContext)
                                  throws Exception

Throws:

Exception

registerScriptExecution

public void registerScriptExecution(String ciId,
 String executionId)

executeScriptTask

public <T extends com.xebialabs.xlrelease.domain.ResolvableScriptTask>
com.xebialabs.xlrelease.script.ScriptTaskResult executeScriptTask(T task)

Specified by:

executeScriptTask in interface ScriptService

executeCustomScriptTask

public <T extends com.xebialabs.xlrelease.domain.CustomScriptTask>
com.xebialabs.xlrelease.script.CustomScriptTaskResult executeCustomScriptTask(T task)

Specified by:

executeCustomScriptTask in interface ScriptService

finishScript

public void finishScript(String executionId)

executePrecondition

public com.xebialabs.xlrelease.script.PreconditionResult executePrecondition(com.xebialabs.xlrelease.domain.Task task)

Specified by:

executePrecondition in interface ScriptService

executeFacetCheck

public com.xebialabs.xlrelease.script.FacetCheckResult executeFacetCheck(com.xebialabs.xlrelease.domain.Task task)

Specified by:

executeFacetCheck in interface ScriptService

executeScriptValueProvider

public Collection<Object> executeScriptValueProvider(com.xebialabs.xlrelease.domain.variables.ScriptValueProviderConfiguration valueProviderConfiguration)

Specified by:

executeScriptValueProvider in interface ScriptService

executeFailureHandler

public com.xebialabs.xlrelease.script.FailureHandlerResult executeFailureHandler(com.xebialabs.xlrelease.domain.Task task)

Specified by:

executeFailureHandler in interface ScriptService

registerWriterForTask

public ExecutionOutputWriter registerWriterForTask(com.xebialabs.xlrelease.domain.Task task,
 com.xebialabs.xlrelease.utils.SensitiveValueScrubber scrubber)

closeWriter

public void closeWriter()

Closing a writer will also flush execution log so that comment with writers contents is added to the task.