rewrite-api-servlet 1.0.3.Final
A B C D E F G H I O P R S T V W

A

abort() - Method in class org.ocpsoft.rewrite.servlet.event.BaseRewrite
Abort the current ServletRequest immediately.
abort() - Method in interface org.ocpsoft.rewrite.servlet.event.ServletRewrite
Marks the current ServletRewrite as handled and terminates further handling.
afterInboundLifecycle(T) - Method in interface org.ocpsoft.rewrite.servlet.spi.RewriteLifecycleListener
Invoked after application has returned control of the request to the rewrite engine, but before the rewrite engine calls FilterChain.doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse) or ends the request.
afterInboundRewrite(T) - Method in interface org.ocpsoft.rewrite.servlet.spi.RewriteLifecycleListener
Invoked after RewriteProvider services are processed on inbound Rewrite requests, but before control of the request cycle is passed to the application via FilterChain#doFilter(IN, OUT)
afterOutboundRewrite(T) - Method in interface org.ocpsoft.rewrite.servlet.spi.RewriteLifecycleListener
Invoked after RewriteProvider services are processed on outbound Rewrite events.

B

BaseRewrite<IN extends javax.servlet.ServletRequest,OUT extends javax.servlet.ServletResponse> - Class in org.ocpsoft.rewrite.servlet.event
Base implementation of InboundServletRewriteEvent
BaseRewrite(IN, OUT) - Constructor for class org.ocpsoft.rewrite.servlet.event.BaseRewrite
 
BaseRewrite.Flow - Enum in org.ocpsoft.rewrite.servlet.event
Enum to represent the finite state of the Rewrite container.
beforeInboundLifecycle(T) - Method in interface org.ocpsoft.rewrite.servlet.spi.RewriteLifecycleListener
Invoked before RequestCycleWrapper services are processed.
beforeInboundRewrite(T) - Method in interface org.ocpsoft.rewrite.servlet.spi.RewriteLifecycleListener
Invoked after RequestCycleWrapper services are processed, but before RewriteProvider services are processed for inbound Rewrite requests.
beforeOutboundRewrite(T) - Method in interface org.ocpsoft.rewrite.servlet.spi.RewriteLifecycleListener
Invoked before RewriteProvider services are processed on outbound Rewrite events.

C

contains(BaseRewrite.Flow) - Method in enum org.ocpsoft.rewrite.servlet.event.BaseRewrite.Flow
Return true if the given BaseRewrite.Flow is a descendant of this.
CONTEXT_KEY - Static variable in interface org.ocpsoft.rewrite.servlet.RewriteLifecycleContext
 
contextDestroyed(ServletContextEvent) - Method in interface org.ocpsoft.rewrite.servlet.spi.ContextListener
 
contextInitialized(ServletContextEvent) - Method in interface org.ocpsoft.rewrite.servlet.spi.ContextListener
 
ContextListener - Interface in org.ocpsoft.rewrite.servlet.spi
 
createInboundRewrite(ServletRequest, ServletResponse) - Method in interface org.ocpsoft.rewrite.servlet.spi.InboundRewriteProducer
 
createOutboundRewrite(ServletRequest, ServletResponse, P) - Method in interface org.ocpsoft.rewrite.servlet.spi.OutboundRewriteProducer
 

D

dispatchResource - Variable in class org.ocpsoft.rewrite.servlet.event.BaseRewrite
 

E

evaluate(Rewrite, EvaluationContext) - Method in class org.ocpsoft.rewrite.servlet.config.HttpCondition
 
evaluateHttp(HttpServletRewrite, EvaluationContext) - Method in class org.ocpsoft.rewrite.servlet.config.HttpCondition
Evaluate this condition against the given HttpServletRewrite event.

F

flow - Variable in class org.ocpsoft.rewrite.servlet.event.BaseRewrite
 
forward(String) - Method in class org.ocpsoft.rewrite.servlet.event.BaseRewrite
Once Rule processing has completed, perform a RequestDispatcher.forward(ServletRequest, ServletResponse) to the given resource target.
forward(String) - Method in interface org.ocpsoft.rewrite.servlet.event.InboundServletRewrite
Marks the InboundServletRewriteEvent as handled, terminates further handling, and instructs the container to forward the current ServletRequest and ServletResponse to the specified resource address.

G

