Index

C D E G H I K O R S V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

C

ChainListener - Class in org.apache.commons.chain.web.jakarta

ServletContextListener that automatically scans chain configuration files in the current web application at startup time, and exposes the result in a Catalog under a specified servlet context attribute.

ChainListener() - Constructor for class org.apache.commons.chain.web.jakarta.ChainListener

The Default-Constructor for this class.

ChainServlet - Class in org.apache.commons.chain.web.jakarta

Servlet that automatically scans chain configuration files in the current web application at startup time, and exposes the result in a Catalog under a specified servlet context attribute.

ChainServlet() - Constructor for class org.apache.commons.chain.web.jakarta.ChainServlet

The Default-Constructor for this class.

CONFIG_ATTR - Static variable in class org.apache.commons.chain.web.jakarta.ChainListener

The name of the context init parameter containing the name of the servlet context attribute under which our resulting Catalog will be stored.

CONFIG_ATTR - Static variable in class org.apache.commons.chain.web.jakarta.ChainServlet

The name of the context init parameter containing the name of the servlet context attribute under which our resulting Catalog will be stored.

CONFIG_CLASS_RESOURCE - Static variable in class org.apache.commons.chain.web.jakarta.ChainListener

The name of the context init parameter containing a comma-delimited list of class loader resources to be scanned.

CONFIG_CLASS_RESOURCE - Static variable in class org.apache.commons.chain.web.jakarta.ChainServlet

The name of the context init parameter containing a comma-delimited list of class loader resources to be scanned.

CONFIG_WEB_RESOURCE - Static variable in class org.apache.commons.chain.web.jakarta.ChainListener

The name of the context init parameter containing a comma-delimited list of web application resources to be scanned.

CONFIG_WEB_RESOURCE - Static variable in class org.apache.commons.chain.web.jakarta.ChainServlet

The name of the context init parameter containing a comma-delimited list of web application resources to be scanned.

containsKey(Object) - Method in class org.apache.commons.chain.web.jakarta.internal.CookieMap

Returns true if this cookie-map contains a mapping for the specified cookie-name.

containsValue(Object) - Method in class org.apache.commons.chain.web.jakarta.internal.CookieMap

Returns true if this cookie-map maps one or more keys to the specified cookie.

contextDestroyed(ServletContextEvent) - Method in class org.apache.commons.chain.web.jakarta.ChainListener

Remove the configured Catalog from the servlet context attributes for this web application.

contextInitialized(ServletContextEvent) - Method in class org.apache.commons.chain.web.jakarta.ChainListener

Scan the required chain configuration resources, assemble the configured chains into a Catalog, and expose it as a servlet context attribute under the specified key.

CookieMap<P> - Class in org.apache.commons.chain.web.jakarta.internal

Implementation of Map for cookies with a parameter-provider.

CookieMap(P, Supplier<Cookie[]>) - Constructor for class org.apache.commons.chain.web.jakarta.internal.CookieMap

The constructor for the Map for cookies.

D

destroy() - Method in class org.apache.commons.chain.web.jakarta.ChainServlet

Clean up after ourselves as this application shuts down.

E

entrySet() - Method in class org.apache.commons.chain.web.jakarta.internal.CookieMap

Returns a Set view of the mappings contained in this cookie-map.

equals(Object) - Method in class org.apache.commons.chain.web.jakarta.internal.CookieMap

Compares the specified object with this cookie-map for equality.

execute(C) - Method in class org.apache.commons.chain.web.jakarta.GetLocaleCommand

Retrieve the Locale for this request, and store it under the specified context attribute.

execute(C) - Method in class org.apache.commons.chain.web.jakarta.SetLocaleCommand

Retrieve the Locale stored under the specified context attribute key, and establish it on this response.

G

get(Object) - Method in class org.apache.commons.chain.web.jakarta.internal.CookieMap

Returns the cookie to which the specified cookie-name is mapped, or null if this cookie-map contains no mapping for the cookie-name.

getApplicationScope() - Method in class org.apache.commons.chain.web.jakarta.WebContext

Return a mutable Map that maps application scope attribute names to their values.

getCookies() - Method in class org.apache.commons.chain.web.jakarta.WebContext

Return an immutable Map that maps cookie names to the set of cookies specified in the request.

getHeader() - Method in class org.apache.commons.chain.web.jakarta.WebContext

Return an immutable Map that maps header names to the first (or only) header value (as a String).

getHeaderValues() - Method in class org.apache.commons.chain.web.jakarta.WebContext

