A B C D E F G H I L M N O P Q R S T U V W X Y

A

ACTION_PARAM - Static variable in class org.apache.cocoon.Constants
The request parameter name to trigger a specific action.
ACTION_PARAM_PREFIX - Static variable in class org.apache.cocoon.Constants
The request parameter prefix to trigger a specific action.
AttributeTypes - interface org.apache.cocoon.xml.AttributeTypes.
Insert the type's description here.
addCauseLocations(MultiLocatable, Throwable) - Static method in class org.apache.cocoon.util.location.LocatedException
Add to the location stack all locations of an exception chain.
addCookie(Cookie) - Method in interface org.apache.cocoon.environment.Response
Adds the specified cookie to the response.
addCookie(Cookie) - Method in interface org.apache.cocoon.environment.Response
Deprecated. use Response.addCookie(javax.servlet.http.Cookie) instead.
addDateHeader(String, long) - Method in interface org.apache.cocoon.environment.Response
Adds a response header with the given name and date-value.
addFinder(LocationUtils.LocationFinder) - Static method in class org.apache.cocoon.util.location.LocationUtils
Add a LocationUtils.LocationFinder to the list of finders that will be queried for an object's location by LocationUtils.getLocation(Object, String).
addHeader(String, String) - Method in interface org.apache.cocoon.environment.Response
Adds a response header with the given name and value.
addIntHeader(String, int) - Method in interface org.apache.cocoon.environment.Response
Adds a response header with the given name and int value.
addLocation(Location) - Method in class org.apache.cocoon.util.location.LocatedException
 
addLocation(Location) - Method in class org.apache.cocoon.util.location.LocatedRuntimeException
 
addLocation(Location) - Method in interface org.apache.cocoon.util.location.MultiLocatable
Add a location to the current list of locations.
addLocationAttributes(Locator, Attributes) - Static method in class org.apache.cocoon.util.location.LocationAttributes
Add location attributes to a set of SAX attributes.
addTransformer(String, String, Parameters, Parameters) - Method in interface org.apache.cocoon.components.pipeline.ProcessingPipeline
Add a transformer at the end of the pipeline.

B

BLOCK_META_DIR - Static variable in class org.apache.cocoon.Constants
 

C

CDATA - Static variable in interface org.apache.cocoon.xml.AttributeTypes
 
COL_ATTR - Static variable in class org.apache.cocoon.util.location.LocationAttributes
Attribute name for the column number
COMPLETE_NAME - Static variable in class org.apache.cocoon.Constants
Deprecated. This will be removed soon.
CONF_VERSION - Static variable in class org.apache.cocoon.Constants
The version of the configuration schema
CONTEXT_CACHE_DIR - Static variable in class org.apache.cocoon.Constants
Deprecated. Use org.apache.cocoon.configuration.Settings#getCacheDirectory() instead.
CONTEXT_DEFAULT_ENCODING - Static variable in class org.apache.cocoon.Constants
Deprecated. Use org.apache.cocoon.configuration.Settings#getFormEncoding().
CONTEXT_ENVIRONMENT_CONTEXT - Static variable in class org.apache.cocoon.Constants
Application Context Key for the environmental Context (= ServletContext)
CONTEXT_ENV_PREFIX - Static variable in class org.apache.cocoon.Constants
Application Context key for the current environment prefix
CONTEXT_OBJECT - Static variable in class org.apache.cocoon.environment.ObjectModelHelper
Key for the environment Context in the object model.
CONTEXT_VPC_PREFIX - Static variable in class org.apache.cocoon.Constants
Application Context key prefix for the current sitemap virtual components
CONTEXT_WORK_DIR - Static variable in class org.apache.cocoon.Constants
Deprecated. Use org.apache.cocoon.configuration.Settings#getWorkDirectory() instead.
Cache - interface org.apache.cocoon.caching.Cache.
This is the Cocoon cache.
CacheableProcessingComponent - interface org.apache.cocoon.caching.CacheableProcessingComponent.
This interface declares a (sitemap) component as cacheable.
CachedResponse - class org.apache.cocoon.caching.CachedResponse.
This is a cached response.
CachedResponse(SourceValidity[], byte[]) - Constructor for class org.apache.cocoon.caching.CachedResponse
Create a new entry for the cache.
CachedResponse(SourceValidity, byte[]) - Constructor for class org.apache.cocoon.caching.CachedResponse
Create a new entry for the cache.
CachedResponse(SourceValidity[], byte[], Long) - Constructor for class org.apache.cocoon.caching.CachedResponse
Create a new entry for the cache.
CascadingIOException - exception org.apache.cocoon.CascadingIOException.
This is a wrapping IOException.
CascadingIOException(String) - Constructor for class org.apache.cocoon.CascadingIOException
Construct a new ProcessingException instance.
CascadingIOException(Exception) - Constructor for class org.apache.cocoon.CascadingIOException
Creates a new ProcessingException instance.
CascadingIOException(String, Throwable) - Constructor for class org.apache.cocoon.CascadingIOException
Construct a new ProcessingException that references a parent Exception.
ConnectionResetException - exception org.apache.cocoon.ConnectionResetException.
This Exception is thrown every time a component detects an exception due to a connection reset by peer.
ConnectionResetException(String) - Constructor for class org.apache.cocoon.ConnectionResetException
Construct a new ConnectionResetException instance.
ConnectionResetException(String, Throwable) - Constructor for class org.apache.cocoon.ConnectionResetException
Construct a new ConnectionResetException that references a parent Exception.
Constants - class org.apache.cocoon.Constants.
The Constants used throughout the core of the Cocoon engine.
Constants() - Constructor for class org.apache.cocoon.Constants
 
ConstantsInitializationException - exception org.apache.cocoon.ConstantsInitializationException.
 
ConstantsInitializationException(String) - Constructor for class org.apache.cocoon.ConstantsInitializationException
 
ConstantsInitializationException(String, Throwable) - Constructor for class org.apache.cocoon.ConstantsInitializationException
 
Context - interface org.apache.cocoon.environment.Context.
Defines an interface to provide context information.
Cookie - interface org.apache.cocoon.environment.Cookie.
Deprecated. Use Cookie instead.
characters(char[], int, int) - Method in class org.apache.cocoon.util.location.LocationAttributes.Pipe
 
clear() - Method in interface org.apache.cocoon.caching.Cache
clear cache of all cached responses
commitResponse() - Method in interface org.apache.cocoon.environment.Environment
Commit the response
containsHeader(String) - Method in interface org.apache.cocoon.environment.Response
Returns a boolean indicating whether the named response header has already been set.
containsKey(Serializable) - Method in interface org.apache.cocoon.caching.Cache
See if a response is cached under this key.
contentType - Variable in class org.apache.cocoon.caching.CachedResponse
 
