hudson.maven
Class MavenProbeAction

java.lang.Object
  hudson.maven.MavenProbeAction

All Implemented Interfaces:

Action, ModelObject

public final class MavenProbeAction
extends Object
implements Action

UI for probing Maven process.

This action is added to a build when it's started, and removed when it's completed.

Since:

1.175

Author:

Kohsuke Kawaguchi

Field Summary

AbstractProject<?,?>

owner

Method Summary

void	doScript(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
String	getDisplayName() Gets the string to be displayed.
Map<String,String>	getEnvVars() Gets the environment variables of the JVM on this computer.
RemotingDiagnostics.HeapDump	getHeapDump() Obtains the heap dump.
String	getIconFileName() Gets the file name of the icon.
Map<Object,Object>	getSystemProperties() Gets the system properties of the JVM on this computer.
Map<String,String>	getThreadDump() Gets the thread dump of the slave JVM.
String	getUrlName() Gets the URL path name.

Methods inherited from class java.lang.Object

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

Field Detail

owner

public final AbstractProject<?,?> owner

Method Detail

getIconFileName

public String getIconFileName()

Description copied from interface: Action

Gets the file name of the icon.

Specified by:

getIconFileName in interface Action

Returns:

If just a file name (like "abc.gif") is returned, it will be interpreted as a file name inside /images/24x24. This is useful for using one of the stock images.

If an absolute file name that starts from '/' is returned (like "/plugin/foo/abc.gif'), then it will be interpreted as a path from the context root of Jenkins. This is useful to pick up image files from a plugin.

Finally, return null to hide it from the task list. This is normally not very useful, but this can be used for actions that only contribute floatBox.jelly and no task list item. The other case where this is useful is to avoid showing links that require a privilege when the user is anonymous.

See Also:

Functions.isAnonymous(), Functions.getIconFilePath(Action)

getDisplayName

public String getDisplayName()

Description copied from interface: Action

Gets the string to be displayed. The convention is to capitalize the first letter of each word, such as "Test Result".

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

getUrlName

public String getUrlName()

Description copied from interface: Action

Gets the URL path name.

tions For example, if this method returns "xyz", and if the parent object (that this action is associated with) is bound to /foo/bar/zot, then this action object will be exposed to /foo/bar/zot/xyz.

This method should return a string that's unique among other Actions.

The returned string can be an absolute URL, like "http://www.sun.com/", which is useful for directly connecting to external systems.

If the returned string starts with '/', like '/foo', then it's assumed to be relative to the context path of the Jenkins webapp.

Specified by:

getUrlName in interface Action

Returns:

null if this action object doesn't need to be bound to web (when you do that, be sure to also return null from Action.getIconFileName().

See Also:

Functions.getActionUrl(String, Action)

getSystemProperties

public Map<Object,Object> getSystemProperties()
                                       throws IOException,
                                              InterruptedException

Gets the system properties of the JVM on this computer. If this is the master, it returns the system property of the master computer.

Throws:

IOException

InterruptedException

getEnvVars

public Map<String,String> getEnvVars()
                              throws IOException,
                                     InterruptedException

Gets the environment variables of the JVM on this computer. If this is the master, it returns the system property of the master computer.

Throws:

IOException

InterruptedException

getThreadDump

public Map<String,String> getThreadDump()
                                 throws IOException,
                                        InterruptedException

Gets the thread dump of the slave JVM.

Returns:

key is the thread name, and the value is the pre-formatted dump.

Throws:

IOException

InterruptedException

doScript

public void doScript(org.kohsuke.stapler.StaplerRequest req,
                     org.kohsuke.stapler.StaplerResponse rsp)
              throws IOException,
                     javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

getHeapDump

public RemotingDiagnostics.HeapDump getHeapDump()
                                         throws IOException

Obtains the heap dump.

Throws:

IOException