org.jenkinsci.plugins.pipeline.modeldefinition.agent

Class DeclarativeAgent

java.lang.Object

hudson.model.AbstractDescribableImpl<DeclarativeAgent>

org.jenkinsci.plugins.pipeline.modeldefinition.agent.DeclarativeAgent

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<DeclarativeAgent>, Serializable

public abstract class DeclarativeAgent
extends hudson.model.AbstractDescribableImpl<DeclarativeAgent>
implements Serializable, hudson.ExtensionPoint

Implementations for DeclarativeAgentDescriptor - pluggable agent backends for Declarative Pipelines.

Author:

Andrew Bayer

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
DeclarativeAgent()

Method Summary

Methods

Modifier and Type	Method and Description
DeclarativeAgentDescriptor	getDescriptor()
DeclarativeAgentScript	getScript(org.jenkinsci.plugins.workflow.cps.CpsScript cpsScript) ONLY TO BE RUN FROM WITHIN A CPS THREAD.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeclarativeAgent

public DeclarativeAgent()

Method Detail

getScript

public DeclarativeAgentScript getScript(org.jenkinsci.plugins.workflow.cps.CpsScript cpsScript)
                                 throws Exception

ONLY TO BE RUN FROM WITHIN A CPS THREAD. Parses the script source and loads it. TODO: Decide if we want to cache the resulting objects or just *shrug* and re-parse them every time.

Returns:

The script object for this declarative agent.

Throws:

Exception - if the script source cannot be loaded or we're called from outside a CpsThread.

getDescriptor

public DeclarativeAgentDescriptor getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<DeclarativeAgent>

Overrides:

getDescriptor in class hudson.model.AbstractDescribableImpl<DeclarativeAgent>