createCocoonCookie(String, String) - Method in interface org.apache.cocoon.environment.Response
Deprecated. use Response.createCookie(String, String) instead.
createCookie(String, String) - Method in interface org.apache.cocoon.environment.Response
Constructs a cookie with a specified name and value.

D

DEFAULT_CONF_FILE - Static variable in class org.apache.cocoon.Constants
Deprecated. This will be removed soon.
DEFAULT_CONTEXT_DIR - Static variable in class org.apache.cocoon.Constants
The directory to use as context root.
DEFAULT_DEST_DIR - Static variable in class org.apache.cocoon.Constants
The diretory to use to use for the generated output.
DEFAULT_WORK_DIR - Static variable in class org.apache.cocoon.Constants
Deprecated. This will be removed soon.
DisposableSitemapComponent - interface org.apache.cocoon.sitemap.DisposableSitemapComponent.
If a sitemap component needs to be cleaned up after it is used, it should implement this additional interface.
dispose() - Method in interface org.apache.cocoon.sitemap.DisposableSitemapComponent
Clean up the component.

E

ENTITIES - Static variable in interface org.apache.cocoon.xml.AttributeTypes
 
ENTITY - Static variable in interface org.apache.cocoon.xml.AttributeTypes
 
ERROR_NAMESPACE_PREFIX - Static variable in class org.apache.cocoon.Constants
The namespace prefix for the Error/Exception XML
ERROR_NAMESPACE_URI - Static variable in class org.apache.cocoon.Constants
The namespace URI for the Error/Exception XML
EXPIRES_OBJECT - Static variable in class org.apache.cocoon.environment.ObjectModelHelper
Key for the expiration value (Long) in the object model.
Environment - interface org.apache.cocoon.environment.Environment.
Base interface for an environment abstraction
encodeURL(String) - Method in interface org.apache.cocoon.environment.Response
Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged.
endArc(String, String, String) - Method in interface org.apache.cocoon.xml.xlink.XLinkHandler
 
endDocument() - Method in class org.apache.cocoon.util.location.LocationAttributes.Pipe
 
endElement(String, String, String) - Method in class org.apache.cocoon.util.location.LocationAttributes.Pipe
 
endExtendedLink(String, String, String) - Method in interface org.apache.cocoon.xml.xlink.XLinkHandler
 
endLocator(String, String, String) - Method in interface org.apache.cocoon.xml.xlink.XLinkHandler
 
endPrefixMapping(String) - Method in class org.apache.cocoon.util.location.LocationAttributes.Pipe
 
ensureCauseChainIsSet(Throwable) - Static method in class org.apache.cocoon.util.location.LocatedException
Crawl the cause chain and ensure causes are properly set using Throwable.initCause(java.lang.Throwable).
equals(Object) - Method in class org.apache.cocoon.util.location.LocationImpl
 
expires - Variable in class org.apache.cocoon.caching.CachedResponse
 

F

finishingProcessing() - Method in interface org.apache.cocoon.environment.Environment
Notify that the processing is finished This can be used to cleanup the environment object

G

GLOBAL_SCOPE - Static variable in interface org.apache.cocoon.environment.Request
This constant defines an request wide scope for the request attribute.
Generator - interface org.apache.cocoon.generation.Generator.
A generator is the starting point of a pipeline.
generate() - Method in interface org.apache.cocoon.generation.Generator
Generate the XML and stream it into the pipeline
generate() - Method in interface org.apache.cocoon.reading.Reader
Generate the response.
get(Serializable) - Method in interface org.apache.cocoon.caching.Cache
Get a cached response.
get(String) - Method in interface org.apache.cocoon.environment.Request
Returns the value of the named parameter as an Object, or null if no parameter of the given name exists.
get(String) - Method in interface org.apache.cocoon.environment.ValueHolder
Gets the value assigned to a key.
get(Location) - Static method in class org.apache.cocoon.util.location.LocationImpl
Obtain a LocationImpl from a Location.
getAction() - Method in interface org.apache.cocoon.environment.Environment
Get the action to process
getAttribute(String) - Method in interface org.apache.cocoon.environment.Context
 
getAttribute(String) - Method in interface org.apache.cocoon.environment.Environment
Returns the object bound with the specified name, or null if no object is bound under the name.
getAttribute(String) - Method in interface org.apache.cocoon.environment.Request
Returns the value of the named attribute from the GLOBAL_SCOPE as an Object, or null if no attribute of the given name exists.
getAttribute(String) - Method in interface org.apache.cocoon.environment.Session
Returns the object bound with the specified name in this session, or null if no object is bound under the name.
getAttributeNames() - Method in interface org.apache.cocoon.environment.Context
 
getAttributeNames() - Method in interface org.apache.cocoon.environment.Environment
Returns an Enumeration of String objects containing the names of all the objects bound to this environment.
getAttributeNames() - Method in interface org.apache.cocoon.environment.Request
Returns an Enumeration containing the names of the attributes available to this request globally.
getAttributeNames() - Method in interface org.apache.cocoon.environment.Session
Returns an Enumeration of String objects containing the names of all the objects bound to this session.
getAttributes() - Method in interface org.apache.cocoon.environment.Context
Utility method for getting a Map view of the context attributes.
getAttributes() - Method in interface org.apache.cocoon.environment.Request
Utility method for getting a Map view of the request attributes.
getAttributes() - Method in interface org.apache.cocoon.environment.Session
Utility method for getting a Map view of the request attributes.
getAuthType() - Method in interface org.apache.cocoon.environment.Request
Returns the name of the authentication scheme used to protect the servlet, for example, "BASIC" or "SSL," or null if the servlet was not protected
getCause() - Method in class org.apache.cocoon.CascadingIOException
Retrieve root cause of the exception.
getCharacterEncoding() - Method in interface org.apache.cocoon.environment.Request
Returns the name of the character encoding used in the body of this request.
getCharacterEncoding() - Method in interface org.apache.cocoon.environment.Response
Returns the name of the charset used for the MIME body sent in this response.
getCocoonCookieMap() - Method in interface org.apache.cocoon.environment.Request
Deprecated. use Request.getCookieMap() instead.
getCocoonCookies() - Method in interface org.apache.cocoon.environment.Request
Deprecated. use Request.getCookies() instead.
getCocoonSession(boolean) - Method in interface org.apache.cocoon.environment.Request
Deprecated. use Request.getSession(boolean) instead.
getCocoonSession() - Method in interface org.apache.cocoon.environment.Request
Deprecated. use Request.getSession() instead.
getColumn(Attributes) - Static method in class org.apache.cocoon.util.location.LocationAttributes
Returns the column number of an element (SAX flavor)
getColumn(Element) - Static method in class org.apache.cocoon.util.location.LocationAttributes
Returns the column number of an element (DOM flavor)
getColumnNumber() - Method in interface org.apache.cocoon.util.location.Location
Get the column number of this location
getColumnNumber() - Method in class org.apache.cocoon.util.location.LocationImpl
Get the column number of this location
getComment() - Method in interface org.apache.cocoon.environment.Cookie
Deprecated. Returns the comment describing the purpose of this cookie, or null if the cookie has no comment.
getContentLength() - Method in interface org.apache.cocoon.environment.Request
Returns the length, in bytes, of the request body
getContentType() - Method in class org.apache.cocoon.caching.CachedResponse
 