getContextPath() - Method in interface org.ocpsoft.rewrite.servlet.http.event.HttpServletRewrite
Return the application context root HttpServletRequest.getContextPath()
getDispatchResource() - Method in class org.ocpsoft.rewrite.servlet.event.BaseRewrite
Get the current dispatch resource.
getDispatchResource() - Method in interface org.ocpsoft.rewrite.servlet.event.InboundServletRewrite
Returns the resource address of the requested InboundServletRewriteEvent#include(String) or InboundServletRewriteEvent#forward(String)
getFlow() - Method in class org.ocpsoft.rewrite.servlet.event.BaseRewrite
Get the current BaseRewrite.Flow state.
getFlow() - Method in interface org.ocpsoft.rewrite.servlet.event.ServletRewrite
Get the current BaseRewrite.Flow state.
getInboundRewriteEventProducers() - Method in interface org.ocpsoft.rewrite.servlet.RewriteLifecycleContext
Get all available InboundRewriteProducer instances.
getOutboundProducers() - Method in interface org.ocpsoft.rewrite.servlet.RewriteLifecycleContext
Get all available OutboundRewriteProducer instances.
getOutboundURL() - Method in interface org.ocpsoft.rewrite.servlet.http.event.HttpOutboundServletRewrite
Get the outbound URL to be rewritten.
getParameters(ServletRequest, ServletResponse) - Method in interface org.ocpsoft.rewrite.servlet.spi.RequestParameterProvider
Return a map of parameters to be added to the current request as if they had been passed with the HTTP request from the browser.
getRequest() - Method in class org.ocpsoft.rewrite.servlet.event.BaseRewrite
Get the current ServletRequest object.
getRequest() - Method in interface org.ocpsoft.rewrite.servlet.event.ServletRewrite
 
getRequestCycleWrappers() - Method in interface org.ocpsoft.rewrite.servlet.RewriteLifecycleContext
Get all available RequestCycleWrapper instances.
getRequestPath() - Method in interface org.ocpsoft.rewrite.servlet.http.event.HttpServletRewrite
Portion of the request URL representing request path within the application.
getRequestQueryString() - Method in interface org.ocpsoft.rewrite.servlet.http.event.HttpServletRewrite
Portion of the request URL representing the query string.
getRequestQueryStringSeparator() - Method in interface org.ocpsoft.rewrite.servlet.http.event.HttpServletRewrite
Portion of the request URL joining the HttpServletRewrite.getRequestPath() and HttpServletRewrite.getRequestQueryString().
getResponse() - Method in class org.ocpsoft.rewrite.servlet.event.BaseRewrite
Get the current ServletResponse object.
getResponse() - Method in interface org.ocpsoft.rewrite.servlet.event.ServletRewrite
 
getRewriteContext() - Method in class org.ocpsoft.rewrite.servlet.event.BaseRewrite
Get the Context for the current Rewrite.
getRewriteLifecycleListeners() - Method in interface org.ocpsoft.rewrite.servlet.RewriteLifecycleContext
Get all available RewriteLifecycleListener instances.
getRewriteProviders() - Method in interface org.ocpsoft.rewrite.servlet.RewriteLifecycleContext
Get all available RewriteProvider instances.
getURL() - Method in interface org.ocpsoft.rewrite.servlet.http.event.HttpServletRewrite
For HttpInboundServletRewrite events, return the request URL excluding context path, but including query string: HttpServletRewrite.getRequestPath() + HttpServletRewrite.getRequestQueryStringSeparator() + HttpServletRewrite.getRequestQueryString()

H

handled() - Method in class org.ocpsoft.rewrite.servlet.event.BaseRewrite
Stop processing Rule definitions and pass control of the the current ServletRequest to the underlying application, even if a call to BaseRewrite.abort(), BaseRewrite.proceed(), BaseRewrite.forward(String), or any other life-cycle control method has previously been made.
handled() - Method in interface org.ocpsoft.rewrite.servlet.event.ServletRewrite
Marks the ServletRewrite as handled and terminates further handling.
handles(Object) - Method in class org.ocpsoft.rewrite.servlet.config.HttpConfigurationProvider
 
handles(Rewrite) - Method in class org.ocpsoft.rewrite.servlet.http.HttpRequestCycleWrapper
 
handles(Rewrite) - Method in class org.ocpsoft.rewrite.servlet.http.HttpRewriteLifecycleListener
 
handles(Rewrite) - Method in class org.ocpsoft.rewrite.servlet.http.HttpRewriteProvider
 
handles(Rewrite) - Method in class org.ocpsoft.rewrite.servlet.ServletRewriteProvider
 
HttpCondition - Class in org.ocpsoft.rewrite.servlet.config
A condition that only applies to HttpServletRewrite events.
HttpCondition() - Constructor for class org.ocpsoft.rewrite.servlet.config.HttpCondition
 
HttpConfigurationProvider - Class in org.ocpsoft.rewrite.servlet.config
Configuration provider for HTTP/Servlet environments.
HttpConfigurationProvider() - Constructor for class org.ocpsoft.rewrite.servlet.config.HttpConfigurationProvider
 
