org.kohsuke.stapler
Class HttpResponseRenderer

java.lang.Object
  org.kohsuke.stapler.HttpResponseRenderer

Direct Known Subclasses:

HttpResponseRenderer.Default

public abstract class HttpResponseRenderer
extends java.lang.Object

Pluggable interface that takes the return value from request handling methods and convert that to HTTP responses.

Author:

Kohsuke Kawaguchi

Nested Class Summary

static class

HttpResponseRenderer.Default Default HttpResponseRenderer.

Constructor Summary

HttpResponseRenderer()

Method Summary

abstract boolean

generateResponse(StaplerRequest req, StaplerResponse rsp, java.lang.Object node, java.lang.Object response)

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpResponseRenderer

public HttpResponseRenderer()

Method Detail

generateResponse

public abstract boolean generateResponse(StaplerRequest req,
                                         StaplerResponse rsp,
                                         java.lang.Object node,
                                         java.lang.Object response)
                                  throws java.io.IOException,
                                         javax.servlet.ServletException

Parameters:

node - Object that handled the request.

response - The return value or the exception from the method.

Returns:

true if the response object was understood and rendered by this method. false otherwise, in which case the next HttpResponseRenderer will be consulted.

Throws:

java.io.IOException

javax.servlet.ServletException