Java Code Examples for org.kohsuke.stapler.StaplerResponse#setStatus()

/**
 * Validates this server endpoint. Checks availability and version requirement.
 * @return If valid HttpStatus 200, if unsupported version then 428 and if unreachable then 400 error code is returned.
 */
@GET
@WebMethod(name="validate")
public HttpResponse validate(){
    String version = BitbucketServerApi.getVersion(apiUrl);
    if(!BitbucketServerApi.isSupportedVersion(version)){
        throw new ServiceException.PreconditionRequired(
                Messages.bbserver_version_validation_error(
                        version, BitbucketServerApi.MINIMUM_SUPPORTED_VERSION));
    }
    return new HttpResponse(){
        @Override
        public void generateResponse(StaplerRequest req, StaplerResponse rsp, Object node) throws IOException, ServletException {
            rsp.setStatus(200);
        }
    };
}
 

private void writeLog(StaplerRequest req, StaplerResponse rsp) {
    try {
        String download = req.getParameter("download");

        if("true".equalsIgnoreCase(download)) {
            rsp.setHeader("Content-Disposition", "attachment; filename=log.txt");
        }

        rsp.setContentType("text/plain;charset=UTF-8");
        rsp.setStatus(HttpServletResponse.SC_OK);

        writeLogs(req, rsp);
    } catch (IOException e) {
        throw new ServiceException.UnexpectedErrorException("Failed to get logText: " + e.getMessage(), e);
    }
}
 

@Override
public void generateResponse( StaplerRequest req, StaplerResponse rsp, Object node )
    throws IOException, ServletException
{
    String v = req.getHeader( "If-None-Match" );
    if ( etag.equals( v ) )
    {
        rsp.setStatus( SC_NOT_MODIFIED );
        return;
    }

    rsp.setHeader( "ETag", etag );
    rsp.setHeader( "Expires", "Fri, 01 Jan 1984 00:00:00 GMT" );
    rsp.setHeader( "Cache-Control", "no-cache, private" );
    rsp.setHeader( "Content-Type", "image/svg+xml;charset=utf-8" );
    rsp.setHeader( "Content-Length", length );
    rsp.getOutputStream().write( payload.getBytes() );
}
 

@Override
public void generateResponse(StaplerRequest req, StaplerResponse rsp, Object node) throws IOException, ServletException {
    rsp.setStatus(status);
    rsp.setContentType("application/json");
    PrintWriter w = rsp.getWriter();
    w.write(toJson());
    w.close();
}
 

/**
 * Writes the token as an HTTP response.
 */
@Override
public void generateResponse(StaplerRequest req, StaplerResponse rsp, Object node) throws IOException, ServletException {
    rsp.setStatus(204);
    /* https://httpstatuses.com/204 No Content
    The server has successfully fulfilled the request and
    that there is no additional content to send in the response payload body */
    rsp.addHeader(X_BLUEOCEAN_JWT, sign());
}
 

/**
 * {@inheritDoc}
 */
@Override
public void generateResponse(StaplerRequest req, StaplerResponse rsp, Object node) throws IOException, ServletException {
    rsp.setStatus(statusCode);
    rsp.setContentType("application/json; charset=UTF-8");
    if (bundleCacheEntry != null) {
        // Set pugin version info that can be used by the browser to
        // determine if it wants to use the resource bundle, or not.
        // The versions may not match (in theory - should never happen),
        // in which case the browser might not want to use the bundle data.
        jsonObject.put("plugin-version-requested", bundleCacheEntry.bundleParams.pluginVersion);
        PluginWrapper pluginWrapper = bundleCacheEntry.bundleParams.getPlugin();
        if(pluginWrapper != null) {
            jsonObject.put("plugin-version-actual", pluginWrapper.getVersion());
        }

        if (bundleCacheEntry.bundleParams.isBrowserCacheable()) {
            // Set the expiry to one year.
            rsp.setHeader("Cache-Control", "public, max-age=31536000");
        } else if (!bundleCacheEntry.bundleParams.isMatchingPluginVersionInstalled()) {
            // This should never really happen if things are installed properly
            // and the UI is coded up properly, with proper access to the installed
            // plugin version.
            LOGGER.log(Level.WARNING, String.format("Unexpected request for Blue Ocean i18n resource bundle '%s'. Installed plugin version '%s' does not match.",
                bundleCacheEntry.bundleParams, pluginWrapper!= null ? pluginWrapper.getVersion() : "unknown"));
        }
    }

    byte[] bytes = jsonObject.toString().getBytes(UTF8);
    rsp.setContentLength(bytes.length);
    rsp.getOutputStream().write(bytes);
}
 

