javaposse.jobdsl.plugin

Class ContextExtensionPoint

java.lang.Object

javaposse.jobdsl.plugin.ContextExtensionPoint

All Implemented Interfaces:

hudson.ExtensionPoint

public abstract class ContextExtensionPoint
extends java.lang.Object
implements hudson.ExtensionPoint

An ExtensionPoint for the job-dsl-plugin to extend it with new DSL methods.

Since:

1.33

See Also:

Extending the DSL

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
ContextExtensionPoint()

Method Summary

Modifier and Type	Method and Description
static hudson.ExtensionList<ContextExtensionPoint>	all() Returns all registered JobDslContextExtensionPoints.
static void	executeInContext(java.lang.Runnable runnable, javaposse.jobdsl.dsl.Context context) Call the Runnable, which must be a Groovy closure, in the given Context.
void	notifyItemCreated(hudson.model.Item item, DslEnvironment dslEnvironment) Notifies the ExtensionPoint if an item has been created.
void	notifyItemUpdated(hudson.model.Item item, DslEnvironment dslEnvironment) Notifies the ExtensionPoint if an item has been updated.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextExtensionPoint

public ContextExtensionPoint()

Method Detail

notifyItemCreated

public void notifyItemCreated(hudson.model.Item item,
                              DslEnvironment dslEnvironment)

Notifies the ExtensionPoint if an item has been created. Implementations should override this to get notified. The default implementation is empty.

Parameters:

item - the newly created item

dslEnvironment - the environment that has been available while creating the item

notifyItemUpdated

public void notifyItemUpdated(hudson.model.Item item,
                              DslEnvironment dslEnvironment)

Notifies the ExtensionPoint if an item has been updated. Implementations should override this to get notified. The default implementation is empty.

Parameters:

item - the updated item

dslEnvironment - the environment that has been available while updating the item

executeInContext

public static void executeInContext(java.lang.Runnable runnable,
                                    javaposse.jobdsl.dsl.Context context)

Call the Runnable, which must be a Groovy closure, in the given Context.

Parameters:

runnable - the Groovy closure

context - the Context for the Runnable

Throws:

javaposse.jobdsl.dsl.DslScriptException - if the runnable is not a Groovy closure

all

public static hudson.ExtensionList<ContextExtensionPoint> all()

Returns all registered JobDslContextExtensionPoints.

Returns:

a list of all registered JobDslContextExtensionPoints.