getContentType() - Method in interface org.apache.cocoon.environment.Environment
Get the content type of the resource
getContentType() - Method in interface org.apache.cocoon.environment.Request
Returns the MIME type of the body of the request
getContext(Map) - Static method in class org.apache.cocoon.environment.ObjectModelHelper
Return Context object stored in the provided objectModel map.
getContextPath() - Method in interface org.apache.cocoon.environment.Request
Returns the portion of the request URI that indicates the context of the request.
getCookieMap() - Method in interface org.apache.cocoon.environment.Request
Returns a map of the Cookie objects the client sent with this request, indexed by name.
getCookies() - Method in interface org.apache.cocoon.environment.Request
Returns an array containing all of the Cookie objects the client sent with this request.
getCreationTime() - Method in interface org.apache.cocoon.environment.Session
Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.
getDateHeader(String) - Method in interface org.apache.cocoon.environment.Request
Returns the value of the specified request header as a long value that represents a Date object.
getDescription() - Method in interface org.apache.cocoon.util.location.Location
Get the description of this location
getDescription() - Method in class org.apache.cocoon.util.location.LocationImpl
Get the description of this location
getDomain() - Method in interface org.apache.cocoon.environment.Cookie
Deprecated. Returns the domain name set for this cookie.
getExpires() - Method in class org.apache.cocoon.caching.CachedResponse
Get the configured expires.
getExpires(Map) - Static method in class org.apache.cocoon.environment.ObjectModelHelper
Return expires object stored in the provided objectModel map.
getGenerator() - Method in interface org.apache.cocoon.components.pipeline.ProcessingPipeline
Get the generator - used for content aggregation
getHeader(String) - Method in interface org.apache.cocoon.environment.Request
Returns the value of the specified request header as a String.
getHeaderNames() - Method in interface org.apache.cocoon.environment.Request
Returns an enumeration of all the header names this request contains.
getHeaders(String) - Method in interface org.apache.cocoon.environment.Request
Returns all the values of the specified request header as an Enumeration of String objects.
getHeaders() - Method in interface org.apache.cocoon.environment.Request
Utility method for getting a Map view of the request headers.
getId() - Method in interface org.apache.cocoon.environment.Session
Returns a string containing the unique identifier assigned to this session.
getInitParameter(String) - Method in interface org.apache.cocoon.environment.Context
 
getInputStream() - Method in interface org.apache.cocoon.environment.Request
Retrieves the body of the request as binary data using an InputStream.
getKey() - Method in interface org.apache.cocoon.caching.CacheableProcessingComponent
Generate the unique key for the resource being rendered.
getKeyForEventPipeline() - Method in interface org.apache.cocoon.components.pipeline.ProcessingPipeline
Return the key for the event pipeline If the "event pipeline" (= the complete pipeline without the serializer) is cacheable and valid, return a key.
getLastAccessedTime() - Method in interface org.apache.cocoon.environment.Session
Returns the last time the client sent a request associated with this session, as the number of milliseconds since midnight January 1, 1970 GMT.
getLastModified() - Method in class org.apache.cocoon.caching.CachedResponse
 
getLastModified() - Method in interface org.apache.cocoon.reading.Reader
 
getLine(Attributes) - Static method in class org.apache.cocoon.util.location.LocationAttributes
Returns the line number of an element (SAX flavor)
getLine(Element) - Static method in class org.apache.cocoon.util.location.LocationAttributes
Returns the line number of an element (DOM flavor)
getLineNumber() - Method in interface org.apache.cocoon.util.location.Location
Get the line number of this location
getLineNumber() - Method in class org.apache.cocoon.util.location.LocationImpl
Get the line number of this location
getLocalAttribute(String) - Method in interface org.apache.cocoon.environment.Request
Returns the value of the named attribute from the LOCAL_SCOPE as an Object, or null if no attribute of the given name exists.
getLocalAttributeNames() - Method in interface org.apache.cocoon.environment.Request
Returns an Enumeration containing the names of the attributes available to this request locally.
getLocale() - Method in interface org.apache.cocoon.environment.Request
Returns the preferred Locale that the client will accept content in, based on the Accept-Language header.
getLocale() - Method in interface org.apache.cocoon.environment.Response
Returns the locale assigned to the response.
getLocales() - Method in interface org.apache.cocoon.environment.Request
Returns an Enumeration of Locale objects indicating, in decreasing order starting with the preferred locale, the locales that are acceptable to the client based on the Accept-Language header.
getLocation() - Method in interface org.apache.cocoon.util.location.Locatable
Get the location of this object
getLocation() - Method in class org.apache.cocoon.util.location.LocatedException
 
getLocation() - Method in class org.apache.cocoon.util.location.LocatedRuntimeException
 
getLocation(Attributes, String) - Static method in class org.apache.cocoon.util.location.LocationAttributes
Returns the Location of an element (SAX flavor).
getLocation(Element, String) - Static method in class org.apache.cocoon.util.location.LocationAttributes
Returns the Location of an element (DOM flavor).
getLocation(Element) - Static method in class org.apache.cocoon.util.location.LocationAttributes
Same as getLocation(elem, null).
getLocation(Object, String) - Method in interface org.apache.cocoon.util.location.LocationUtils.LocationFinder
Get the location of an object
getLocation(Object) - Static method in class org.apache.cocoon.util.location.LocationUtils
Get the location of an object.
getLocation(Object, String) - Static method in class org.apache.cocoon.util.location.LocationUtils
Get the location of an object.
getLocationString(Attributes) - Static method in class org.apache.cocoon.util.location.LocationAttributes
Returns the location of an element (SAX flavor).
getLocationString(Element) - Static method in class org.apache.cocoon.util.location.LocationAttributes
Returns the location of an element that has been processed by this pipe (DOM flavor).
getLocations() - Method in class org.apache.cocoon.util.location.LocatedException
 
getLocations() - Method in class org.apache.cocoon.util.location.LocatedRuntimeException
 
