Package jenkins.agents

Class WebSocketAgents

java.lang.Object

hudson.model.InvisibleAction

jenkins.agents.WebSocketAgents

All Implemented Interfaces:

ExtensionPoint, Action, ModelObject, RootAction, UnprotectedRootAction

@Extension
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public final class WebSocketAgents
extends InvisibleAction
implements UnprotectedRootAction

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
WebSocketAgents()

Method Summary

Modifier and Type	Method	Description
org.kohsuke.stapler.HttpResponse	doIndex(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
String	getUrlName()	Gets the URL path name.

Methods inherited from class hudson.model.InvisibleAction

getDisplayName, getIconFileName

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.Action

getDisplayName, getIconFileName

Constructor Detail

WebSocketAgents

public WebSocketAgents()

Method Detail

getUrlName

public String getUrlName()

Description copied from interface: Action

Gets the URL path name.

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

Overrides:

getUrlName in class InvisibleAction

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)

doIndex

public org.kohsuke.stapler.HttpResponse doIndex(org.kohsuke.stapler.StaplerRequest req,
                                                org.kohsuke.stapler.StaplerResponse rsp)
                                         throws IOException

Throws:

IOException