ruby

Class RubyPlugin

java.lang.Object

hudson.Plugin

ruby.PluginImpl

ruby.RubyPlugin

All Implemented Interfaces:

hudson.model.Saveable

public class RubyPlugin
extends PluginImpl

The primary Java interface to a plugin which is implemented in Ruby. One instance is created per each Ruby plugin.

When this plugin initializes, it will instantiate a Jenkins::Plugin object which acts as the gateway for Ruby to interact with the java side.

When the RubyPlugin is loaded, it will discover, load and provide a mechanism for extensions written in Ruby that it contains to register themselves.

These Extensions are presented to Jenkins via the RubyExtensionFinder

Each plugin has its own JRuby environment

Nested Class Summary

Nested classes/interfaces inherited from class hudson.Plugin

hudson.Plugin.DummyImpl

Field Summary

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
RubyPlugin()

Method Summary

Methods

Modifier and Type	Method and Description
void	addExtension(Object extension) Registers an extension with the default ordiinal.
void	addExtension(Object extension, double ordinal) Registers an extension with this Ruby plugin so that it will be found later on This method is generally called from inside Ruby, as objects that implement extension points register themselves.
Object	callMethod(Object object, String methodName, Object... args) invokes a Ruby method on the specified object in the context of this plugin's ScriptingContainer
static RubyPlugin	from(org.jruby.Ruby r) Gets the plugin that owns the container.
Collection<hudson.ExtensionComponent>	getExtensions()
File	getLibPath()
File	getModelsPath()
Object	getNativeRubyPlugin()
String	getResourceURI(String relativePathFormat, Object... args)
File	getScriptDir() Returns a directory that stores all the Ruby scripts.
org.jruby.embed.ScriptingContainer	getScriptingContainer()
org.kohsuke.stapler.lang.Klass<org.jruby.RubyModule>	klassFor(org.jruby.RubyModule module)
String	loadBootScript() Loads the models.rb
void	rack(org.jruby.runtime.builtin.IRubyObject servletHandler) Let a Rack application handle the current request.
void	start() Jenkins will call this method whenever the plugin is initialized The plugin will in turn delegate to its instance of Jenkins::Plugin which can take action on the Ruby side.
void	stop() Jenkins will call this method whenever the plugin is shut down The plugin will in turn delegate to its instance of Jenkins::Plugin which can take action on the Ruby side

Methods inherited from class hudson.Plugin

configure, configure, doDynamic, getConfigXml, getWrapper, load, postInitialize, save, setServletContext

Methods inherited from class java.lang.Object

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

Constructor Detail

RubyPlugin

public RubyPlugin()

Method Detail

callMethod

public Object callMethod(Object object,
                String methodName,
                Object... args)

invokes a Ruby method on the specified object in the context of this plugin's ScriptingContainer

Parameters:

object - JRuby object to use as invocant

methodName - the method to end

args - arguments to the method

Returns:

the return value of the method call.

addExtension

public void addExtension(Object extension)

Registers an extension with the default ordiinal.

addExtension

public void addExtension(Object extension,
                double ordinal)

Registers an extension with this Ruby plugin so that it will be found later on

This method is generally called from inside Ruby, as objects that implement extension points register themselves.

Parameters:

extension -

getExtensions

public Collection<hudson.ExtensionComponent> getExtensions()

Returns:

the list of extensions registered with this Plugin. this is used by the RubyExtensionFinder to present extension points to Jenkins

loadBootScript

public String loadBootScript()
                      throws IOException

Loads the models.rb

Throws:

IOException

start

public void start()
           throws Exception

Jenkins will call this method whenever the plugin is initialized The plugin will in turn delegate to its instance of Jenkins::Plugin which can take action on the Ruby side.

Overrides:

start in class hudson.Plugin

Throws:

Exception

from

public static RubyPlugin from(org.jruby.Ruby r)

Gets the plugin that owns the container.

klassFor

public org.kohsuke.stapler.lang.Klass<org.jruby.RubyModule> klassFor(org.jruby.RubyModule module)

stop

public void stop()
          throws Exception

Jenkins will call this method whenever the plugin is shut down The plugin will in turn delegate to its instance of Jenkins::Plugin which can take action on the Ruby side

Overrides:

stop in class hudson.Plugin

Throws:

Exception

getResourceURI

public String getResourceURI(String relativePathFormat,
                    Object... args)

getScriptDir

public File getScriptDir()

Returns a directory that stores all the Ruby scripts.

getLibPath

public File getLibPath()

getModelsPath

public File getModelsPath()

getScriptingContainer

public org.jruby.embed.ScriptingContainer getScriptingContainer()

getNativeRubyPlugin

public Object getNativeRubyPlugin()

rack

public void rack(org.jruby.runtime.builtin.IRubyObject servletHandler)

Let a Rack application handle the current request.

Parameters:

servletHandler - Instance of Rack::Handler::Servlet which wraps the actual rack application and provides the ruby part of the rack implementation.