/**
 * Delete all of the user's favorites.
 */
@WebMethod(name = "") @DELETE
public void doDelete(StaplerResponse resp) throws Favorites.FavoriteException {
    for (final Item favorite: Favorites.getFavorites(user.user)) {
        Favorites.removeFavorite(user.user, favorite);
    }
    resp.setStatus(HttpServletResponse.SC_NO_CONTENT);
}
 

@Override
public void generateResponse(StaplerRequest req, StaplerResponse rsp, Object node) throws IOException, ServletException {
    rsp.setStatus(201);
    String location = String.format("%s%s", req.getRootPath(), payload.getLink());
    rsp.addHeader("Location", location);

    // Writes payload as a tree response
    Export.doJson(req, rsp, payload);
}
 

protected HttpResponse createResponse(final String credentialId) {
    return new HttpResponse() {
        @Override
        public void generateResponse(StaplerRequest req, StaplerResponse rsp, Object node) throws IOException, ServletException {
            rsp.setStatus(200);
            rsp.getWriter().print(JsonConverter.toJson(ImmutableMap.of("credentialId", credentialId)));
        }
    };
}
 

/**
 * Exit the WebHook
 *
 * @param result GogsResults
 */
private void exitWebHook(GogsResults result, StaplerResponse resp) throws IOException {
    if (result.getStatus() != 200) {
        LOGGER.warning(result.getMessage());
    }
    //noinspection MismatchedQueryAndUpdateOfCollection
    JSONObject json = new JSONObject();
    json.element("result", result.getStatus() == 200 ? "OK" : "ERROR");
    json.element("message", result.getMessage());
    resp.setStatus(result.getStatus());
    resp.addHeader("Content-Type", "application/json");
    PrintWriter printer = resp.getWriter();
    printer.print(json.toString());
}
 

@Override
public void generateResponse(StaplerRequest req, StaplerResponse rsp, Object node)
        throws IOException, ServletException {
    rsp.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
    rsp.setContentType("text/html;charset=UTF-8");
    rsp.setHeader("X-Jenkins-Select-Error", clearList ? "clear" : "retain");
    rsp.getWriter().print(
            "<div class='error'><img src='" + req.getContextPath()
                    + Jenkins.RESOURCE_PATH + "/images/none.gif' height=16 width=1>" + Util.escape(getMessage()) +
                    "</div>");

}
 

/**
 * Display the test result trend.
 */
public void doTrend( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
    AbstractTestResultAction a = getLastTestResultAction();
    if(a!=null)
        a.doGraph(req,rsp);
    else
        rsp.setStatus(HttpServletResponse.SC_NOT_FOUND);
}
 

/**
 * Generates the clickable map HTML fragment for {@link #doTrend(StaplerRequest, StaplerResponse)}.
 */
public void doTrendMap( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
    AbstractTestResultAction a = getLastTestResultAction();
    if(a!=null)
        a.doGraphMap(req,rsp);
    else
        rsp.setStatus(HttpServletResponse.SC_NOT_FOUND);
}
 

@WebMethod(name="") @DELETE
public void doDelete(StaplerResponse resp) {
    final BitbucketEndpointConfiguration config = BitbucketEndpointConfiguration.get();
    config.removeEndpoint(getApiUrl());
    resp.setStatus(HttpServletResponse.SC_NO_CONTENT);
}