HttpInboundServletRewrite - Interface in org.ocpsoft.rewrite.servlet.http.event
Rewrite event for an HttpServletRequest, HttpServletResponse lifecycle.
HttpOperation - Class in org.ocpsoft.rewrite.servlet.config
An Operation that is only performed if the current Rewrite event is an instance of HttpServletRewrite
HttpOperation() - Constructor for class org.ocpsoft.rewrite.servlet.config.HttpOperation
 
HttpOutboundServletRewrite - Interface in org.ocpsoft.rewrite.servlet.http.event
 
HttpRequestCycleWrapper - Class in org.ocpsoft.rewrite.servlet.http
 
HttpRequestCycleWrapper() - Constructor for class org.ocpsoft.rewrite.servlet.http.HttpRequestCycleWrapper
 
HttpRewriteLifecycleListener - Class in org.ocpsoft.rewrite.servlet.http
A RewriteLifecycleListener that only listens on HttpServletRequest and HttpServletResponse request cycle types.
HttpRewriteLifecycleListener() - Constructor for class org.ocpsoft.rewrite.servlet.http.HttpRewriteLifecycleListener
 
HttpRewriteProvider - Class in org.ocpsoft.rewrite.servlet.http
A RewriteProvider that only operates on HttpServletRequest and HttpServletResponse request cycle types.
HttpRewriteProvider() - Constructor for class org.ocpsoft.rewrite.servlet.http.HttpRewriteProvider
 
HttpServletRewrite - Interface in org.ocpsoft.rewrite.servlet.http.event
 

I

InboundRewriteProducer<IN extends javax.servlet.ServletRequest,OUT extends javax.servlet.ServletResponse> - Interface in org.ocpsoft.rewrite.servlet.spi
 
InboundServletRewrite<IN extends javax.servlet.ServletRequest,OUT extends javax.servlet.ServletResponse> - Interface in org.ocpsoft.rewrite.servlet.event
Immutable event propagated to registered RewriteLifecycleListener and RewriteProvider instances when an inbound as the rewrite lifecycle is executed.
include(String) - Method in class org.ocpsoft.rewrite.servlet.event.BaseRewrite
Once Rule processing has completed, perform a RequestDispatcher.include(ServletRequest, ServletResponse) of the given resource target.
include(String) - Method in interface org.ocpsoft.rewrite.servlet.event.InboundServletRewrite
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.
is(BaseRewrite.Flow) - Method in enum org.ocpsoft.rewrite.servlet.event.BaseRewrite.Flow
Return true if this BaseRewrite.Flow is a descendant of the given value.

O

org.ocpsoft.rewrite.servlet - package org.ocpsoft.rewrite.servlet
 
org.ocpsoft.rewrite.servlet.config - package org.ocpsoft.rewrite.servlet.config
 
org.ocpsoft.rewrite.servlet.event - package org.ocpsoft.rewrite.servlet.event
 
org.ocpsoft.rewrite.servlet.http - package org.ocpsoft.rewrite.servlet.http
 
org.ocpsoft.rewrite.servlet.http.event - package org.ocpsoft.rewrite.servlet.http.event
 
org.ocpsoft.rewrite.servlet.spi - package org.ocpsoft.rewrite.servlet.spi
 
OutboundRewriteProducer<IN extends javax.servlet.ServletRequest,OUT extends javax.servlet.ServletResponse,P> - Interface in org.ocpsoft.rewrite.servlet.spi
 
OutboundServletRewrite<IN extends javax.servlet.ServletRequest,OUT extends javax.servlet.ServletResponse> - Interface in org.ocpsoft.rewrite.servlet.event
 

P

perform(Rewrite, EvaluationContext) - Method in class org.ocpsoft.rewrite.servlet.config.HttpOperation
 
performHttp(HttpServletRewrite, EvaluationContext) - Method in class org.ocpsoft.rewrite.servlet.config.HttpOperation
Perform this operation for the given HttpServletRewrite event.
proceed() - Method in class org.ocpsoft.rewrite.servlet.event.BaseRewrite
Continue processing Rule definitions for the current ServletRequest, even if a call to BaseRewrite.abort(), BaseRewrite.handled(), BaseRewrite.forward(String), or any other life-cycle control method has previously been made.
proceed() - Method in interface org.ocpsoft.rewrite.servlet.event.ServletRewrite
Marks the ServletRewrite as handled and proceeds with the rest of the handlers.

R