getLocations() - Method in interface org.apache.cocoon.util.location.MultiLocatable
Return the list of locations.
getMaxAge() - Method in interface org.apache.cocoon.environment.Cookie
Deprecated. Returns the maximum age of the cookie, specified in seconds, By default, -1 indicating the cookie will persist until browser shutdown.
getMaxInactiveInterval() - Method in interface org.apache.cocoon.environment.Session
Returns the maximum time interval, in seconds, that the context container will keep this session open between client accesses.
getMessage(String, List) - Static method in class org.apache.cocoon.util.location.LocatedException
Standard way of building the message of a LocatableException, as a Java-like stack trace of locations.
getMessage() - Method in class org.apache.cocoon.util.location.LocatedException
 
getMessage() - Method in class org.apache.cocoon.util.location.LocatedRuntimeException
 
getMethod() - Method in interface org.apache.cocoon.environment.Request
Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
getMimeType(String) - Method in interface org.apache.cocoon.environment.Context
 
getMimeType() - Method in interface org.apache.cocoon.sitemap.SitemapOutputComponent
Obtain the media type for the results being serialized.
getName() - Method in interface org.apache.cocoon.environment.Cookie
Deprecated. Returns the name of the cookie.
getObjectModel() - Method in interface org.apache.cocoon.environment.Environment
Get the underlying object model
getOutputStream(int) - Method in interface org.apache.cocoon.environment.Environment
Get the output stream where to write the generated resource.
getParameter(String) - Method in interface org.apache.cocoon.environment.Request
Returns the value of a request parameter as a String,
getParameterNames() - Method in interface org.apache.cocoon.environment.Request
Returns an Enumeration of String objects containing the names of the parameters contained in this request.
getParameterValues(String) - Method in interface org.apache.cocoon.environment.Request
Returns an array of String objects containing all of the values the given request parameter has, or null if the parameter does not exist.
getParameters() - Method in interface org.apache.cocoon.environment.Request
Utility method for getting a Map view of the request parameters.
getPath() - Method in interface org.apache.cocoon.environment.Cookie
Deprecated. Returns the path on the server to which the browser returns this cookie.
getPathInfo() - Method in interface org.apache.cocoon.environment.Request
Returns any extra path information associated with the URL the client sent when it made this request.
getPathTranslated() - Method in interface org.apache.cocoon.environment.Request
Returns any extra path information after the servlet name but before the query string, and translates it to a real path.
getProtocol() - Method in interface org.apache.cocoon.environment.Request
Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1.
getQueryString() - Method in interface org.apache.cocoon.environment.Request
Returns the query string that is contained in the request URL after the path.
getRawMessage() - Method in interface org.apache.cocoon.util.location.LocatableException
Get the raw message of the exception (the one used in the constructor)
getRawMessage() - Method in class org.apache.cocoon.util.location.LocatedException
 
getRawMessage() - Method in class org.apache.cocoon.util.location.LocatedRuntimeException
 
getRealPath(String) - Method in interface org.apache.cocoon.environment.Context
 
getRemoteAddr() - Method in interface org.apache.cocoon.environment.Request
Returns the Internet Protocol (IP) address of the client that sent the request.
getRemoteHost() - Method in interface org.apache.cocoon.environment.Request
Returns the fully qualified name of the client that sent the request, or the IP address of the client if the name cannot be determined.
getRemoteUser() - Method in interface org.apache.cocoon.environment.Request
Returns the login of the user making this request, if the user has been authenticated, or null if the user has not been authenticated.
getRequest(Map) - Static method in class org.apache.cocoon.environment.ObjectModelHelper
Return Request object stored in the provided objectModel map.
getRequestURI() - Method in interface org.apache.cocoon.environment.Request
Returns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request.
getRequestedSessionId() - Method in interface org.apache.cocoon.environment.Request
Returns the session ID specified by the client.
getResource(String) - Method in interface org.apache.cocoon.environment.Context
 
getResourceAsStream(String) - Method in interface org.apache.cocoon.environment.Context
 
getResponse() - Method in class org.apache.cocoon.caching.CachedResponse
Get the cached response.
getResponse(Map) - Static method in class org.apache.cocoon.environment.ObjectModelHelper
Return Response object stored in the provided objectModel map.
getScheme() - Method in interface org.apache.cocoon.environment.Request
Returns the name of the scheme used to make this request, for example, http, https, or ftp.
getSecure() - Method in interface org.apache.cocoon.environment.Cookie
Deprecated. Returns true if the browser is sending cookies only over a secure protocol, or false if the browser can send cookies using any protocol.
getServerName() - Method in interface org.apache.cocoon.environment.Request
Returns the host name of the server that received the request.
getServerPort() - Method in interface org.apache.cocoon.environment.Request
Returns the port number on which this request was received.
getServletPath() - Method in interface org.apache.cocoon.environment.Request
Returns the part of this request's URL that calls the servlet.
getSession(boolean) - Method in interface org.apache.cocoon.environment.Request
Returns the current HttpSession associated with this request or, if if there is no current session and create is true, returns a new session.
getSession() - Method in interface org.apache.cocoon.environment.Request
Returns the current session associated with this request, or if the request does not have a session, creates one.
getSitemapPath() - Method in interface org.apache.cocoon.environment.Request
Returns the path to the sitemap of the requested resource as interpreted by the sitemap.
getSitemapURI() - Method in interface org.apache.cocoon.environment.Request
Returns the URI of the requested resource as interpreted by the sitemap.
getSitemapURIPrefix() - Method in interface org.apache.cocoon.environment.Request
Returns the URI Prefix of the requested resource where the sitemap is mounted.
getThrowable(Map) - Static method in class org.apache.cocoon.environment.ObjectModelHelper
Return Throwable object stored in the provided objectModel map.
getURI() - Method in interface org.apache.cocoon.environment.Environment
Get the URI to process.
getURI() - Method in interface org.apache.cocoon.util.location.Location
Get the URI of this location
getURI(Attributes) - Static method in class org.apache.cocoon.util.location.LocationAttributes
Returns the URI of an element (SAX flavor)
getURI(Element) - Static method in class org.apache.cocoon.util.location.LocationAttributes
Returns the URI of an element (DOM flavor)
getURI() - Method in class org.apache.cocoon.util.location.LocationImpl
Get the URI of this location
getURIPrefix() - Method in interface org.apache.cocoon.environment.Environment
Get the prefix of the URI in progress.
getUserPrincipal() - Method in interface org.apache.cocoon.environment.Request
Returns the login of the user making this request, if the user has been authenticated, or null if the user has not been authenticated.
getValidity() - Method in interface org.apache.cocoon.caching.CacheableProcessingComponent
Generate the validity object.
getValidityForEventPipeline() - Method in interface org.apache.cocoon.components.pipeline.ProcessingPipeline
Return valid validity objects for the event pipeline If the "event pipeline" (= the complete pipeline without the serializer) is cacheable and valid, return all validity objects.
getValidityObjects() - Method in class org.apache.cocoon.caching.CachedResponse
Get the validity objects
getValue() - Method in interface org.apache.cocoon.environment.Cookie
Deprecated. Returns the value of the cookie.
getVersion() - Method in interface org.apache.cocoon.environment.Cookie
Deprecated. Returns the version of the protocol this cookie complies with.
getView() - Method in interface org.apache.cocoon.environment.Environment
Get the view to process
globalRedirect(boolean, String) - Method in interface org.apache.cocoon.environment.Redirector
 

