org.jvnet.hudson.plugins.scriptler
Class ScriptlerManagment

java.lang.Object
  hudson.model.ManagementLink
      org.jvnet.hudson.plugins.scriptler.ScriptlerManagment

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Action, hudson.model.ModelObject

@Extension
public class ScriptlerManagment
extends hudson.model.ManagementLink

Author:

domi

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.ManagementLink

LIST

Constructor Summary

ScriptlerManagment()

Method Summary

org.kohsuke.stapler.HttpResponse	doDownloadScript(org.kohsuke.stapler.StaplerRequest res, org.kohsuke.stapler.StaplerResponse rsp, java.lang.String name, java.lang.String catalogName)
void	doEditScript(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, java.lang.String scriptName)
org.kohsuke.stapler.HttpResponse	doRemoveScript(org.kohsuke.stapler.StaplerRequest res, org.kohsuke.stapler.StaplerResponse rsp, java.lang.String name)
void	doRunScript(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, java.lang.String scriptName) display the screen to trigger a script
org.kohsuke.stapler.HttpResponse	doScriptAdd(org.kohsuke.stapler.StaplerRequest res, org.kohsuke.stapler.StaplerResponse rsp, java.lang.String name, java.lang.String comment, java.lang.String script)
void	doTriggerScript(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, java.lang.String scriptName, java.lang.String script, java.lang.String node) trigger/run/execute the script on a slave and show the result/output
org.kohsuke.stapler.HttpResponse	doUploadScript(org.kohsuke.stapler.StaplerRequest req) Uploads a script to the defined directory
java.util.List<Catalog>	getCatalogs() Gets the remote catalogs containing the available scripts for download.
ScriptlerConfiguration	getConfiguration()
java.lang.String	getDescription()
java.lang.String	getDisplayName()
java.lang.String	getIconFileName()
protected Script	getScript(java.lang.String scriptName, boolean withSrc)
static java.io.File	getScriptDirectory() returns the directory where the script files get stored
ScriptlerManagment	getScriptler()
static java.io.File	getScriptlerHomeDirectory()
java.util.List<java.lang.String>	getSlaveNames()
java.lang.String	getUrlName()

Methods inherited from class hudson.model.ManagementLink

all

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptlerManagment

public ScriptlerManagment()

Method Detail

getIconFileName

public java.lang.String getIconFileName()

Specified by:

getIconFileName in interface hudson.model.Action

Specified by:

getIconFileName in class hudson.model.ManagementLink

getUrlName

public java.lang.String getUrlName()

Specified by:

getUrlName in interface hudson.model.Action

Specified by:

getUrlName in class hudson.model.ManagementLink

getDisplayName

public java.lang.String getDisplayName()

getDescription

public java.lang.String getDescription()

Overrides:

getDescription in class hudson.model.ManagementLink

getScriptler

public ScriptlerManagment getScriptler()

getConfiguration

public ScriptlerConfiguration getConfiguration()

doDownloadScript

public org.kohsuke.stapler.HttpResponse doDownloadScript(org.kohsuke.stapler.StaplerRequest res,
                                                         org.kohsuke.stapler.StaplerResponse rsp,
                                                         @QueryParameter(value="name")
                                                         java.lang.String name,
                                                         @QueryParameter(value="catalog")
                                                         java.lang.String catalogName)
                                                  throws java.io.IOException

Throws:

java.io.IOException

doScriptAdd

public org.kohsuke.stapler.HttpResponse doScriptAdd(org.kohsuke.stapler.StaplerRequest res,
                                                    org.kohsuke.stapler.StaplerResponse rsp,
                                                    @QueryParameter(value="name")
                                                    java.lang.String name,
                                                    @QueryParameter(value="comment")
                                                    java.lang.String comment,
                                                    @QueryParameter(value="script")
                                                    java.lang.String script)
                                             throws java.io.IOException

Throws:

java.io.IOException

doRemoveScript

public org.kohsuke.stapler.HttpResponse doRemoveScript(org.kohsuke.stapler.StaplerRequest res,
                                                       org.kohsuke.stapler.StaplerResponse rsp,
                                                       @QueryParameter(value="name")
                                                       java.lang.String name)
                                                throws java.io.IOException

Throws:

java.io.IOException

doUploadScript

public org.kohsuke.stapler.HttpResponse doUploadScript(org.kohsuke.stapler.StaplerRequest req)
                                                throws java.io.IOException,
                                                       javax.servlet.ServletException

Uploads a script to the defined directory

Throws:

java.io.IOException

javax.servlet.ServletException

getScript

protected Script getScript(java.lang.String scriptName,
                           boolean withSrc)

doRunScript

public void doRunScript(org.kohsuke.stapler.StaplerRequest req,
                        org.kohsuke.stapler.StaplerResponse rsp,
                        @QueryParameter(value="name")
                        java.lang.String scriptName)
                 throws java.io.IOException,
                        javax.servlet.ServletException

display the screen to trigger a script

Parameters:

req -

rsp -

scriptName -

Throws:

java.io.IOException

javax.servlet.ServletException

doTriggerScript

public void doTriggerScript(org.kohsuke.stapler.StaplerRequest req,
                            org.kohsuke.stapler.StaplerResponse rsp,
                            @QueryParameter(value="scriptName")
                            java.lang.String scriptName,
                            @QueryParameter(value="script")
                            java.lang.String script,
                            @QueryParameter(value="node")
                            java.lang.String node)
                     throws java.io.IOException,
                            javax.servlet.ServletException

trigger/run/execute the script on a slave and show the result/output

Parameters:

req -

rsp -

scriptName -

Throws:

java.io.IOException

javax.servlet.ServletException

doEditScript

public void doEditScript(org.kohsuke.stapler.StaplerRequest req,
                         org.kohsuke.stapler.StaplerResponse rsp,
                         @QueryParameter(value="name")
                         java.lang.String scriptName)
                  throws java.io.IOException,
                         javax.servlet.ServletException

Throws:

java.io.IOException

javax.servlet.ServletException

getSlaveNames

public java.util.List<java.lang.String> getSlaveNames()

getCatalogs

public java.util.List<Catalog> getCatalogs()

Gets the remote catalogs containing the available scripts for download.

Returns:

the catalog

getScriptDirectory

public static java.io.File getScriptDirectory()

returns the directory where the script files get stored

Returns:

the script directory

getScriptlerHomeDirectory

public static java.io.File getScriptlerHomeDirectory()