Package org.kohsuke.stapler

Class HttpRedirect

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.kohsuke.stapler.HttpRedirect

All Implemented Interfaces:

Serializable, HttpResponse

public final class HttpRedirect
extends RuntimeException
implements HttpResponse

HttpResponse that dose HTTP 302 redirect. Extends from RuntimeException so that you can throw it.

Author:

Kohsuke Kawaguchi

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static HttpResponse	CONTEXT_ROOT	Redirect to the context root
static final HttpRedirect	DOT	Redirect to "."

Constructor Summary

Constructors

Constructor	Description
HttpRedirect(int statusCode, String url)
HttpRedirect(String url)

Method Summary

Modifier and Type	Method	Description
static HttpResponse	fromContextPath(String relative)	Deprecated. Use HttpResponses.redirectViaContextPath(String).
void	generateResponse(StaplerRequest2 req, StaplerResponse2 rsp, Object node)

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kohsuke.stapler.HttpResponse

generateResponse

Field Details

DOT

public static final HttpRedirect DOT

Redirect to "."

CONTEXT_ROOT

public static HttpResponse CONTEXT_ROOT

Redirect to the context root

Constructor Details

HttpRedirect

public HttpRedirect(@NonNull
 String url)

HttpRedirect

public HttpRedirect(int statusCode,
 @NonNull
 String url)

Method Details

generateResponse

public void generateResponse(StaplerRequest2 req,
 StaplerResponse2 rsp,
 Object node)
                      throws IOException,
jakarta.servlet.ServletException

Specified by:

generateResponse in interface HttpResponse

node - The object whose "doXyz" method created this object.

Throws:

IOException

jakarta.servlet.ServletException

fromContextPath

@Deprecated
public static HttpResponse fromContextPath(String relative)

Deprecated.

Use HttpResponses.redirectViaContextPath(String).

Parameters:

relative - The path relative to the context path. The context path + this value is sent to the user.