A B C D E F G H I J L M O P R S T W X

A

AbstractLogger - Class in org.apache.shale.remoting.logger
Abstract base class for Logger implementations.
AbstractLogger() - Constructor for class org.apache.shale.remoting.logger.AbstractLogger
 
AbstractResourceProcessor - Class in org.apache.shale.remoting.impl
Convenience abstract base class for Processor implementations that serve up static resources.
AbstractResourceProcessor() - Constructor for class org.apache.shale.remoting.impl.AbstractResourceProcessor
 
accept(String) - Method in class org.apache.shale.remoting.impl.FilteringProcessor
Return true if we should accept a request for the specified resource identifier, based upon our configured includes and excludes patterns (if any).
addMapping(Mapping) - Method in class org.apache.shale.remoting.impl.MappingsImpl

Add the specified Mapping to the set of mappings for which remoting services are supplied.

addMapping(Mapping) - Method in interface org.apache.shale.remoting.Mappings
Add the specified Mapping to the set of mappings for which remoting services are supplied.
afterPhase(PhaseEvent) - Method in class org.apache.shale.remoting.faces.RemotingPhaseListener
Perform interception processing activities after the specified phase processing has been performed.

B

BasicResponseWriter - Class in org.apache.shale.remoting.faces
Basic implementation of javax.faces.context.ResponseWriter for use when a content type other than text/html is desired (such as text/xml).
BasicResponseWriter(Writer, String, String) - Constructor for class org.apache.shale.remoting.faces.BasicResponseWriter
Create a new instance configured with the specified properties.
beforePhase(PhaseEvent) - Method in class org.apache.shale.remoting.faces.RemotingPhaseListener
Perform interception processing activities before the specified phase processing has been performed.

C

ChainContext - Class in org.apache.shale.remoting.impl
Implementation of Context suitable for use with commands or chains executed via Shale Remoting.
ChainContext(FacesContext) - Constructor for class org.apache.shale.remoting.impl.ChainContext
Construct a new ChainContext instance wrapping the specified FacesContext instance.
ChainProcessor - Class in org.apache.shale.remoting.impl
Implementation of Processor which maps a resource identifier to the name of a Commons Chain command or chain, in an appropriate catalog.
ChainProcessor() - Constructor for class org.apache.shale.remoting.impl.ChainProcessor
 
