| org.apache.cocoon.environment.Environment
All known Subclasses: org.apache.cocoon.environment.AbstractEnvironment, org.apache.cocoon.environment.mock.MockEnvironment, org.apache.cocoon.environment.wrapper.MutableEnvironmentFacade,
| finishingProcessing | | void finishingProcessing()(Code) | | Notify that the processing is finished
This can be used to cleanup the environment object
|
| getAction | | String getAction()(Code) | | Get the action to process
|
| getAttribute | | Object getAttribute(String name)(Code) | | Returns the object bound with the specified name, or null
if no object is bound under the name.
Parameters:
name - a string specifying the name of the object the object with the specified name |
| getAttributeNames | | Enumeration getAttributeNames()(Code) | | Returns an Enumeration of String objects
containing the names of all the objects bound to this environment.
an Enumeration of Strings. |
| getContentType | | String getContentType()(Code) | | Get the content type of the resource
|
| getObjectModel | | Map getObjectModel()(Code) | | Get the underlying object model
|
| getOutputStream | | OutputStream getOutputStream(int bufferSize) throws IOException(Code) | | Get the output stream where to write the generated resource.
The returned stream is buffered by the environment. If the
buffer size is -1 then the complete output is buffered.
If the buffer size is 0, no buffering takes place.
This method replaces
Environment.getOutputStream() .
|
| getRootContext | | String getRootContext()(Code) | | Get the Root Context
|
| getURI | | String getURI()(Code) | | Get the URI to process. The prefix is stripped off.
|
| getURIPrefix | | String getURIPrefix()(Code) | | Get the prefix of the URI in progress.
|
| isExternal | | boolean isExternal()(Code) | | Is this environment external ? An external environment is one that
is created in response to an external request (http, commandline, etc.).
Environments created by the "cocoon:" protocol aren't external.
true if this environment is external |
| isInternalRedirect | | boolean isInternalRedirect()(Code) | | 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.
|
| isResponseModified | | boolean isResponseModified(long lastModified)(Code) | | Check if the response has been modified since the same
"resource" was requested.
The caller has to test if it is really the same "resource"
which is requested.
true if the response is modified or if theenvironment is not able to test it |
| redirect | | void redirect(boolean sessionmode, String url) throws IOException(Code) | | Redirect the client to the given URL
|
| removeAttribute | | void removeAttribute(String name)(Code) | | Removes the object bound with the specified name from
this environment. If the environment does not have an object
bound with the specified name, this method does nothing.
Parameters:
name - the name of the object to remove |
| setAttribute | | void setAttribute(String name, Object value)(Code) | | Binds an object to this environment, using the name specified. This allows
the pipeline assembly engine to store for its own use objects that souldn't
be exposed to other components (generators, selectors, etc) and therefore
cannot be put in the object model.
If an object of the same name is already bound, the object is replaced.
Parameters:
name - the name to which the object is bound
Parameters:
value - the object to be bound |
| setContentLength | | void setContentLength(int length)(Code) | | Set the length of the generated content
|
| setContentType | | void setContentType(String mimeType)(Code) | | Set the content type of the generated resource
|
| setContext | | void setContext(String prefix, String uri, String context)(Code) | | Set the context. This is similar to changeContext()
except that it is absolute.
|
| setResponseIsNotModified | | void setResponseIsNotModified()(Code) | | Mark the response as not modified.
|
| setStatus | | void setStatus(int statusCode)(Code) | | Set the response status code
|
| startingProcessing | | void startingProcessing()(Code) | | Notify that the processing starts.
|
| tryResetResponse | | boolean tryResetResponse() throws IOException(Code) | | Reset the response if possible. This allows error handlers to have
a higher chance to produce clean output if the pipeline that raised
the error has already output some data.
If a buffered output stream is used, resetting is always successful.
true if the response was successfully reset |
|
|