H

handleError(Exception) - Method in interface org.apache.cocoon.sitemap.SitemapErrorHandler
Handle an error.
hasRedirected() - Method in interface org.apache.cocoon.environment.Redirector
Was one of the redirection methods called ?
hashCode() - Method in class org.apache.cocoon.util.location.LocationImpl
 

I

ID - Static variable in interface org.apache.cocoon.xml.AttributeTypes
 
IDREF - Static variable in interface org.apache.cocoon.xml.AttributeTypes
 
IDREFS - Static variable in interface org.apache.cocoon.xml.AttributeTypes
 
INDEX_URI - Static variable in class org.apache.cocoon.Constants
The default URI to be used when a URI requested refers to a directory, e.g.
ignorableWhitespace(char[], int, int) - Method in class org.apache.cocoon.util.location.LocationAttributes.Pipe
 
informBranchPoint() - Method in interface org.apache.cocoon.components.pipeline.ProcessingPipeline
Informs pipeline we have come across a branch point
invalidate() - Method in interface org.apache.cocoon.environment.Session
Invalidates this session to it.
isExternal() - Method in interface org.apache.cocoon.environment.Environment
Is this environment external ? An external environment is one that is created in response to an external request (http, commandline, etc.).
isInternalRedirect() - Method in interface org.apache.cocoon.environment.Environment
Is this an internal redirect? An environment is on internal redirect if it is an internal request (via the cocoon: protocol) and used for a redirect.
isKnown(Location) - Static method in class org.apache.cocoon.util.location.LocationUtils
Checks if a location is known, i.e.
isNew() - Method in interface org.apache.cocoon.environment.Session
Returns true if the client does not yet know about the session or if the client chooses not to join the session.
isRequestedSessionIdFromCookie() - Method in interface org.apache.cocoon.environment.Request
Checks whether the requested session ID came in as a cookie.
isRequestedSessionIdFromURL() - Method in interface org.apache.cocoon.environment.Request
Checks whether the requested session ID came in as part of the request URL.
isRequestedSessionIdValid() - Method in interface org.apache.cocoon.environment.Request
Checks whether the requested session ID is still valid.
isResponseModified(long) - Method in interface org.apache.cocoon.environment.Environment
Check if the response has been modified since the same "resource" was requested.
isSecure() - Method in interface org.apache.cocoon.environment.Request
Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
isUnknown(Location) - Static method in class org.apache.cocoon.util.location.LocationUtils
Checks if a location is unknown, i.e.
isUserInRole(String) - Method in interface org.apache.cocoon.environment.Request
Checks whether the currently logged in user is in a specified role.

L