CLASS_RESOURCE - Static variable in class org.apache.shale.remoting.Mechanism
Mechanism indicating that the processor should serve a static resource from the classpath of this web application.
CLASS_RESOURCES_EXCLUDES - Static variable in class org.apache.shale.remoting.Constants
Context initialization parameter containing a comma-delimited list of URL matching patterns for resource identifiers that will be explicitly excluded.
CLASS_RESOURCES_EXCLUDES_DEFAULT - Static variable in class org.apache.shale.remoting.Constants
Default value for the CLASS_RESOURCES_EXCLUDES context initialization parameter if no explicit value is specified.
CLASS_RESOURCES_INCLUDES - Static variable in class org.apache.shale.remoting.Constants
Context initialization parameter containing a comma-delimited list of URL matching patterns for resource identifiers that will be explicitly included.
CLASS_RESOURCES_INCLUDES_DEFAULT - Static variable in class org.apache.shale.remoting.Constants
Default value for the CLASS_RESOURCES_INCLUDES context initialization parameter if no explicit value is specified.
CLASS_RESOURCES_PARAM - Static variable in class org.apache.shale.remoting.Constants
Context initialization parameter containing a comma-delimited list of colon-delimited pairs, with each pair representing a URL matching pattern (such as /foo/* or *.foo) and the fully qualified class name of a Processor class to use for handling requests that match the specified pattern.
ClassResourceProcessor - Class in org.apache.shale.remoting.impl
Implementation of Processor which serves resources from the class path of the web application.
ClassResourceProcessor() - Constructor for class org.apache.shale.remoting.impl.ClassResourceProcessor
 
cloneWithWriter(Writer) - Method in class org.apache.shale.remoting.faces.BasicResponseWriter
close() - Method in class org.apache.shale.remoting.faces.BasicResponseWriter
CommonsLogger - Class in org.apache.shale.remoting.logger
Implementation of Logger that interacts with the Apache Jakarta Commons Logging APIs.
CommonsLogger() - Constructor for class org.apache.shale.remoting.logger.CommonsLogger
 
Constants - Class in org.apache.shale.remoting
Manifest constants related to Shale Remoting support.
copyStream(FacesContext, InputStream, OutputStream) - Method in class org.apache.shale.remoting.impl.AbstractResourceProcessor
Copy the contents of the specified input stream to the specified output stream.
createContext(FacesContext, String) - Method in class org.apache.shale.remoting.impl.ChainProcessor
Create and return an appropriate Context instance to be passed to the command or chain that is executed.
createResponseStream(FacesContext, String) - Method in class org.apache.shale.remoting.faces.ResponseFactory
Create a new ResponseStream that writes to the servlet or portlet response stream for the current request.
createResponseWriter(FacesContext, String) - Method in class org.apache.shale.remoting.faces.ResponseFactory
Create a new ResponseWriter that writes to the servlet or portlet response writer for the current request.

D

debug(String, String, Throwable, Object[]) - Method in class org.apache.shale.remoting.logger.CommonsLogger

Log a message at debug severity.

debug(String, String, Throwable, Object[]) - Method in class org.apache.shale.remoting.logger.DefaultLogger

Log a message at debug severity.

debug(String, String, Throwable, Object[]) - Method in class org.apache.shale.remoting.logger.JdkLogger

Log a message at debug severity.

debug(String, String, Throwable, Object[]) - Method in interface org.apache.shale.remoting.logger.Logger
Log a message at debug severity.
DefaultLogger - Class in org.apache.shale.remoting.logger
Default Logger implementation that delegates to Apache Commons Logging (if present), or JDK java.util.Logging (if present), or simply writes to System.out.
DefaultLogger() - Constructor for class org.apache.shale.remoting.logger.DefaultLogger
Construct a new DefaultLogger instance, deciding which Logger implementation, if any, we should delegate to.
DYNAMIC_RESOURCE - Static variable in class org.apache.shale.remoting.Mechanism
Mechanism indicating that the processor should dynamically calculate the content type, and contents, of the response to be created.
DYNAMIC_RESOURCES_EXCLUDES - Static variable in class org.apache.shale.remoting.Constants
Context initialization parameter containing a comma-delimited list of URL matching patterns for resource identifiers that will be explicitly excluded.
DYNAMIC_RESOURCES_EXCLUDES_DEFAULT - Static variable in class org.apache.shale.remoting.Constants
Default value for the DYNAMIC_RESOURCES_EXCLUDES context initialization parameter if no explicit value is specified.
DYNAMIC_RESOURCES_INCLUDES - Static variable in class org.apache.shale.remoting.Constants
Context initialization parameter containing a comma-delimited list of URL matching patterns for resource identifiers that will be explicitly included.
DYNAMIC_RESOURCES_INCLUDES_DEFAULT - Static variable in class org.apache.shale.remoting.Constants
Default value for the DYNAMIC_RESOURCES_INCLUDES context initialization parameter if no explicit value is specified.
DYNAMIC_RESOURCES_PARAM - Static variable in class org.apache.shale.remoting.Constants
Context initialization parameter containing a comma-delimited list of colon-delimited pairs, with each pair representing a URL matching pattern (such as /foo/* or *.foo) and the fully qualified class name of a Processor class to use for handling requests that match the specified pattern.

E

endDocument() - Method in class org.apache.shale.remoting.faces.BasicResponseWriter
endElement(String) - Method in class org.apache.shale.remoting.faces.BasicResponseWriter
equals(Object) - Method in class org.apache.shale.remoting.impl.MappingImpl
Two Mappings are equal if they have the same pattern.
error(String, String, Throwable, Object[]) - Method in class org.apache.shale.remoting.logger.CommonsLogger

Log a message at error severity.

error(String, String, Throwable, Object[]) - Method in class org.apache.shale.remoting.logger.DefaultLogger

Log a message at error severity.

error(String, String, Throwable, Object[]) - Method in class org.apache.shale.remoting.logger.JdkLogger

Log a message at error severity.

error(String, String, Throwable, Object[]) - Method in interface org.apache.shale.remoting.logger.Logger
Log a message at error severity.

F

FACES_SERVLET_NAME_PARAM - Static variable in class org.apache.shale.remoting.Constants
Context initialization parameter defining the name of the Faces Servlet to be used for remoting requests.
FACES_SERVLET_URL_PARAM - Static variable in class org.apache.shale.remoting.Constants
Context initialization parameter defining the zero-relative index of the servlet-mapping, for the specified or default FacesServlet servlet name, to use when generating URLs for resources.
fatal(String, String, Throwable, Object[]) - Method in class org.apache.shale.remoting.logger.CommonsLogger

Log a message at fatal severity.

fatal(String, String, Throwable, Object[]) - Method in class org.apache.shale.remoting.logger.DefaultLogger

Log a message at fatal severity.

fatal(String, String, Throwable, Object[]) - Method in class org.apache.shale.remoting.logger.JdkLogger

Log a message at fatal severity.

fatal(String, String, Throwable, Object[]) - Method in interface org.apache.shale.remoting.logger.Logger
Log a message at fatal severity.
FilteringProcessor - Class in org.apache.shale.remoting.impl
Abstract base class for Processor implementations that filter requests based on matching the resource identifier against a set of includes and excludes regular expressions.
FilteringProcessor() - Constructor for class org.apache.shale.remoting.impl.FilteringProcessor
 
flush() - Method in class org.apache.shale.remoting.faces.BasicResponseWriter

G

getBufferSize() - Method in class org.apache.shale.remoting.impl.AbstractResourceProcessor
Return the buffer size when copying.
getCharacterEncoding() - Method in class org.apache.shale.remoting.faces.BasicResponseWriter
getContentType() - Method in class org.apache.shale.remoting.faces.BasicResponseWriter
getExcludes() - Method in class org.apache.shale.remoting.impl.FilteringProcessor
Return the comma-delimited regular expresson patterns to exclude remote host names that match, if any; otherwise, return null.
getExtension() - Method in class org.apache.shale.remoting.impl.MappingsImpl

Return the extension that will replace the FacesServlet extension pattern, if FacesServlet is extension mapped.

getExtension() - Method in interface org.apache.shale.remoting.Mappings
Return the extension that will replace the FacesServlet extension pattern, if FacesServlet is extension mapped.
getFacesContext() - Method in class org.apache.shale.remoting.impl.ChainContext
Return the FacesContext instance that is wrapped by this Context instance.
getIncludes() - Method in class org.apache.shale.remoting.impl.FilteringProcessor
Return the comma-delimited regular expresson patterns to include remote host names that match, if any; otherwise, return null.
getLastModified() - Method in class org.apache.shale.remoting.impl.AbstractResourceProcessor
Return the date/time (expressed as the number of milliseconds since the epoch) that will be generated on the Last-Modified header of all resources served by this processor.
getLastModifiedString() - Method in class org.apache.shale.remoting.impl.AbstractResourceProcessor
Return a String version of the last modified date/time, formatted as required by Section 3.3.1 of the HTTP/1.1 Specification.
getMapping(String) - Method in class org.apache.shale.remoting.impl.MappingsImpl

Return the Mapping, if any, for the specified matching pattern.

getMapping(String) - Method in interface org.apache.shale.remoting.Mappings
Return the Mapping, if any, for the specified matching pattern.
getMappings(FacesContext) - Method in class org.apache.shale.remoting.faces.MappingsHelper
Return the Mappings instance for this web application, creating it if necessary.
getMappings() - Method in class org.apache.shale.remoting.impl.MappingImpl

Return the Mappings instance this Mapping instance is associated with.

getMappings() - Method in class org.apache.shale.remoting.impl.MappingsImpl

Return a List of all the currently defined Mappings for this application.

getMappings() - Method in interface org.apache.shale.remoting.Mapping
Return the Mappings instance this Mapping instance is associated with.
getMappings() - Method in interface org.apache.shale.remoting.Mappings
Return a List of all the currently defined Mappings for this application.
getMechanism() - Method in class org.apache.shale.remoting.impl.MappingImpl

Return a description of the mechanism used to return the response from this processor.

getMechanism() - Method in interface org.apache.shale.remoting.Mapping
Return a description of the mechanism used to return the response from this processor.
getPattern() - Method in class org.apache.shale.remoting.impl.MappingImpl

Return the matching pattern for the view identifier for this request, used to determine if this is the appropriate Mapping for processing the current request or not.

getPattern() - Method in interface org.apache.shale.remoting.Mapping
Return the matching pattern for the view identifier for this request, used to determine if this is the appropriate Mapping for processing the current request or not.
getPatternIndex() - Method in class org.apache.shale.remoting.impl.MappingsImpl

Return the zero-relative index, into the array returned by getPatterns(), of the URL pattern to be used by default when creating URLs for resources.

getPatternIndex() - Method in interface org.apache.shale.remoting.Mappings
Return the zero-relative index, into the array returned by getPatterns(), of the URL pattern to be used by default when creating URLs for resources.
getPatterns() - Method in class org.apache.shale.remoting.impl.MappingsImpl

Return a list of URL patterns that this application has mapped to FacesServlet.

getPatterns() - Method in interface org.apache.shale.remoting.Mappings
Return a list of URL patterns that this application has mapped to FacesServlet.
getPhaseId() - Method in class org.apache.shale.remoting.faces.RemotingPhaseListener
Return the identifier of the JavaServer Faces request processing lifecycle phase(s) that we are interested in.
getProcessor() - Method in class org.apache.shale.remoting.impl.MappingImpl

Return the Processor instance to be used to process requests where the view identifier matches our pattern.

getProcessor() - Method in interface org.apache.shale.remoting.Mapping
Return the Processor instance to be used to process requests where the view identifier matches our pattern.
getResourceURL(FacesContext, String) - Method in class org.apache.shale.remoting.impl.AbstractResourceProcessor
Convert the specified resource identifier into a URL, if the resource actually exists.
getResourceURL(FacesContext, String) - Method in class org.apache.shale.remoting.impl.ClassResourceProcessor

Convert the specified resource identifier into a URL, if the resource actually exists.

getResourceURL(FacesContext, String) - Method in class org.apache.shale.remoting.impl.WebResourceProcessor

Convert the specified resource identifier into a URL, if the resource actually exists.

getResponseStream(FacesContext, String) - Method in class org.apache.shale.remoting.faces.ResponseFactory
Return the configured ResponseStream for the current request, creating and installing a new one if necessary.
getResponseWriter(FacesContext, String) - Method in class org.apache.shale.remoting.faces.ResponseFactory
Return the configured ResponseWriter for the current request, creating and installing a new one if necessary.

H

hashCode() - Method in class org.apache.shale.remoting.impl.MappingImpl
Return the hash code for this object.
httpTimestamp(Date) - Method in class org.apache.shale.remoting.impl.AbstractResourceProcessor
Return a textual representation of the specified date/time stamp (expressed as a java.util.Date object) in the format required by the HTTP/1.1 Specification (RFC 2616), Section 3.3.1.
httpTimestamp(long) - Method in class org.apache.shale.remoting.impl.AbstractResourceProcessor
Return a textual representation of the specified date/time stamp (expressed in milliseconds since the epoch, and assumed to be GMT) in the format required by the HTTP/1.1 Specification (RFC 2616), Section 3.3.1.

I

ifModifiedSince(FacesContext) - Method in class org.apache.shale.remoting.impl.AbstractResourceProcessor
Return the value of the If-Modified-Since header included on this request, as a number of milliseconds since the epoch.
info(String, String, Throwable, Object[]) - Method in class org.apache.shale.remoting.logger.CommonsLogger

Log a message at info severity.

info(String, String, Throwable, Object[]) - Method in class org.apache.shale.remoting.logger.DefaultLogger

Log a message at info severity.

info(String, String, Throwable, Object[]) - Method in class org.apache.shale.remoting.logger.JdkLogger

Log a message at info severity.

info(String, String, Throwable, Object[]) - Method in interface org.apache.shale.remoting.logger.Logger
Log a message at info severity.
inputStream(FacesContext, URL) - Method in class org.apache.shale.remoting.impl.AbstractResourceProcessor
Return an InputStream derived from the specified URL, which will point to the static resource to be served.
isDebugEnabled(String) - Method in class org.apache.shale.remoting.logger.CommonsLogger

Is debug level debugging enabled on the specified logger?

isDebugEnabled(String) - Method in class org.apache.shale.remoting.logger.DefaultLogger

Is debug level debugging enabled on the specified logger?

isDebugEnabled(String) - Method in class org.apache.shale.remoting.logger.JdkLogger

Is debug level debugging enabled on the specified logger?

isDebugEnabled(String) - Method in interface org.apache.shale.remoting.logger.Logger
Is debug level debugging enabled on the specified logger?
isErrorEnabled(String) - Method in class org.apache.shale.remoting.logger.CommonsLogger

Is error level debugging enabled on the specified logger?

isErrorEnabled(String) - Method in class org.apache.shale.remoting.logger.DefaultLogger

Is error level debugging enabled on the specified logger?

isErrorEnabled(String) - Method in class org.apache.shale.remoting.logger.JdkLogger

Is error level debugging enabled on the specified logger?

isErrorEnabled(String) - Method in interface org.apache.shale.remoting.logger.Logger
Is error level debugging enabled on the specified logger?
isFatalEnabled(String) - Method in class org.apache.shale.remoting.logger.CommonsLogger

Is fatal level debugging enabled on the specified logger?

isFatalEnabled(String) - Method in class org.apache.shale.remoting.logger.DefaultLogger

Is fatal level debugging enabled on the specified logger?

isFatalEnabled(String) - Method in class org.apache.shale.remoting.logger.JdkLogger

Is fatal level debugging enabled on the specified logger?

isFatalEnabled(String) - Method in interface org.apache.shale.remoting.logger.Logger
Is fatal level debugging enabled on the specified logger?
isInfoEnabled(String) - Method in class org.apache.shale.remoting.logger.CommonsLogger

Is info level debugging enabled on the specified logger?

isInfoEnabled(String) - Method in class org.apache.shale.remoting.logger.DefaultLogger

Is info level debugging enabled on the specified logger?

isInfoEnabled(String) - Method in class org.apache.shale.remoting.logger.JdkLogger

Is info level debugging enabled on the specified logger?

isInfoEnabled(String) - Method in interface org.apache.shale.remoting.logger.Logger
Is info level debugging enabled on the specified logger?
isTraceEnabled(String) - Method in class org.apache.shale.remoting.logger.CommonsLogger

Is trace level debugging enabled on the specified logger?

isTraceEnabled(String) - Method in class org.apache.shale.remoting.logger.DefaultLogger

Is trace level debugging enabled on the specified logger?

isTraceEnabled(String) - Method in class org.apache.shale.remoting.logger.JdkLogger

Is trace level debugging enabled on the specified logger?

isTraceEnabled(String) - Method in interface org.apache.shale.remoting.logger.Logger
Is trace level debugging enabled on the specified logger?
isWarnEnabled(String) - Method in class org.apache.shale.remoting.logger.CommonsLogger

Is warning level debugging enabled on the specified logger?

isWarnEnabled(String) - Method in class org.apache.shale.remoting.logger.DefaultLogger

Is warning level debugging enabled on the specified logger?

isWarnEnabled(String) - Method in class org.apache.shale.remoting.logger.JdkLogger

Is warning level debugging enabled on the specified logger?

isWarnEnabled(String) - Method in interface org.apache.shale.remoting.logger.Logger
Is warning level debugging enabled on the specified logger?

J

JdkLogger - Class in org.apache.shale.remoting.logger
Implementation of Logger that interacts with the standard java.util.logging APIs.
JdkLogger() - Constructor for class org.apache.shale.remoting.logger.JdkLogger
 

L

link(FacesContext, String) - Method in class org.apache.shale.remoting.XhtmlHelper
Mark the specified resource identifier as having already been linked in the current request.
linked(FacesContext, String) - Method in class org.apache.shale.remoting.XhtmlHelper
Return true if the specified resource identifier has already been linked in the current request, and should therefore not be linked again.
linkJavascript(FacesContext, UIComponent, ResponseWriter, Mechanism, String) - Method in class org.apache.shale.remoting.XhtmlHelper
Render a link to a JavaScript resource at the specified resource identifier.
linkJavascript(FacesContext, UIComponent, ResponseWriter, Mechanism, String, String) - Method in class org.apache.shale.remoting.XhtmlHelper
Render a link to a JavaScript resource at the specified resource identifier.
linkStylesheet(FacesContext, UIComponent, ResponseWriter, Mechanism, String) - Method in class org.apache.shale.remoting.XhtmlHelper
Render a link to a CSS stylesheet at the specified resource identifier.
logger - Variable in class org.apache.shale.remoting.logger.DefaultLogger
The Logger instance we should delegate to (if any).
Logger - Interface in org.apache.shale.remoting.logger
Adapter to logging systems that intends to make Commons Logging optional on deployments running on JDK 1.4 or later.

M

mapCatalog(FacesContext, String) - Method in class org.apache.shale.remoting.impl.ChainProcessor
Map the specified resource identifier to the name of a Commons Chain Catalog from which the command or chain instance will be acquired.
mapCommand(FacesContext, String) - Method in class org.apache.shale.remoting.impl.ChainProcessor
Map the specified resource identifier to the name of a Commons Chain Command or Chain, which will be acquired from a mapped Catalog.
Mapping - Interface in org.apache.shale.remoting
Configuration element describing the mapping between a view identifier URL pattern to a corresponding processor class.
MAPPING_CLASS - Static variable in class org.apache.shale.remoting.Constants
Context initialization parameter containing the fully qualified class name of the Mapping implementation class to use.
MappingImpl - Class in org.apache.shale.remoting.impl
Default implementation of Mapping.
MappingImpl() - Constructor for class org.apache.shale.remoting.impl.MappingImpl
Construct an unconfigured instance.
MappingImpl(Mechanism, String, Processor) - Constructor for class org.apache.shale.remoting.impl.MappingImpl
Construct a fully configured instance.
Mappings - Interface in org.apache.shale.remoting
Configuration object used to manage the Mapping instances for a particular web application.
MAPPINGS_ATTR - Static variable in class org.apache.shale.remoting.Constants
Servlet context attribute under which the Mappings instance for this web application will be stored.
MAPPINGS_CLASS - Static variable in class org.apache.shale.remoting.Constants
Context initialization parameter containing the fully qualified class name of the Mappings implementation class to use.
MappingsHelper - Class in org.apache.shale.remoting.faces
Helper bean for accessing the Mappings instance for this application, creating it the first time if necessary.
MappingsHelper() - Constructor for class org.apache.shale.remoting.faces.MappingsHelper
 
MappingsImpl - Class in org.apache.shale.remoting.impl
Default implementation of Mappings.
MappingsImpl() - Constructor for class org.apache.shale.remoting.impl.MappingsImpl
 
mapResourceId(FacesContext, String) - Method in class org.apache.shale.remoting.impl.MappingImpl

Map the specified resource identifier to a complete URL that may be used to request this resource from the server.

mapResourceId(FacesContext, String) - Method in class org.apache.shale.remoting.impl.MethodBindingProcessor
Map the specified resource identifier into a corresponding MethodBinding which identifies the method which will be called to produce this response.
mapResourceId(FacesContext, String) - Method in interface org.apache.shale.remoting.Mapping
Map the specified resource identifier to a complete URL that may be used to request this resource from the server.
mapResourceId(FacesContext, Mechanism, String) - Method in class org.apache.shale.remoting.XhtmlHelper
Map the specified resource identifier to a request URL, taking into account the mappings for the specified mechanism and the servlet mapping for the JavaServer Faces controller servlet.
mapViewId(FacesContext) - Method in class org.apache.shale.remoting.impl.MappingImpl

If the specified view identifier matches the pattern specified by this Mapping, return the corresponding resource identifier that should be passed on to our Processor.

mapViewId(FacesContext) - Method in interface org.apache.shale.remoting.Mapping
If the specified view identifier matches the pattern specified by this Mapping, return the corresponding resource identifier that should be passed on to our Processor.
Mechanism - Class in org.apache.shale.remoting
Typesafe enumeration of the legal values that may be specified for the mechanism property of a Mapping.
message(String, Object[]) - Method in class org.apache.shale.remoting.logger.AbstractLogger
Return a formatted message based on the specified parameters.
MethodBindingProcessor - Class in org.apache.shale.remoting.impl
Implementation of Processor which maps a resource identifier to a method binding expression, then delegates the creation of the current response to the execution of that method.
MethodBindingProcessor() - Constructor for class org.apache.shale.remoting.impl.MethodBindingProcessor
 
mimeType(FacesContext, String) - Method in class org.apache.shale.remoting.impl.AbstractResourceProcessor
Return the appropriate MIME type (if known) for the specified resource path.
mimeTypes - Variable in class org.apache.shale.remoting.impl.AbstractResourceProcessor
Map of MIME types, keyed by file extension.

O

org.apache.shale.remoting - package org.apache.shale.remoting
This package contains interfaces and APIs to support access for remoting (client side components that need to perform server side activities and/or retrieve information on a background thread).
org.apache.shale.remoting.faces - package org.apache.shale.remoting.faces
This package contains integration for the Shale remoting facilities with standard JavaServer Faces extension points.
org.apache.shale.remoting.impl - package org.apache.shale.remoting.impl
This package contains default implementations for the APIs specified by Shale remoting support.
org.apache.shale.remoting.logger - package org.apache.shale.remoting.logger
 
OTHER_RESOURCE - Static variable in class org.apache.shale.remoting.Mechanism
Mechanism indicating that an unspecified mechanism will be used to provide the content for the response.
OTHER_RESOURCES_EXCLUDES - Static variable in class org.apache.shale.remoting.Constants
Context initialization parameter containing a comma-delimited list of URL matching patterns for resource identifiers that will be explicitly excluded.
OTHER_RESOURCES_EXCLUDES_DEFAULT - Static variable in class org.apache.shale.remoting.Constants
Default value for the OTHER_RESOURCES_EXCLUDES context initialization parameter if no explicit value is specified.
OTHER_RESOURCES_INCLUDES - Static variable in class org.apache.shale.remoting.Constants
Context initialization parameter containing a comma-delimited list of URL matching patterns for resource identifiers that will be explicitly included.
OTHER_RESOURCES_INCLUDES_DEFAULT - Static variable in class org.apache.shale.remoting.Constants
Default value for the OTHER_RESOURCES_INCLUDES context initialization parameter if no explicit value is specified.
OTHER_RESOURCES_PARAM - Static variable in class org.apache.shale.remoting.Constants
Context initialization parameter containing a comma-delimited list of colon-delimited pairs, with each pair representing a URL matching pattern (such as /foo/* or *.foo) and the fully qualified class name of a Processor class to use for handling requests that match the specified pattern.
outputStream(FacesContext, String) - Method in class org.apache.shale.remoting.impl.AbstractResourceProcessor
Return an OutputStream to which our static resource is to be served.

P

PREFIX - Static variable in class org.apache.shale.remoting.XhtmlHelper
The prefix to the request attributes that we will use to keep track of whether a particular resource has been linked already.
process(FacesContext, String) - Method in class org.apache.shale.remoting.impl.AbstractResourceProcessor
Check if the specified resource actually exists.
process(FacesContext, String) - Method in class org.apache.shale.remoting.impl.ChainProcessor
Map the specified resource identifier to an appropriate Commons Chain command or chain, in an appropriate catalog.
process(FacesContext, String) - Method in class org.apache.shale.remoting.impl.MethodBindingProcessor
Convert the specified resource identifier into a method binding expression, and delegate creation of the response to a call to the identified method.
process(FacesContext, String) - Method in interface org.apache.shale.remoting.Processor
Process the current request, producing the corresponding response by whatever means is appropriate.
Processor - Interface in org.apache.shale.remoting
Interface describing business logic responsible for processing an incoming remoting request, and creating the corresponding response.

R

RemotingPhaseListener - Class in org.apache.shale.remoting.faces
A JavaServer Faces PhaseListener that provides support for intercepting some incoming requests, and processing them separately from the standard Request Processing Lifecycle, without requiring explicit configuration (for example, of a Servlet or a Filter).
RemotingPhaseListener() - Constructor for class org.apache.shale.remoting.faces.RemotingPhaseListener
Creates a new instance of RemotingPhaseListener.
removeMapping(Mapping) - Method in class org.apache.shale.remoting.impl.MappingsImpl

Remove the specified Mapping from the set of mappings for which remoting services are supplied, if it is currently included.

removeMapping(Mapping) - Method in interface org.apache.shale.remoting.Mappings
Remove the specified Mapping from the set of mappings for which remoting services are supplied, if it is currently included.
renderKit(FacesContext) - Method in class org.apache.shale.remoting.faces.ResponseFactory
Return the relevant RenderKit to construct response stream or writer instances for this request.
resourceBundle(FacesContext) - Method in class org.apache.shale.remoting.XhtmlHelper
Return the localized resource bundle we should use to generate exception or log messages for this request.
ResponseFactory - Class in org.apache.shale.remoting.faces
Factory class for returning ResponseStream or ResponseWriter instances that may be used to produce output response content that is independent of whether we are running in a servlet or portlet environment.
ResponseFactory() - Constructor for class org.apache.shale.remoting.faces.ResponseFactory
 

S

sendContentType(FacesContext, String) - Method in class org.apache.shale.remoting.impl.AbstractResourceProcessor
Set the content type on the servlet or portlet response object.
sendLastModified(FacesContext, String) - Method in class org.apache.shale.remoting.impl.AbstractResourceProcessor
Set the Last-Modified header to the specified timestamp.
sendNotFound(FacesContext, String) - Method in class org.apache.shale.remoting.impl.AbstractResourceProcessor
Send a "not found" HTTP response, if possible.
sendNotFound(FacesContext, String) - Method in class org.apache.shale.remoting.impl.ChainProcessor
Send a "not found" HTTP response, if possible.
sendNotModified(FacesContext, String) - Method in class org.apache.shale.remoting.impl.AbstractResourceProcessor
Send a "not modified" HTTP response, if possible.
sendServerError(FacesContext, String, Exception) - Method in class org.apache.shale.remoting.impl.ChainProcessor
Send a "server error" HTTP response, if possible.
servletRequest(FacesContext) - Method in class org.apache.shale.remoting.impl.AbstractResourceProcessor
Return true if we are processing a servlet request (as opposed to a portlet request).
servletRequest(FacesContext) - Method in class org.apache.shale.remoting.impl.ChainProcessor
Return true if we are processing a servlet request (as opposed to a portlet request).
setBufferSize(int) - Method in class org.apache.shale.remoting.impl.AbstractResourceProcessor
Set the buffer size when copying.
setExcludes(String) - Method in class org.apache.shale.remoting.impl.ClassResourceProcessor
Force our default excludes list to be included.
setExcludes(String) - Method in class org.apache.shale.remoting.impl.FilteringProcessor
Set the comma-delimited regular expression patterns to exclude remote host names that match, if any; or null for no restrictions.
setExcludes(String) - Method in class org.apache.shale.remoting.impl.MethodBindingProcessor
Force our default excludes list to be included.
setExcludes(String) - Method in class org.apache.shale.remoting.impl.WebResourceProcessor
Force our default excludes list to be included.
setExtension(String) - Method in class org.apache.shale.remoting.impl.MappingsImpl

Set the extension that will replace the FacesServlet extension pattern, if FacesServlet is extension mapped.

setExtension(String) - Method in interface org.apache.shale.remoting.Mappings
Set the extension that will replace the FacesServlet extension pattern, if FacesServlet is extension mapped.
setIncludes(String) - Method in class org.apache.shale.remoting.impl.FilteringProcessor
Set the comma-delimited regular expression patterns to include remote host names that match, if any; or null for no restrictions.
setLastModified(long) - Method in class org.apache.shale.remoting.impl.AbstractResourceProcessor
Set the date/time (expressed as the number of milliseconds since the epoch) that wll be generated on the Last-Modified header of all resources served by this processor.
setMappings(Mappings) - Method in class org.apache.shale.remoting.impl.MappingImpl

Set the Mappings instance this Mapping instance is associated with.

setMappings(Mappings) - Method in interface org.apache.shale.remoting.Mapping
Set the Mappings instance this Mapping instance is associated with.
setMechanism(Mechanism) - Method in class org.apache.shale.remoting.impl.MappingImpl

Set the mechanism used by this mapping.

setMechanism(Mechanism) - Method in interface org.apache.shale.remoting.Mapping
Set the mechanism used by this mapping.
setPattern(String) - Method in class org.apache.shale.remoting.impl.MappingImpl

Set the matching pattern used by this mapping.

setPattern(String) - Method in interface org.apache.shale.remoting.Mapping
Set the matching pattern used by this mapping.
setPatternIndex(int) - Method in class org.apache.shale.remoting.impl.MappingsImpl

Set the zero-relative index, into the array returned by getPatterns(), of the URL pattern to be used by default when creating URLs for resources.

setPatternIndex(int) - Method in interface org.apache.shale.remoting.Mappings
Set the zero-relative index, into the array returned by getPatterns(), of the URL pattern to be used by default when creating URLs for resources.
setPatterns(String[]) - Method in class org.apache.shale.remoting.impl.MappingsImpl

Set a list of URL patterns that this application has mapped to FacesServlet.

setPatterns(String[]) - Method in interface org.apache.shale.remoting.Mappings
Set a list of URL patterns that this application has mapped to FacesServlet.
setProcessor(Processor) - Method in class org.apache.shale.remoting.impl.MappingImpl

Set the Processor instance used by this mapping.

setProcessor(Processor) - Method in interface org.apache.shale.remoting.Mapping
Set the Processor instance used by this mapping.
startDocument() - Method in class org.apache.shale.remoting.faces.BasicResponseWriter
startElement(String, UIComponent) - Method in class org.apache.shale.remoting.faces.BasicResponseWriter

T

toString() - Method in class org.apache.shale.remoting.Mechanism
Return a string representation of this mechansim.
trace(String, String, Throwable, Object[]) - Method in class org.apache.shale.remoting.logger.CommonsLogger

Log a message at trace severity.

trace(String, String, Throwable, Object[]) - Method in class org.apache.shale.remoting.logger.DefaultLogger

Log a message at trace severity.

trace(String, String, Throwable, Object[]) - Method in class org.apache.shale.remoting.logger.JdkLogger

Log a message at trace severity.

trace(String, String, Throwable, Object[]) - Method in interface org.apache.shale.remoting.logger.Logger
Log a message at trace severity.

W

warn(String, String, Throwable, Object[]) - Method in class org.apache.shale.remoting.logger.CommonsLogger

Log a message at warning severity.

warn(String, String, Throwable, Object[]) - Method in class org.apache.shale.remoting.logger.DefaultLogger

Log a message at warning severity.

warn(String, String, Throwable, Object[]) - Method in class org.apache.shale.remoting.logger.JdkLogger

Log a message at warning severity.

warn(String, String, Throwable, Object[]) - Method in interface org.apache.shale.remoting.logger.Logger
Log a message at warning severity.
WEBAPP_RESOURCE - Static variable in class org.apache.shale.remoting.Mechanism
Mechanism indicating that the processor should serve a static resource from the web application archive of this web application.
WEBAPP_RESOURCES_EXCLUDES - Static variable in class org.apache.shale.remoting.Constants
Context initialization parameter containing a comma-delimited list of URL matching patterns for resource identifiers that will be explicitly excluded.
WEBAPP_RESOURCES_EXCLUDES_DEFAULT - Static variable in class org.apache.shale.remoting.Constants
Default value for the WEB_RESOURCES_EXCLUDES context initialization parameter if no explicit value is specified.
WEBAPP_RESOURCES_INCLUDES - Static variable in class org.apache.shale.remoting.Constants
Context initialization parameter containing a comma-delimited list of URL matching patterns for resource identifiers that will be explicitly included.
WEBAPP_RESOURCES_INCLUDES_DEFAULT - Static variable in class org.apache.shale.remoting.Constants
Default value for the WEB_RESOURCES_INCLUDES context initialization parameter if no explicit value is specified.
WEBAPP_RESOURCES_PARAM - Static variable in class org.apache.shale.remoting.Constants
Context initialization parameter containing a comma-delimited list of colon-delimited pairs, with each pair representing a URL matching pattern (such as /foo/* or *.foo) and the fully qualified class name of a Processor class to use for handling requests that match the specified pattern.
WebResourceProcessor - Class in org.apache.shale.remoting.impl
Implementation of Processor which serves resources from the web application's static resources.
WebResourceProcessor() - Constructor for class org.apache.shale.remoting.impl.WebResourceProcessor
 
write(char[], int, int) - Method in class org.apache.shale.remoting.faces.BasicResponseWriter
writeAttribute(String, Object, String) - Method in class org.apache.shale.remoting.faces.BasicResponseWriter
writeComment(Object) - Method in class org.apache.shale.remoting.faces.BasicResponseWriter
writeText(Object, String) - Method in class org.apache.shale.remoting.faces.BasicResponseWriter
writeText(char[], int, int) - Method in class org.apache.shale.remoting.faces.BasicResponseWriter
writeURIAttribute(String, Object, String) - Method in class org.apache.shale.remoting.faces.BasicResponseWriter

X

XhtmlHelper - Class in org.apache.shale.remoting
Helper bean for rendering links to download resources commonly used in HTML and XHTML pages.
XhtmlHelper() - Constructor for class org.apache.shale.remoting.XhtmlHelper
 

A B C D E F G H I J L M O P R S T W X

Copyright © 2004-2007 Apache Software Foundation. All Rights Reserved.