Index

A B C D E F G H I L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values

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.

ABORT_REQUEST - Enum constant in enum org.ocpsoft.rewrite.servlet.event.BaseRewrite.ServletRewriteFlow

addContentInterceptor(ResponseContentInterceptor) - Method in class org.ocpsoft.rewrite.servlet.RewriteWrappedResponse

Register a new ResponseContentInterceptor for the current HttpServletResponse.

addParameter(String, String...) - Method in class org.ocpsoft.rewrite.servlet.util.QueryStringBuilder

Deprecated.

Add a single parameter with the given values.

addParameterArrays(Map<String, String[]>) - Method in class org.ocpsoft.rewrite.servlet.util.QueryStringBuilder

Deprecated.

Add parameters from the given map of name=value pairs.

addParameterLists(Map<String, List<String>>) - Method in class org.ocpsoft.rewrite.servlet.util.QueryStringBuilder

Deprecated.

Add parameters from the given map of name=value pairs.

addParameters(String) - Method in class org.ocpsoft.rewrite.servlet.util.QueryStringBuilder

Deprecated.

Add parameters from the given URL.

addQueryParameters(String) - Method in class org.ocpsoft.rewrite.servlet.util.URLBuilder

Deprecated.

Parse and add more query parameters to this URLBuilder

addStreamWrapper(ResponseStreamWrapper) - Method in class org.ocpsoft.rewrite.servlet.RewriteWrappedResponse

Register a new ResponseStreamWrapper for the current HttpServletResponse.

afterInboundLifecycle(T) - Method in interface org.ocpsoft.rewrite.servlet.spi.RewriteLifecycleListener

