Package jetbrains.buildServer.web.openapi

Interface ControllerAction

public interface ControllerAction

Represents a simple action which can be called by HTTP. Such actions can be registered for a controller using WebControllerManager.registerAction(jetbrains.buildServer.controllers.BaseController, jetbrains.buildServer.web.openapi.ControllerAction) method. A controller can iterate its actions with help of WebControllerManager.getAction(jetbrains.buildServer.controllers.BaseController, javax.servlet.http.HttpServletRequest) method.

Method Summary

Modifier and Type	Method	Description
boolean	canProcess(javax.servlet.http.HttpServletRequest request)	Returns true if specified request can be processed by this action.
void	process(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.jdom.Element ajaxResponse)	Run this action.

Method Detail

canProcess

boolean canProcess(@NotNull
                   javax.servlet.http.HttpServletRequest request)

Returns true if specified request can be processed by this action.

Parameters:

request - request

Returns:

true, if this action can process given request

process

void process(@NotNull
             javax.servlet.http.HttpServletRequest request,
             @NotNull
             javax.servlet.http.HttpServletResponse response,
             @Nullable
             org.jdom.Element ajaxResponse)

Run this action.

Parameters:

request - request

response - response

ajaxResponse - response if action is called by an AJAX request