Class ChatbotApiAction

java.lang.Object

io.jenkins.plugins.chatbot.ChatbotApiAction

All Implemented Interfaces:

ExtensionPoint, Action, ModelObject, RootAction

@Extension
public class ChatbotApiAction
extends Object
implements RootAction

Nested Class Summary

Nested classes/interfaces inherited from interface ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
ChatbotApiAction()

Method Summary

Modifier and Type	Method	Description
void	doDynamic(org.kohsuke.stapler.StaplerRequest2 request, org.kohsuke.stapler.StaplerResponse2 response)	Intercepts all requests matching /chatbot-api/* and acts as a proxy.
void	doWorkspaceFile(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp, String jobName, int buildNumber, String workspaceId, String filePath)	Reads the content of a specific file within a specific workspace.
void	doWorkspaceTree(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp, String jobName, int buildNumber)	Retrieves the tree of all workspaces for a specific build.
String	getDisplayName()
String	getIconFileName()
String	getUIPath(org.kohsuke.stapler.StaplerRequest2 request)
String	getUrlName()

Methods inherited from class Object

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

Methods inherited from interface RootAction

getBadge, isPrimaryAction

Constructor Details

ChatbotApiAction

public ChatbotApiAction()

Method Details

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface Action

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface Action

getUIPath

public String getUIPath(org.kohsuke.stapler.StaplerRequest2 request)
                 throws Exception

Throws:

Exception

doDynamic

public void doDynamic(org.kohsuke.stapler.StaplerRequest2 request,
 org.kohsuke.stapler.StaplerResponse2 response)
               throws Exception

Intercepts all requests matching /chatbot-api/* and acts as a proxy.

Throws:

Exception

doWorkspaceTree

public void doWorkspaceTree(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp,
 @QueryParameter
 String jobName,
 @QueryParameter
 int buildNumber)
                     throws Exception

Retrieves the tree of all workspaces for a specific build. Example URL: /chatbot/workspaceTree?jobName=my-pipeline&buildNumber=12

Throws:

Exception

doWorkspaceFile

public void doWorkspaceFile(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp,
 @QueryParameter
 String jobName,
 @QueryParameter
 int buildNumber,
 @QueryParameter
 String workspaceId,
 @QueryParameter
 String filePath)
                     throws Exception

Reads the content of a specific file within a specific workspace. Example URL: /chatbot/workspaceFile?jobName=my-pipeline&buildNumber=12&workspaceId=ws-pipeline-1&filePath=src/main/App.java

Throws:

Exception