redirectPermanent(String) - Method in interface org.ocpsoft.rewrite.servlet.http.event.HttpInboundServletRewrite
If the HttpServletResponse is not already committed, issue a Permanent Redirect (301) and call ServletRewrite.abort().
redirectTemporary(String) - Method in interface org.ocpsoft.rewrite.servlet.http.event.HttpInboundServletRewrite
If the HttpServletResponse is not already committed, issue a Temporary Redirect (302) and call ServletRewrite.abort().
RequestCycleWrapper<IN extends javax.servlet.ServletRequest,OUT extends javax.servlet.ServletResponse> - Interface in org.ocpsoft.rewrite.servlet.spi
 
requestDestroyed(ServletRequestEvent) - Method in interface org.ocpsoft.rewrite.servlet.spi.RequestListener
 
requestInitialized(ServletRequestEvent) - Method in interface org.ocpsoft.rewrite.servlet.spi.RequestListener
 
RequestListener - Interface in org.ocpsoft.rewrite.servlet.spi
 
RequestParameterProvider - Interface in org.ocpsoft.rewrite.servlet.spi
Supplies additional request parameters to the HttpServletRequest object.
RewriteLifecycleContext - Interface in org.ocpsoft.rewrite.servlet
Stores implementations of all Rewrite lifecycle services.
RewriteLifecycleListener<T extends Rewrite> - Interface in org.ocpsoft.rewrite.servlet.spi
Listens to Rewrite life-cycle events.

S

sendErrorCode(int) - Method in interface org.ocpsoft.rewrite.servlet.http.event.HttpInboundServletRewrite
If the HttpServletResponse is not already committed, send an HTTP status code and and call ServletRewrite.abort().
sendErrorCode(int, String) - Method in interface org.ocpsoft.rewrite.servlet.http.event.HttpInboundServletRewrite
If the HttpServletResponse is not already committed, send an HTTP status code and and call ServletRewrite.abort().
sendStatusCode(int) - Method in interface org.ocpsoft.rewrite.servlet.http.event.HttpInboundServletRewrite
If the HttpServletResponse is not already committed, send an HTTP status code, flush the OutputStream buffer, and and call ServletRewrite.abort().
sendStatusCode(int, String) - Method in interface org.ocpsoft.rewrite.servlet.http.event.HttpInboundServletRewrite
If the HttpServletResponse is not already committed, send an HTTP status code, flush the OutputStream buffer, and and call ServletRewrite.abort().
ServletRewrite<IN extends javax.servlet.ServletRequest,OUT extends javax.servlet.ServletResponse> - Interface in org.ocpsoft.rewrite.servlet.event
 
ServletRewriteProvider<T extends ServletRewrite<? extends javax.servlet.ServletRequest,? extends javax.servlet.ServletResponse>> - Class in org.ocpsoft.rewrite.servlet
Abstract implementation of RewriteProvider which only handles ServletRewrite events.
ServletRewriteProvider() - Constructor for class org.ocpsoft.rewrite.servlet.ServletRewriteProvider
 
setFlow(BaseRewrite.Flow) - Method in class org.ocpsoft.rewrite.servlet.event.BaseRewrite
Set the current BaseRewrite.Flow state.
setFlow(BaseRewrite.Flow) - Method in interface org.ocpsoft.rewrite.servlet.event.ServletRewrite
Set the current BaseRewrite.Flow state.
setOutboundURL(String) - Method in interface org.ocpsoft.rewrite.servlet.http.event.HttpOutboundServletRewrite
Set the new outbound URL.
setRequest(IN) - Method in class org.ocpsoft.rewrite.servlet.event.BaseRewrite
Set the current ServletRequest object.
setRequest(IN) - Method in interface org.ocpsoft.rewrite.servlet.event.InboundServletRewrite
Set a new ServletRequest to be used for the remaining duration of the current ServletRequest.
setResponse(OUT) - Method in class org.ocpsoft.rewrite.servlet.event.BaseRewrite
Set the current ServletResponse object.
setResponse(OUT) - Method in interface org.ocpsoft.rewrite.servlet.event.InboundServletRewrite
Set a new ServletResponse to be used for the remaining duration of the current ServletRequest.

T

toString() - Method in class org.ocpsoft.rewrite.servlet.event.BaseRewrite
 

V

valueOf(String) - Static method in enum org.ocpsoft.rewrite.servlet.event.BaseRewrite.Flow
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.ocpsoft.rewrite.servlet.event.BaseRewrite.Flow
Returns an array containing the constants of this enum type, in the order they are declared.

W

wrapRequest(IN, OUT) - Method in interface org.ocpsoft.rewrite.servlet.spi.RequestCycleWrapper
 
wrapResponse(IN, OUT) - Method in interface org.ocpsoft.rewrite.servlet.spi.RequestCycleWrapper
 

A B C D E F G H I O P R S T V W
rewrite-api-servlet 1.0.3.Final

Copyright © 2012 OCPsoft. All Rights Reserved.