Invoked after application has returned control of the request to the rewrite engine, and after the rewrite engine calls FilterChain.doFilter(jakarta.servlet.ServletRequest, jakarta.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.

appendPathSegments(String) - Method in class org.ocpsoft.rewrite.servlet.util.URLBuilder

Deprecated.

Append additional path segments to the end of this URL.

appendPathSegments(List<String>) - Method in class org.ocpsoft.rewrite.servlet.util.URLBuilder

Deprecated.

Append additional path segments to the end of this URL.

B

BaseRewrite<IN extends jakarta.servlet.ServletRequest,OUT extends jakarta.servlet.ServletResponse> - Class in org.ocpsoft.rewrite.servlet.event

Base implementation of InboundServletRewriteEvent

BaseRewrite(IN, OUT, ServletContext) - Constructor for class org.ocpsoft.rewrite.servlet.event.BaseRewrite

BaseRewrite.ServletRewriteFlow - 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.

buildURLFromSegments(List<String>) - Method in class org.ocpsoft.rewrite.servlet.util.Metadata

Deprecated.

C

contains(BaseRewrite.ServletRewriteFlow) - Method in enum org.ocpsoft.rewrite.servlet.event.BaseRewrite.ServletRewriteFlow

Return true if the given BaseRewrite.ServletRewriteFlow is a descendant of this.

contextDestroyed(ServletContextEvent) - Method in interface org.ocpsoft.rewrite.servlet.spi.ContextListener

Respond to ServletContext destroyed event.

contextInitialized(ServletContextEvent) - Method in interface org.ocpsoft.rewrite.servlet.spi.ContextListener

Respond to ServletContext initialized event.

ContextListener - Interface in org.ocpsoft.rewrite.servlet.spi

Listens to ServletContextEvent.

CONTINUE - Enum constant in enum org.ocpsoft.rewrite.servlet.event.BaseRewrite.ServletRewriteFlow

copy() - Method in class org.ocpsoft.rewrite.servlet.util.Metadata

Deprecated.

Return a copy of this Metadata

createFrom(String) - Static method in class org.ocpsoft.rewrite.servlet.util.URLBuilder

Deprecated.

Create a new instance of URLBuilder from the given URL path segments.

createFrom(List<String>, Metadata) - Static method in class org.ocpsoft.rewrite.servlet.util.URLBuilder

Deprecated.

Create a new instance of URLBuilder from the given URL path segments and Metadata.

createFrom(List<String>, Metadata, QueryStringBuilder) - Static method in class org.ocpsoft.rewrite.servlet.util.URLBuilder

Deprecated.

Create a new instance of URLBuilder from the given URL segments, Metadata, and QueryStringBuilder.

createFromArrays(Map<String, String[]>) - Static method in class org.ocpsoft.rewrite.servlet.util.QueryStringBuilder

Deprecated.

Build a query string from the given map of name=value pairs.

createFromEncoded(String) - Static method in class org.ocpsoft.rewrite.servlet.util.QueryStringBuilder

Deprecated.

Build a query string from the given URL.

createFromLists(Map<String, List<String>>) - Static method in class org.ocpsoft.rewrite.servlet.util.QueryStringBuilder

Deprecated.

Build a query string from the given map of name=value pairs.

createInboundRewrite(ServletRequest, ServletResponse, ServletContext) - Method in interface org.ocpsoft.rewrite.servlet.spi.InboundRewriteProducer

Create an InboundServletRewrite instance.

createNew() - Static method in class org.ocpsoft.rewrite.servlet.util.QueryStringBuilder

Deprecated.

Return a new empty instance of QueryStringBuilder

createNew() - Static method in class org.ocpsoft.rewrite.servlet.util.URLBuilder

Deprecated.

Return a new instance of URLBuilder.

createOutboundRewrite(ServletRequest, ServletResponse, ServletContext, PAYLOADTYPE) - Method in interface org.ocpsoft.rewrite.servlet.spi.OutboundRewriteProducer

Create an OutboundServletRewrite instance.

D

decode() - Method in class org.ocpsoft.rewrite.servlet.util.QueryStringBuilder

Deprecated.

Return a new QueryStringBuilder instance having called URLDecoder.decode(String, String) on each name=value pair.

decode() - Method in class org.ocpsoft.rewrite.servlet.util.URLBuilder

Deprecated.

Return this URLBuilder after path segments and query parameters have been decoded.

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

E

encode() - Method in class org.ocpsoft.rewrite.servlet.util.QueryStringBuilder

Deprecated.

Return a new QueryStringBuilder instance having called URLEncoder.encode(String, String) on each name=value pair.

encode() - Method in class org.ocpsoft.rewrite.servlet.util.URLBuilder

Deprecated.

Return this URLBuilder after path segments and query parameters have been encoded.

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.

extractQuery(String) - Static method in class org.ocpsoft.rewrite.servlet.util.QueryStringBuilder

Deprecated.

Get the query string portion of the given URL.

F

finish(HttpServletRewrite) - Method in interface org.ocpsoft.rewrite.servlet.config.response.ResponseStreamWrapper

Perform necessary final operations on the OutputStream for the current HttpServletRewrite.

finishStreamWrappers() - Method in class org.ocpsoft.rewrite.servlet.RewriteWrappedResponse

Call ResponseStreamWrapper#finish() any registered instances of ResponseStreamWrapper.

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

flushBufferedContent() - Method in class org.ocpsoft.rewrite.servlet.RewriteWrappedResponse

Flush any content that may be buffered in registered ResponseContentInterceptor instances.

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.

FORWARD - Enum constant in enum org.ocpsoft.rewrite.servlet.event.BaseRewrite.ServletRewriteFlow

G

getAdditionalParameters(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.

getAddress() - Method in interface org.ocpsoft.rewrite.servlet.http.event.HttpServletRewrite

For HttpInboundServletRewrite events, return the request Address.

getCharset() - Method in interface org.ocpsoft.rewrite.servlet.config.response.ResponseContent

Get the Charset with which response output is encoded.

getContents() - Method in interface org.ocpsoft.rewrite.servlet.config.response.ResponseContent

Get the contents of this buffer.

getContextPath() - Method in interface org.ocpsoft.rewrite.servlet.http.event.HttpServletRewrite

Return the application context root HttpServletRequest.getContextPath()

getCurrentInstance(ServletRequest) - Static method in class org.ocpsoft.rewrite.servlet.RewriteWrappedRequest

Get the current RewriteWrappedRequest

getCurrentInstance(ServletRequest) - Static method in class org.ocpsoft.rewrite.servlet.RewriteWrappedResponse

Get the current RewriteWrappedResponse isntance for the current ServletRequest

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)

getEncoding() - Method in class org.ocpsoft.rewrite.servlet.util.Metadata

Deprecated.

getEncoding() - Method in class org.ocpsoft.rewrite.servlet.util.URLBuilder

Deprecated.

Get the character encoding of this URL (default UTF-8)

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

Get the current BaseRewrite.ServletRewriteFlow state.

getInboundAddress() - Method in interface org.ocpsoft.rewrite.servlet.http.event.HttpServletRewrite

Get the full Address of the current request.

getInboundRewriteEventProducers() - Method in interface org.ocpsoft.rewrite.servlet.RewriteLifecycleContext

Get all available InboundRewriteProducer instances.

getMetadata() - Method in class org.ocpsoft.rewrite.servlet.util.URLBuilder

Deprecated.

Get the Metadata object for this URL

getModifiableParameters() - Method in class org.ocpsoft.rewrite.servlet.RewriteWrappedRequest

Get the current Map of modifiable HttpServletRequest parameters.

getOriginalOutboundAddress() - Method in interface org.ocpsoft.rewrite.servlet.http.event.HttpOutboundServletRewrite

Get the original outbound Address (before any modifications.)

getOutboundAddress() - Method in interface org.ocpsoft.rewrite.servlet.event.OutboundServletRewrite

Returns the outbound resource.

getOutboundProducers() - Method in interface org.ocpsoft.rewrite.servlet.RewriteLifecycleContext

Get all available OutboundRewriteProducer instances.

getParameter(String) - Method in class org.ocpsoft.rewrite.servlet.util.QueryStringBuilder

Deprecated.

Get the first value of given parameter name.

getParameterMap() - Method in class org.ocpsoft.rewrite.servlet.util.QueryStringBuilder

Deprecated.

Get the name, values[] map representing this query string.

getParameterNames() - Method in class org.ocpsoft.rewrite.servlet.util.QueryStringBuilder

Deprecated.

Get set of parameter names currently stored in this query string.

getParameterValues(String) - Method in class org.ocpsoft.rewrite.servlet.util.QueryStringBuilder

Deprecated.

Get the array of values for a given parameter name.

getQueryStringBuilder() - Method in class org.ocpsoft.rewrite.servlet.util.URLBuilder

Deprecated.

Get the QueryStringBuilder object for this URL

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

Get the current ServletRequest.

getRequest() - Method in class org.ocpsoft.rewrite.servlet.RewriteWrappedResponse

Get the HttpServletRequest to which this RewriteWrappedResponse is associated.

getRequestCycleWrappers() - Method in interface org.ocpsoft.rewrite.servlet.RewriteLifecycleContext

Get all available RequestCycleWrapper instances.

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

Get the current ServletResponse.

getResultHandlers() - Method in interface org.ocpsoft.rewrite.servlet.RewriteLifecycleContext

Get all available RewriteResultHandler instances.

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.

getSegments() - Method in class org.ocpsoft.rewrite.servlet.util.URLBuilder

Deprecated.

Return all segments (separated by '/') in this URL

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

Get the current ServletContext object.

getServletContext() - Method in interface org.ocpsoft.rewrite.servlet.event.ServletRewrite

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.

HANDLED - Enum constant in enum org.ocpsoft.rewrite.servlet.event.BaseRewrite.ServletRewriteFlow

handleResult(Rewrite) - Method in interface org.ocpsoft.rewrite.servlet.spi.RewriteResultHandler

Perform any actions necessary to respond to state of the system after the given Rewrite event has been processed.

handles(Object) - Method in class org.ocpsoft.rewrite.servlet.config.HttpConfigurationCacheProvider

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

hasLeadingSlash() - Method in class org.ocpsoft.rewrite.servlet.util.Metadata

Deprecated.

hasLeadingSlash() - Method in class org.ocpsoft.rewrite.servlet.util.URLBuilder

Deprecated.

Return true if this URL begins with '/'

hasTrailingSlash() - Method in class org.ocpsoft.rewrite.servlet.util.Metadata

Deprecated.

hasTrailingSlash() - Method in class org.ocpsoft.rewrite.servlet.util.URLBuilder

Deprecated.

Return true if this URL ends with '/'

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

HttpConfigurationCacheProvider - Class in org.ocpsoft.rewrite.servlet.config

ConfigurationCacheProvider for HTTP/Servlet environments.

HttpConfigurationCacheProvider() - Constructor for class org.ocpsoft.rewrite.servlet.config.HttpConfigurationCacheProvider

HttpConfigurationProvider - Class in org.ocpsoft.rewrite.servlet.config

ConfigurationProvider 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

Provides an opportunity for extensions to wrap the HttpServletRequest and HttpServletResponse object on each request-response cycle.

HttpRequestCycleWrapper() - Constructor for class org.ocpsoft.rewrite.servlet.http.HttpRequestCycleWrapper

HttpRewriteLifecycleContext - Interface in org.ocpsoft.rewrite.servlet.http

An extension of RewriteLifecycleContext specialized for the Servlet environment.

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 jakarta.servlet.ServletRequest,OUT extends jakarta.servlet.ServletResponse> - Interface in org.ocpsoft.rewrite.servlet.spi

SPI for creating InboundServletRewrite event types.

InboundServletRewrite<IN extends jakarta.servlet.ServletRequest,OUT extends jakarta.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.

INCLUDE - Enum constant in enum org.ocpsoft.rewrite.servlet.event.BaseRewrite.ServletRewriteFlow

INSTANCE_KEY - Static variable in class org.ocpsoft.rewrite.servlet.RewriteWrappedResponse

intercept(HttpServletRewrite, ResponseContent, ResponseContentInterceptorChain) - Method in interface org.ocpsoft.rewrite.servlet.config.response.ResponseContentInterceptor

Perform modifications on the fully buffered ServletResponse.getOutputStream() contents.

is(Flow) - Method in enum org.ocpsoft.rewrite.servlet.event.BaseRewrite.ServletRewriteFlow

is(BaseRewrite.ServletRewriteFlow) - Method in enum org.ocpsoft.rewrite.servlet.event.BaseRewrite.ServletRewriteFlow

Return true if this BaseRewrite.ServletRewriteFlow is a descendant of the given value.

isEmpty() - Method in class org.ocpsoft.rewrite.servlet.util.QueryStringBuilder

Deprecated.

Return true if this query string currently contains no parameters.

isHandled() - Method in enum org.ocpsoft.rewrite.servlet.event.BaseRewrite.ServletRewriteFlow

isResponseContentIntercepted() - Method in class org.ocpsoft.rewrite.servlet.RewriteWrappedResponse

Return true if any ResponseContentInterceptor instances have been registered on the current HttpServletResponse.

isResponseStreamWrapped() - Method in class org.ocpsoft.rewrite.servlet.RewriteWrappedResponse

Return true if any ResponseStreamWrapper instances have been registered on the current HttpServletResponse.

L

LIFECYCLE_CONTEXT_KEY - Static variable in interface org.ocpsoft.rewrite.servlet.RewriteLifecycleContext

M

Metadata - Class in org.ocpsoft.rewrite.servlet.util

Deprecated.

Use AddressBuilder instead. May be removed in subsequent releases.

Metadata() - Constructor for class org.ocpsoft.rewrite.servlet.util.Metadata

Deprecated.

N

numSegments() - Method in class org.ocpsoft.rewrite.servlet.util.URLBuilder

Deprecated.

Get the number of segments (separated by '/') in this URL

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.config.response - package org.ocpsoft.rewrite.servlet.config.response

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

org.ocpsoft.rewrite.servlet.util - package org.ocpsoft.rewrite.servlet.util

OutboundRewriteProducer<IN extends jakarta.servlet.ServletRequest,OUT extends jakarta.servlet.ServletResponse,PAYLOADTYPE> - Interface in org.ocpsoft.rewrite.servlet.spi

SPI for creating OutboundRewriteEvent instances.

OutboundServletRewrite<IN extends jakarta.servlet.ServletRequest,OUT extends jakarta.servlet.ServletResponse,PAYLOADTYPE> - Interface in org.ocpsoft.rewrite.servlet.event

P

perform(Rewrite, EvaluationContext) - Method in class org.ocpsoft.rewrite.servlet.config.HttpOperation

perform(ServletRewrite<?, ?>, EvaluationContext, Flow, SubflowTask) - Static method in class org.ocpsoft.rewrite.servlet.event.SubflowTask

Perform the given SubflowTask using the given ServletRewrite event initialized with a new BaseRewrite.ServletRewriteFlow.

perform(ServletRewrite<?, ?>, EvaluationContext, SubflowTask) - Static method in class org.ocpsoft.rewrite.servlet.event.SubflowTask

Perform the given SubflowTask using the given ServletRewrite event.

performHttp(HttpServletRewrite, EvaluationContext) - Method in class org.ocpsoft.rewrite.servlet.config.HttpOperation

Perform this operation for the given HttpServletRewrite event.

performInSubflow(ServletRewrite<?, ?>, EvaluationContext) - Method in class org.ocpsoft.rewrite.servlet.event.SubflowTask

The task to be performed in a sub-BaseRewrite.ServletRewriteFlow.

proceed() - Method in interface org.ocpsoft.rewrite.servlet.config.response.ResponseContentInterceptorChain

Invoke the next ResponseContentInterceptor in the chain.

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.

PROCEED - Enum constant in enum org.ocpsoft.rewrite.servlet.event.BaseRewrite.ServletRewriteFlow

Q

QueryStringBuilder - Class in org.ocpsoft.rewrite.servlet.util

Deprecated.

Use AddressBuilder instead. May be removed in subsequent releases.

QueryStringBuilder() - Constructor for class org.ocpsoft.rewrite.servlet.util.QueryStringBuilder

Deprecated.

R

REDIRECT_PERMANENT - Enum constant in enum org.ocpsoft.rewrite.servlet.event.BaseRewrite.ServletRewriteFlow

REDIRECT_TEMPORARY - Enum constant in enum org.ocpsoft.rewrite.servlet.event.BaseRewrite.ServletRewriteFlow

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().

removeParameter(String) - Method in class org.ocpsoft.rewrite.servlet.util.QueryStringBuilder

Deprecated.

RequestCycleWrapper<IN extends jakarta.servlet.ServletRequest,OUT extends jakarta.servlet.ServletResponse> - Interface in org.ocpsoft.rewrite.servlet.spi

Provides an opportunity for extensions to wrap the ServletRequest and ServletResponse object on each request-response cycle.

requestDestroyed(ServletRequestEvent) - Method in interface org.ocpsoft.rewrite.servlet.spi.RequestListener

Respond to ServletContext destroyed event.

requestInitialized(ServletRequestEvent) - Method in interface org.ocpsoft.rewrite.servlet.spi.RequestListener

Respond to ServletRequest initialized event.

RequestListener - Interface in org.ocpsoft.rewrite.servlet.spi

Respond to ServletRequest event types.

RequestParameterProvider - Interface in org.ocpsoft.rewrite.servlet.spi

Supplies additional request parameters to the HttpServletRequest object.

resolveFrom(Class<?>) - Method in interface org.ocpsoft.rewrite.servlet.spi.ResourcePathResolver

Resolve the server side target resource.

ResourcePathResolver - Interface in org.ocpsoft.rewrite.servlet.spi

SPI which is responsible to resolve the server-side target resource assigned to a given Class.

ResponseContent - Interface in org.ocpsoft.rewrite.servlet.config.response

Holds contents of the fully completed HttpServletResponse.

ResponseContentInterceptor - Interface in org.ocpsoft.rewrite.servlet.config.response

An intercepter that operates on the fully buffered ServletResponse.getOutputStream() before flushing to the client, once the control of the application has been returned to Rewrite.

ResponseContentInterceptorChain - Interface in org.ocpsoft.rewrite.servlet.config.response

Chain responsible for controlling interception of ResponseContentInterceptor instances.

ResponseStreamWrapper - Interface in org.ocpsoft.rewrite.servlet.config.response

A wrapper for the HttpServletResponse content OutputStream.

rewrite(Rewrite) - Method in class org.ocpsoft.rewrite.servlet.http.HttpRewriteProvider

rewriteHttp(HttpServletRewrite) - Method in class org.ocpsoft.rewrite.servlet.http.HttpRewriteProvider

Handle the current HttpServletRewrite event.

RewriteLifecycleContext<CONTEXTTYPE> - 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.

RewriteResultHandler - Interface in org.ocpsoft.rewrite.servlet.spi

Handles responses to take after a Rewrite event has been processed.

RewriteWrappedRequest - Class in org.ocpsoft.rewrite.servlet

An HttpServletRequestWrapper for the Rewrite framework

RewriteWrappedRequest(HttpServletRequest) - Constructor for class org.ocpsoft.rewrite.servlet.RewriteWrappedRequest

Create a new RewriteWrappedRequest

RewriteWrappedResponse - Class in org.ocpsoft.rewrite.servlet

A HttpServletResponseWrapper for the Rewrite framework.

RewriteWrappedResponse(HttpServletRequest, HttpServletResponse) - Constructor for class org.ocpsoft.rewrite.servlet.RewriteWrappedResponse

Create a new RewriteWrappedResponse instance.

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 jakarta.servlet.ServletRequest,OUT extends jakarta.servlet.ServletResponse> - Interface in org.ocpsoft.rewrite.servlet.event

ServletRewriteProvider<T extends ServletRewrite<? extends jakarta.servlet.ServletRequest,? extends jakarta.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

setCharset(Charset) - Method in interface org.ocpsoft.rewrite.servlet.config.response.ResponseContent

Set the Charset with which response output will be encoded.

setContents(byte[]) - Method in interface org.ocpsoft.rewrite.servlet.config.response.ResponseContent

Set the contents of this buffer.

setCurrentInstance(RewriteWrappedRequest) - Static method in class org.ocpsoft.rewrite.servlet.RewriteWrappedRequest

Set the current RewriteWrappedRequest

setCurrentInstance(RewriteWrappedResponse) - Method in class org.ocpsoft.rewrite.servlet.RewriteWrappedResponse

Set the current RewriteWrappedResponse instance.

setEncoding(String) - Method in class org.ocpsoft.rewrite.servlet.util.Metadata

Deprecated.

setEncoding(String) - Method in class org.ocpsoft.rewrite.servlet.util.URLBuilder

Deprecated.

Set the character encoding of this URL (default UTF-8)

setFlow(Flow) - Method in interface org.ocpsoft.rewrite.servlet.event.ServletRewrite

Set the current Flow state.

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

Set the current BaseRewrite.ServletRewriteFlow state.

setLeadingSlash(boolean) - Method in class org.ocpsoft.rewrite.servlet.util.Metadata

Deprecated.

setMetadata(Metadata) - Method in class org.ocpsoft.rewrite.servlet.util.URLBuilder

Deprecated.

Set the Metadata object for this URL

setOutboundAddress(Address) - Method in interface org.ocpsoft.rewrite.servlet.http.event.HttpOutboundServletRewrite

Set the new outbound Address.

setQueryString(QueryStringBuilder) - Method in class org.ocpsoft.rewrite.servlet.util.URLBuilder

Deprecated.

Set the QueryStringBuilder object for this 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.

setTrailingSlash(boolean) - Method in class org.ocpsoft.rewrite.servlet.util.Metadata

Deprecated.

SubflowTask - Class in org.ocpsoft.rewrite.servlet.event

Defines a task to be performed within a sub-BaseRewrite.ServletRewriteFlow of a given ServletRewrite

SubflowTask() - Constructor for class org.ocpsoft.rewrite.servlet.event.SubflowTask

T

toPath() - Method in class org.ocpsoft.rewrite.servlet.util.URLBuilder

Deprecated.

Return the portion of this URL representing the path.

toQueryString() - Method in class org.ocpsoft.rewrite.servlet.util.QueryStringBuilder

Deprecated.

Convert the current parameters to a valid query string, including the leading '?' character.

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

toString() - Method in class org.ocpsoft.rewrite.servlet.util.QueryStringBuilder

Deprecated.

toString() - Method in class org.ocpsoft.rewrite.servlet.util.URLBuilder

Deprecated.

Return a String representation of this URL

toURI() - Method in class org.ocpsoft.rewrite.servlet.util.URLBuilder

Deprecated.

Return a URI representation of this URL including path and query string

toURL() - Method in class org.ocpsoft.rewrite.servlet.util.URLBuilder

Deprecated.

Return a String representation of this URL including path and query string

U

UN_HANDLED - Enum constant in enum org.ocpsoft.rewrite.servlet.event.BaseRewrite.ServletRewriteFlow

URLBuilder - Class in org.ocpsoft.rewrite.servlet.util

Deprecated.

Use AddressBuilder instead. May be removed in subsequent releases.

V

valueOf(String) - Static method in enum org.ocpsoft.rewrite.servlet.event.BaseRewrite.ServletRewriteFlow

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.ocpsoft.rewrite.servlet.event.BaseRewrite.ServletRewriteFlow

Returns an array containing the constants of this enum type, in the order they are declared.

W

wrap(HttpServletRewrite, OutputStream) - Method in interface org.ocpsoft.rewrite.servlet.config.response.ResponseStreamWrapper

Wrap the OutputStream for the current HttpServletRewrite.

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

Wrap the inbound RequestCycleWrapper object.

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

Wrap the outbound RequestCycleWrapper object.

A B C D E F G H I L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values