LINE_ATTR - Static variable in class org.apache.cocoon.util.location.LocationAttributes
Attribute name for the line number
LINK_COLLECTION_OBJECT - Static variable in class org.apache.cocoon.Constants
Key of the List for collecting links.
LINK_CONTENT_TYPE - Static variable in class org.apache.cocoon.Constants
Mime-type for the link view FIXME(GP): Isn't this Environment specific?
LINK_OBJECT - Static variable in class org.apache.cocoon.Constants
Key of the Map of index translation table.
LINK_VIEW - Static variable in class org.apache.cocoon.Constants
Name of the request value for the link view FIXME(GP): Isn't this Environment specific?
Locatable - interface org.apache.cocoon.util.location.Locatable.
A interface that should be implemented by objects knowning their location (i.e.
LocatableException - interface org.apache.cocoon.util.location.LocatableException.
Extension of Locatable for exceptions.
LocatedException - exception org.apache.cocoon.util.location.LocatedException.
A cascading and located Exception.
LocatedException(String) - Constructor for class org.apache.cocoon.util.location.LocatedException
 
LocatedException(String, Throwable) - Constructor for class org.apache.cocoon.util.location.LocatedException
 
LocatedException(String, Location) - Constructor for class org.apache.cocoon.util.location.LocatedException
 
LocatedException(String, Throwable, Location) - Constructor for class org.apache.cocoon.util.location.LocatedException
 
LocatedRuntimeException - exception org.apache.cocoon.util.location.LocatedRuntimeException.
A cascading and located RuntimeException.
LocatedRuntimeException(String) - Constructor for class org.apache.cocoon.util.location.LocatedRuntimeException
 
LocatedRuntimeException(String, Throwable) - Constructor for class org.apache.cocoon.util.location.LocatedRuntimeException
 
LocatedRuntimeException(String, Location) - Constructor for class org.apache.cocoon.util.location.LocatedRuntimeException
 
LocatedRuntimeException(String, Throwable, Location) - Constructor for class org.apache.cocoon.util.location.LocatedRuntimeException
 
LocatedRuntimeException(String, Throwable, Location, boolean) - Constructor for class org.apache.cocoon.util.location.LocatedRuntimeException
 
Location - interface org.apache.cocoon.util.location.Location.
A location in a resource.
LocationAttributes - class org.apache.cocoon.util.location.LocationAttributes.
A class to handle location information stored in attributes.
LocationAttributes.Pipe - class org.apache.cocoon.util.location.LocationAttributes.Pipe.
A SAX filter that adds the information available from the Locator as attributes.
LocationAttributes.Pipe() - Constructor for class org.apache.cocoon.util.location.LocationAttributes.Pipe
Create a filter.
LocationAttributes.Pipe(ContentHandler) - Constructor for class org.apache.cocoon.util.location.LocationAttributes.Pipe
Create a filter that is chained to another handler.
LocationImpl - class org.apache.cocoon.util.location.LocationImpl.
A simple immutable and serializable implementation of Location.
LocationImpl(String, String) - Constructor for class org.apache.cocoon.util.location.LocationImpl
Build a location for a given URI, with unknown line and column numbers.
LocationImpl(String, String, int, int) - Constructor for class org.apache.cocoon.util.location.LocationImpl
Build a location for a given URI and line and columb numbers.
LocationImpl(Location) - Constructor for class org.apache.cocoon.util.location.LocationImpl
Copy constructor.
LocationImpl(String, Location) - Constructor for class org.apache.cocoon.util.location.LocationImpl
Create a location from an existing one, but with a different description
LocationUtils - class org.apache.cocoon.util.location.LocationUtils.
Location-related utility methods.
LocationUtils.LocationFinder - interface org.apache.cocoon.util.location.LocationUtils.LocationFinder.
An finder or object locations
lastModified - Variable in class org.apache.cocoon.caching.CachedResponse
 
linkResource(String, String, String, String, String, String, Attributes) - Method in interface org.apache.cocoon.xml.xlink.XLinkHandler
 
linkTitle(String, String, String, Attributes) - Method in interface org.apache.cocoon.xml.xlink.XLinkHandler
 

M

Modifiable - interface org.apache.cocoon.Modifiable.
This interface is implemented by those classes that change their behavior/results over time (non-ergodic).
MultiLocatable - interface org.apache.cocoon.util.location.MultiLocatable.
An extension of Location for classes that can hold a list of locations.
modifiedSince(long) - Method in interface org.apache.cocoon.Modifiable
Queries the class to estimate its ergodic period termination.

N

NAME - Static variable in class org.apache.cocoon.Constants
Deprecated. This will be removed soon.
NAME - Static variable in interface org.apache.cocoon.xml.AttributeTypes
 
NAMES - Static variable in interface org.apache.cocoon.xml.AttributeTypes
 
NMTOKEN - Static variable in interface org.apache.cocoon.xml.AttributeTypes
 
NMTOKENS - Static variable in interface org.apache.cocoon.xml.AttributeTypes
 
NOTATION - Static variable in interface org.apache.cocoon.xml.AttributeTypes
 
NOTIFYING_OBJECT - Static variable in class org.apache.cocoon.Constants
Deprecated. Usage of Notifying object has been deprecated in favor of using Exception object at ObjectModelHelper.THROWABLE_OBJECT.
NUMBER - Static variable in interface org.apache.cocoon.xml.AttributeTypes
 
NUMBERS - Static variable in interface org.apache.cocoon.xml.AttributeTypes
 
NUTOKEN - Static variable in interface org.apache.cocoon.xml.AttributeTypes
 
NUTOKENS - Static variable in interface org.apache.cocoon.xml.AttributeTypes
 

O

ObjectModelHelper - class org.apache.cocoon.environment.ObjectModelHelper.
A set of constants and methods to access the content of the object model.
org.apache.cocoon - package org.apache.cocoon
 
org.apache.cocoon.caching - package org.apache.cocoon.caching
 
org.apache.cocoon.components.pipeline - package org.apache.cocoon.components.pipeline
 
org.apache.cocoon.environment - package org.apache.cocoon.environment
 
org.apache.cocoon.generation - package org.apache.cocoon.generation
 
org.apache.cocoon.reading - package org.apache.cocoon.reading
 
org.apache.cocoon.serialization - package org.apache.cocoon.serialization
 
org.apache.cocoon.sitemap - package org.apache.cocoon.sitemap
 
org.apache.cocoon.transformation - package org.apache.cocoon.transformation
 
org.apache.cocoon.util.location - package org.apache.cocoon.util.location
 
org.apache.cocoon.xml - package org.apache.cocoon.xml
 
org.apache.cocoon.xml.xlink - package org.apache.cocoon.xml.xlink
 

P

PARENT_CONTEXT - Static variable in class org.apache.cocoon.environment.ObjectModelHelper
Key for a Map containing information from a parent request provided to a sub-request (internal processing)
PREFIX - Static variable in class org.apache.cocoon.util.location.LocationAttributes
Prefix for the location namespace
PermanentRedirector - interface org.apache.cocoon.environment.PermanentRedirector.
Interface for a permanent redirector abstraction
ProcessingException - exception org.apache.cocoon.ProcessingException.
This Exception is thrown every time there is a problem in processing a request.
ProcessingException(String) - Constructor for class org.apache.cocoon.ProcessingException
Construct a new ProcessingException instance.
ProcessingException(Exception) - Constructor for class org.apache.cocoon.ProcessingException
Creates a new ProcessingException instance.
ProcessingException(String, Throwable) - Constructor for class org.apache.cocoon.ProcessingException
Construct a new ProcessingException that references a parent Exception.
ProcessingException(String, Location) - Constructor for class org.apache.cocoon.ProcessingException
Construct a new ProcessingException that has an associated location.
ProcessingException(String, Throwable, Location) - Constructor for class org.apache.cocoon.ProcessingException
Construct a new ProcessingException that has a parent exception and an associated location.
ProcessingPipeline - interface org.apache.cocoon.components.pipeline.ProcessingPipeline.
A ProcessingPipeline produces the response for a given request.
parse(String) - Static method in class org.apache.cocoon.util.location.LocationUtils
Parse a location string of the form "uri:line:column" (e.g.
permanentRedirect(boolean, String) - Method in interface org.apache.cocoon.environment.PermanentRedirector
Redirect to the given URL
prepareErrorPipeline(Exception) - Method in interface org.apache.cocoon.sitemap.SitemapErrorHandler
Build error handling pipeline.
prepareInternal(Environment) - Method in interface org.apache.cocoon.components.pipeline.ProcessingPipeline
Prepare an internal processing
printStackTrace() - Method in class org.apache.cocoon.CascadingIOException
 
printStackTrace(PrintStream) - Method in class org.apache.cocoon.CascadingIOException
 
printStackTrace(PrintWriter) - Method in class org.apache.cocoon.CascadingIOException
 
process(Environment) - Method in interface org.apache.cocoon.components.pipeline.ProcessingPipeline
Process the given Environment, producing the output.
process(Environment, XMLConsumer) - Method in interface org.apache.cocoon.components.pipeline.ProcessingPipeline
Process the given Environment, but do not use the serializer.
processingInstruction(String, String) - Method in class org.apache.cocoon.util.location.LocationAttributes.Pipe
 

Q

Q_COL_ATTR - Static variable in class org.apache.cocoon.util.location.LocationAttributes
Attribute qualified name for the column number
Q_LINE_ATTR - Static variable in class org.apache.cocoon.util.location.LocationAttributes
Attribute qualified name for the line number
Q_SRC_ATTR - Static variable in class org.apache.cocoon.util.location.LocationAttributes
Attribute qualified name for the location URI

R

REQUEST_OBJECT - Static variable in class org.apache.cocoon.environment.ObjectModelHelper
Key for the environment Request in the object model.
REQUEST_SCOPE - Static variable in interface org.apache.cocoon.environment.Request
This constant defines the scope of the request attribute to be private to the current (sub) request.
RESPONSE_OBJECT - Static variable in class org.apache.cocoon.environment.ObjectModelHelper
Key for the environment Response in the object model.
ROLE - Static variable in interface org.apache.cocoon.caching.Cache
The Avalon Role
ROLE - Static variable in interface org.apache.cocoon.components.pipeline.ProcessingPipeline
 
ROLE - Static variable in interface org.apache.cocoon.generation.Generator
 
ROLE - Static variable in interface org.apache.cocoon.reading.Reader
 
ROLE - Static variable in interface org.apache.cocoon.serialization.Serializer
 
ROLE - Static variable in interface org.apache.cocoon.transformation.Transformer
 
Reader - interface org.apache.cocoon.reading.Reader.
A reader can be used to generate binary output for a request.
Redirector - interface org.apache.cocoon.environment.Redirector.
Interface for an redirector abstraction
Request - interface org.apache.cocoon.environment.Request.
Defines an interface to provide client request information .
ResourceNotFoundException - exception org.apache.cocoon.ResourceNotFoundException.
This Exception is thrown every time there is a problem in finding a resource.
ResourceNotFoundException(String) - Constructor for class org.apache.cocoon.ResourceNotFoundException
Construct a new ResourceNotFoundException instance.
ResourceNotFoundException(String, Throwable) - Constructor for class org.apache.cocoon.ResourceNotFoundException
Construct a new ResourceNotFoundException that references a parent Exception.
ResourceNotFoundException(String, Location) - Constructor for class org.apache.cocoon.ResourceNotFoundException
 
ResourceNotFoundException(String, Throwable, Location) - Constructor for class org.apache.cocoon.ResourceNotFoundException
 
Response - interface org.apache.cocoon.environment.Response.
Defines an interface to provide client response information.
redirect(String, boolean, boolean) - Method in interface org.apache.cocoon.environment.Environment
Redirect the client to the given URL
redirect(boolean, String) - Method in interface org.apache.cocoon.environment.Redirector
Redirect to the given URL
remove(Serializable) - Method in interface org.apache.cocoon.caching.Cache
Remove a cached response.
remove(Element, boolean) - Static method in class org.apache.cocoon.util.location.LocationAttributes
Remove the location attributes from a DOM element.
removeAttribute(String) - Method in interface org.apache.cocoon.environment.Context
 
removeAttribute(String) - Method in interface org.apache.cocoon.environment.Environment
Removes the object bound with the specified name from this environment.
removeAttribute(String) - Method in interface org.apache.cocoon.environment.Request
Removes an attribute from this request globally.
removeAttribute(String) - Method in interface org.apache.cocoon.environment.Session
Removes the object bound with the specified name from this session.
removeLocalAttribute(String) - Method in interface org.apache.cocoon.environment.Request
Removes an attribute from this request in the GLOBAL_SCOPE.
response - Variable in class org.apache.cocoon.caching.CachedResponse
 

S

SHOWTIME_PARAM - Static variable in class org.apache.cocoon.Constants
The request parameter name to add a line of the request duration.
SRC_ATTR - Static variable in class org.apache.cocoon.util.location.LocationAttributes
Attribute name for the location URI
Serializer - interface org.apache.cocoon.serialization.Serializer.
A serializer is the last point of a pipeline.
Session - interface org.apache.cocoon.environment.Session.
Provides a way to identify a user across more than one page request or visit to a Web site and to store information about that user.
SitemapErrorHandler - interface org.apache.cocoon.sitemap.SitemapErrorHandler.
Interface providing error handling capabilities to the pipeline
SitemapModelComponent - interface org.apache.cocoon.sitemap.SitemapModelComponent.
The SitemapModelComponent identifies the contract between the Sitemap and your pipeline components that create or transform information.
SitemapOutputComponent - interface org.apache.cocoon.sitemap.SitemapOutputComponent.
The SitemapOutputComponents are responsible for taking the results of a pipeline to the end user.
SourceResolver - interface org.apache.cocoon.environment.SourceResolver.
Base interface for resolving a source by system identifiers.
searchAttribute(String) - Method in interface org.apache.cocoon.environment.Request
Returns the value of the named attribute searching both scopes as an Object, or null if no attribute of the given name exists.
sendStatus(int) - Method in interface org.apache.cocoon.environment.Redirector
Send a content-less response with the given status code.
setAttribute(String, Object) - Method in interface org.apache.cocoon.environment.Context
 
setAttribute(String, Object) - Method in interface org.apache.cocoon.environment.Environment
Binds an object to this environment, using the name specified.
setAttribute(String, Object) - Method in interface org.apache.cocoon.environment.Request
Stores an attribute in this request in the GLOBAL_SCOPE.
setAttribute(String, Object) - Method in interface org.apache.cocoon.environment.Session
Binds an object to this session, using the name specified.
setCharacterEncoding(String) - Method in interface org.apache.cocoon.environment.Request
Overrides the charactor encoding of parameters.
setComment(String) - Method in interface org.apache.cocoon.environment.Cookie
Deprecated. Specifies a comment that describes a cookie's purpose.
setConsumer(XMLConsumer) - Method in interface org.apache.cocoon.xml.XMLProducer
Set the XMLConsumer that will receive XML data.
setContentLength(int) - Method in interface org.apache.cocoon.environment.Environment
Set the length of the generated content
setContentType(String) - Method in class org.apache.cocoon.caching.CachedResponse
 
setContentType(String) - Method in interface org.apache.cocoon.environment.Environment
Set the content type of the generated resource
setDateHeader(String, long) - Method in interface org.apache.cocoon.environment.Response
Sets a response header with the given name and date-value.
setDocumentLocator(Locator) - Method in class org.apache.cocoon.util.location.LocationAttributes.Pipe
 
setDomain(String) - Method in interface org.apache.cocoon.environment.Cookie
Deprecated. Specifies the domain within which this cookie should be presented.
setErrorHandler(SitemapErrorHandler) - Method in interface org.apache.cocoon.components.pipeline.ProcessingPipeline
Sets error handler for this pipeline.
setExpires(Long) - Method in class org.apache.cocoon.caching.CachedResponse
Set the (newly) configured expires.
setGenerator(String, String, Parameters, Parameters) - Method in interface org.apache.cocoon.components.pipeline.ProcessingPipeline
Set the generator that will be used as the initial step in the pipeline.
setHeader(String, String) - Method in interface org.apache.cocoon.environment.Response
Sets a response header with the given name and value.
setIntHeader(String, int) - Method in interface org.apache.cocoon.environment.Response
Sets a response header with the given name and int value.
setLastModified(long) - Method in class org.apache.cocoon.caching.CachedResponse
Set the (newly) configured last modified.
setLocalAttribute(String, Object) - Method in interface org.apache.cocoon.environment.Request
Stores an attribute in this request locally.
setLocale(Locale) - Method in interface org.apache.cocoon.environment.Response
Sets the locale of the response, setting the headers (including the Content-Type's charset) as appropriate.
setMaxAge(int) - Method in interface org.apache.cocoon.environment.Cookie
Deprecated. Sets the maximum age of the cookie in seconds.
setMaxInactiveInterval(int) - Method in interface org.apache.cocoon.environment.Session
Specifies the time, in seconds, between client requests before the contextcontainer will invalidate this session.
setOutputStream(OutputStream) - Method in interface org.apache.cocoon.sitemap.SitemapOutputComponent
Set the OutputStream where the requested resource should be serialized.
setPath(String) - Method in interface org.apache.cocoon.environment.Cookie
Deprecated. Specifies a path for the cookie to which the client should return the cookie.
setProcessorManager(ServiceManager) - Method in interface org.apache.cocoon.components.pipeline.ProcessingPipeline
Set the ServiceManager where pipeline components have to be searched for.
setReader(String, String, Parameters, String) - Method in interface org.apache.cocoon.components.pipeline.ProcessingPipeline
Set the reader for this pipeline
setResponseIsNotModified() - Method in interface org.apache.cocoon.environment.Environment
Mark the response as not modified.
setSecure(boolean) - Method in interface org.apache.cocoon.environment.Cookie
Deprecated. Indicates to the browser whether the cookie should only be sent using a secure protocol, such as HTTPS or SSL.
setSerializer(String, String, Parameters, Parameters, String) - Method in interface org.apache.cocoon.components.pipeline.ProcessingPipeline
Set the serializer for this pipeline
setStatus(int) - Method in interface org.apache.cocoon.environment.Environment
Set the response status code
setURI(String, String) - Method in interface org.apache.cocoon.environment.Environment
Set the URI and the prefix to process.
setValue(String) - Method in interface org.apache.cocoon.environment.Cookie
Deprecated. Assigns a new value to a cookie after the cookie is created.
setVersion(int) - Method in interface org.apache.cocoon.environment.Cookie
Deprecated. Sets the version of the cookie protocol this cookie complies with.
setup(Parameters) - Method in interface org.apache.cocoon.components.pipeline.ProcessingPipeline
Setup this component.
setup(SourceResolver, Map, String, Parameters) - Method in interface org.apache.cocoon.sitemap.SitemapModelComponent
The Sitemap will call the setup() method to prepare the component for use.
shouldSetContentLength() - Method in interface org.apache.cocoon.sitemap.SitemapOutputComponent
Test if the component needs the content length set.
simpleLink(String, String, String, String, String, String, String, String, String, Attributes) - Method in interface org.apache.cocoon.xml.xlink.XLinkHandler
 
skippedEntity(String) - Method in class org.apache.cocoon.util.location.LocationAttributes.Pipe
 
startArc(String, String, String, String, String, String, String, String, String, Attributes) - Method in interface org.apache.cocoon.xml.xlink.XLinkHandler
 
startDocument() - Method in class org.apache.cocoon.util.location.LocationAttributes.Pipe
 
startElement(String, String, String, Attributes) - Method in class org.apache.cocoon.util.location.LocationAttributes.Pipe
 
startExtendedLink(String, String, String, String, String, Attributes) - Method in interface org.apache.cocoon.xml.xlink.XLinkHandler
 
startLocator(String, String, String, String, String, String, String, Attributes) - Method in interface org.apache.cocoon.xml.xlink.XLinkHandler
 
startPrefixMapping(String, String) - Method in class org.apache.cocoon.util.location.LocationAttributes.Pipe
 
startingProcessing() - Method in interface org.apache.cocoon.environment.Environment
Notify that the processing starts.
store(Serializable, CachedResponse) - Method in interface org.apache.cocoon.caching.Cache
Store a cached response

T

THROWABLE_OBJECT - Static variable in class org.apache.cocoon.environment.ObjectModelHelper
Key for the throwable object, only available within a <map:handle-errors>.
Transformer - interface org.apache.cocoon.transformation.Transformer.
A transformer is the zero to several intermediate points in a pipeline.
throwLocated(String, Throwable, Location) - Static method in class org.apache.cocoon.ProcessingException
Throw a located exception given an existing exception and the location where this exception was catched.
throwLocated(String, Throwable, List) - Static method in class org.apache.cocoon.ProcessingException
Throw a located exception given an existing exception and the locations where this exception was catched.
toDOM(Node) - Method in interface org.apache.cocoon.xml.XMLFragment
Appends children representing the object's state to the given node.
toString() - Method in class org.apache.cocoon.CascadingIOException
 
toString() - Method in class org.apache.cocoon.util.location.LocationImpl
 
toString(Location) - Static method in class org.apache.cocoon.util.location.LocationUtils
Builds a string representation of a location, in the "descripton - uri:line:column" format (e.g.
tryResetResponse() - Method in interface org.apache.cocoon.environment.Environment
Reset the response if possible.

U

UNKNOWN - Static variable in interface org.apache.cocoon.util.location.Location
Constant for unknown locations.
UNKNOWN_STRING - Static variable in class org.apache.cocoon.util.location.LocationUtils
The string representation of an unknown location: "[unknown location]".
URI - Static variable in class org.apache.cocoon.util.location.LocationAttributes
Namespace URI for location attributes

V

VERSION - Static variable in class org.apache.cocoon.Constants
The version of this build.
VIEW_PARAM - Static variable in class org.apache.cocoon.Constants
The request parameter name to request a specific view of a resource.
ValueHolder - interface org.apache.cocoon.environment.ValueHolder.
A class of this interface is able to store and retrieve references to other objects by a key.
validityObjects - Variable in class org.apache.cocoon.caching.CachedResponse
 

W

WIRING - Static variable in class org.apache.cocoon.Constants
Path to the wiring.xml relative to the context root directory

X

XLinkHandler - interface org.apache.cocoon.xml.xlink.XLinkHandler.
This interface indicates an XLinkHandler that uses the same event driven design patterns that SAX enforces.
XMLConsumer - interface org.apache.cocoon.xml.XMLConsumer.
This interfaces identifies classes that consume XML data, receiving notification of SAX events.
XMLFragment - interface org.apache.cocoon.xml.XMLFragment.
This interface must be implemented by classes willing to provide an XML representation of their current state.
XMLPipe - interface org.apache.cocoon.xml.XMLPipe.
The XMLPipe is both an XMLProducer and an XMLConsumer.
XMLProducer - interface org.apache.cocoon.xml.XMLProducer.
This interfaces identifies classes that produce XML data, sending SAX events to the configured XMLConsumer.
XML_NAMESPACE_URI - Static variable in class org.apache.cocoon.Constants
The URI for xml namespaces

Y

YEAR - Static variable in class org.apache.cocoon.Constants
The year of the build

A B C D E F G H I L M N O P Q R S T U V W X Y

Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.