Package org.ocpsoft.rewrite.servlet.event

Interface InboundServletRewrite<IN extends jakarta.servlet.ServletRequest,OUT extends jakarta.servlet.ServletResponse>

All Superinterfaces:

InboundRewrite, Rewrite, ServletRewrite<IN,OUT>

All Known Subinterfaces:

HttpInboundServletRewrite

public interface InboundServletRewrite<IN extends jakarta.servlet.ServletRequest,OUT extends jakarta.servlet.ServletResponse>
extends InboundRewrite, ServletRewrite<IN,OUT>

Immutable event propagated to registered RewriteLifecycleListener and RewriteProvider instances when an inbound as the rewrite lifecycle is executed.

Author:

Lincoln Baxter, III

Method Summary

Modifier and Type	Method	Description
void	forward(String resource)	Marks the InboundServletRewriteEvent as handled, terminates further handling, and instructs the container to forward the current ServletRequest and ServletResponse to the specified resource address.
String	getDispatchResource()	Returns the resource address of the requested InboundServletRewriteEvent#include(String) or InboundServletRewriteEvent#forward(String)
void	include(String resource)	Marks the InboundServletRewriteEvent as handled, terminates further handling, and instructs the container to include the specified resource address in the current ServletRequest and ServletResponse cycle.
void	setRequest(IN request)	Set a new ServletRequest to be used for the remaining duration of the current ServletRequest.
void	setResponse(OUT response)	Set a new ServletResponse to be used for the remaining duration of the current ServletRequest.

Methods inherited from interface org.ocpsoft.rewrite.event.Rewrite

getEvaluatedRules, getFlow, getRewriteContext

Methods inherited from interface org.ocpsoft.rewrite.servlet.event.ServletRewrite

abort, getRequest, getResponse, getServletContext, handled, proceed, setFlow

Method Details

include

void include(String resource)

Marks the InboundServletRewriteEvent as handled, terminates further handling, and instructs the container to include the specified resource address in the current ServletRequest and ServletResponse cycle. This include must be implemented using RequestDispatcher.include(ServletRequest, ServletResponse)

forward

void forward(String resource)

Marks the InboundServletRewriteEvent as handled, terminates further handling, and instructs the container to forward the current ServletRequest and ServletResponse to the specified resource address. This forward must be implemented using RequestDispatcher.forward(ServletRequest, ServletResponse)

setRequest

void setRequest(IN request)

Set a new ServletRequest to be used for the remaining duration of the current ServletRequest. This method is usually used to add ServletRequestWrapper implementations.

setResponse

void setResponse(OUT response)

Set a new ServletResponse to be used for the remaining duration of the current ServletRequest. This method is usually used to add ServletResponseWrapper implementations.

getDispatchResource

String getDispatchResource()

Returns the resource address of the requested InboundServletRewriteEvent#include(String) or InboundServletRewriteEvent#forward(String)