Return an immutable Map that maps header names to the set of all values specified in the request (as a String array).

getInitParam() - Method in class org.apache.commons.chain.web.jakarta.WebContext

Return an immutable Map that maps context application initialization parameters to their values.

GetLocaleCommand<C> - Class in org.apache.commons.chain.web.jakarta

Base Command implementation for retrieving the requested Locale from our Context, and storing it under the context attribute key returned by the localeKey property.

GetLocaleCommand(Function<C, Locale>) - Constructor for class org.apache.commons.chain.web.jakarta.GetLocaleCommand

Construct a new instance to get the locale from the context.

getLocaleKey() - Method in class org.apache.commons.chain.web.jakarta.GetLocaleCommand

Return the context attribute key under which we will store the request Locale.

getLocaleKey() - Method in class org.apache.commons.chain.web.jakarta.SetLocaleCommand

Return the context attribute key under which we will retrieve the response Locale.

getParam() - Method in class org.apache.commons.chain.web.jakarta.WebContext

Return an immutable Map that maps request parameter names to the first (or only) value (as a String).

getParamValues() - Method in class org.apache.commons.chain.web.jakarta.WebContext

Return an immutable Map that maps request parameter names to the set of all values (as a String array).

getRequestScope() - Method in class org.apache.commons.chain.web.jakarta.WebContext

Return a mutable Map that maps request scope attribute names to their values.

getSessionScope() - Method in class org.apache.commons.chain.web.jakarta.WebContext

Return a mutable Map that maps session scope attribute names to their values.

H

hashCode() - Method in class org.apache.commons.chain.web.jakarta.internal.CookieMap

Returns the hash code value for this cookie-map.

I

init() - Method in class org.apache.commons.chain.web.jakarta.ChainServlet

Create (if necessary) and configure a Catalog from the servlet init parameters that have been specified.

isEmpty() - Method in class org.apache.commons.chain.web.jakarta.internal.CookieMap

Returns true if this cookie-map contains no cookies.

K

keySet() - Method in class org.apache.commons.chain.web.jakarta.internal.CookieMap

Returns a Set view of the cookies contained in this cookie-map.

O

org.apache.commons.chain.web.jakarta - package org.apache.commons.chain.web.jakarta

Basis for specialized Context implementations suitable for use in web applications (JEE9+), and generic Command implementations useful across web application environments.

org.apache.commons.chain.web.jakarta.internal - package org.apache.commons.chain.web.jakarta.internal

Internal basis for specialized Context implementations suitable for use in web applications (JEE9+), and generic Command implementations useful across web application environments.

R

RULE_SET - Static variable in class org.apache.commons.chain.web.jakarta.ChainListener

The name of the context init parameter containing the fully qualified class name of the RuleSet implementation for configuring our ConfigParser.

RULE_SET - Static variable in class org.apache.commons.chain.web.jakarta.ChainServlet

The name of the context init parameter containing the fully qualified class name of the RuleSet implementation for configuring our ConfigParser.

S

service(HttpServletRequest, HttpServletResponse) - Method in class org.apache.commons.chain.web.jakarta.ChainServlet

Does nothing; this servlet's only purpose is to initialize a Chain and store it in the servlet context.

SetLocaleCommand<C> - Class in org.apache.commons.chain.web.jakarta

Base Command implementation for setting the response locale for this response to the Locale stored under the context attribute key returned by the localeKey property.

SetLocaleCommand(BiConsumer<C, Locale>) - Constructor for class org.apache.commons.chain.web.jakarta.SetLocaleCommand

Construct a new instance to set the locale into the context.

setLocaleKey(String) - Method in class org.apache.commons.chain.web.jakarta.GetLocaleCommand

Set the context attribute key under which we will store the request Locale.

setLocaleKey(String) - Method in class org.apache.commons.chain.web.jakarta.SetLocaleCommand

Set the context attribute key under which we will retrieve the response Locale.

size() - Method in class org.apache.commons.chain.web.jakarta.internal.CookieMap

Returns the number of cookies in this cookie-map.

V

values() - Method in class org.apache.commons.chain.web.jakarta.internal.CookieMap

Returns a Collection view of the cookies contained in this cookie-map.

W

WebContext - Class in org.apache.commons.chain.web.jakarta

Extended Context that provides web based applications that use it a "generic" view of HTTP related requests and responses, without tying the application to a particular underlying Java API (such as servlets).

WebContext() - Constructor for class org.apache.commons.chain.web.jakarta.WebContext

The Default-Constructor for this class.

C D E G H I K O R S V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form