Java Doc for AbstractEnvironment.java in  » Content-Management-System » apache-lenya-2.0 » org » apache » cocoon » environment » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Content Management System » apache lenya 2.0 » org.apache.cocoon.environment 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.cocoon.environment.AbstractEnvironment

All known Subclasses:   org.apache.cocoon.environment.commandline.AbstractCommandLineEnvironment,  org.apache.cocoon.environment.http.HttpEnvironment,  org.apache.cocoon.environment.wrapper.EnvironmentWrapper,  org.apache.cocoon.environment.portlet.PortletEnvironment,  org.apache.cocoon.environment.background.BackgroundEnvironment,
AbstractEnvironment
abstract public class AbstractEnvironment extends AbstractLogEnabled implements Environment(Code)
Base class for any environment
author:
   Björn Lütkemeier
author:
   Giacomo Pati
author:
   Carsten Ziegeler
version:
   $Id: AbstractEnvironment.java 540711 2007-05-22 19:36:07Z cziegeler $


Field Summary
protected  Stringaction
    
protected static  MethodavalonToCocoonSourceWrapper
    
protected  Stringcontext
    
protected  booleaninitializedComponents
    
protected  ComponentManagermanager
    
protected  HashMapobjectModel
    
protected  OutputStreamoutputStream
    
protected  StringBufferprefix
    
protected  StringrootContext
    
protected  BufferedOutputStreamsecureOutputStream
    
protected  org.apache.excalibur.source.SourceResolversourceResolver
    
protected  Stringuris
    
protected  Stringview
    

Constructor Summary
public  AbstractEnvironment(String uri, String view, File file)
    
public  AbstractEnvironment(String uri, String view, File file, String action)
    
public  AbstractEnvironment(String uri, String view, String context, String action)
    

Method Summary
public  voidchangeContext(String newPrefix, String newContext)
    
public  voidcommitResponse()
    
protected static  StringextractAction(Request req)
     Helper method to extract the action name from the request.
protected static  StringextractView(Request request)
     Helper method to extract the view name from the request.
public  voidfinishingProcessing()
    
public  StringgetAction()
    
public  ObjectgetAttribute(String name)
    
public  EnumerationgetAttributeNames()
    
public  StringgetContext()
    
public  MapgetObjectModel()
    
public  OutputStreamgetOutputStream()
     Get the output stream where to write the generated resource.
public  OutputStreamgetOutputStream(int bufferSize)
     Get the output stream where to write the generated resource. The returned stream is buffered by the environment.
public  StringgetRootContext()
    
public  StringgetURI()
     Returns the uri in progress.
public  StringgetURIPrefix()
    
public  StringgetView()
    
public  voidglobalRedirect(boolean sessionmode, String newURL)
    
protected  booleanhasAttribute(String name)
    
protected  voidinitComponents()
    
public  booleanisInternalRedirect()
    
public  booleanisResponseModified(long lastModified)
     Check if the response has been modified since the same "resource" was requested.
public  voidrelease(org.apache.excalibur.source.Source source)
    
public  voidremoveAttribute(String name)
    
public  Sourceresolve(String systemId)
     Resolve an entity.
public  org.apache.excalibur.source.SourceresolveURI(String location)
     Get a Source object.
public  org.apache.excalibur.source.SourceresolveURI(String location, String baseURI, Map parameters)
     Get a Source object.
protected  voidsetAction(String action)
     Allow implementations to set action later than in super() constructor Action can be set only once, and should be set in implementation's constructor.
public  voidsetAttribute(String name, Object value)
    
protected  voidsetContext(String context)
     Set the context.
public  voidsetContext(String prefix, String uri, String context)
     Set the context.
public  voidsetResponseIsNotModified()
     Mark the response as not modified.
public  voidsetStatus(int statusCode)
    
protected  voidsetURIPrefix(String prefix)
    
protected  voidsetView(String view)
     Allow implementations to set view later than in super() constructor.
public  voidstartingProcessing()
     Notify that the processing starts.
public  booleantryResetResponse()
     Reset the response if possible.

Field Detail
action
protected String action(Code)
The Action requested



avalonToCocoonSourceWrapper
protected static Method avalonToCocoonSourceWrapper(Code)
The AvalonToCocoonSourceWrapper (this is for the deprecated support)



context
protected String context(Code)
The Context path



initializedComponents
protected boolean initializedComponents(Code)
Do we have our components ?



manager
protected ComponentManager manager(Code)
The component manager



objectModel
protected HashMap objectModel(Code)
The servlet object model



outputStream
protected OutputStream outputStream(Code)
The real output stream



prefix
protected StringBuffer prefix(Code)
The current prefix to strip off from the request uri



rootContext
protected String rootContext(Code)
The root context path



secureOutputStream
protected BufferedOutputStream secureOutputStream(Code)
The secure Output Stream



sourceResolver
protected org.apache.excalibur.source.SourceResolver sourceResolver(Code)
The real source resolver



uris
protected String uris(Code)
The current uri in progress



view
protected String view(Code)
The View requested




Constructor Detail
AbstractEnvironment
public AbstractEnvironment(String uri, String view, File file) throws MalformedURLException(Code)
Constructs the abstract environment



AbstractEnvironment
public AbstractEnvironment(String uri, String view, File file, String action) throws MalformedURLException(Code)
Constructs the abstract environment



AbstractEnvironment
public AbstractEnvironment(String uri, String view, String context, String action) throws MalformedURLException(Code)
Constructs the abstract environment




Method Detail
changeContext
public void changeContext(String newPrefix, String newContext) throws IOException(Code)
Adds an prefix to the overall stripped off prefix from the request uri



commitResponse
public void commitResponse() throws IOException(Code)
Commit the response



extractAction
protected static String extractAction(Request req)(Code)
Helper method to extract the action name from the request.



extractView
protected static String extractView(Request request)(Code)
Helper method to extract the view name from the request.



finishingProcessing
public void finishingProcessing()(Code)
Notify that the processing is finished This can be used to cleanup the environment object



getAction
public String getAction()(Code)
Returns the request action



getAttribute
public Object getAttribute(String name)(Code)



getAttributeNames
public Enumeration getAttributeNames()(Code)



getContext
public String getContext()(Code)
Get the current Context



getObjectModel
public Map getObjectModel()(Code)
Returns a Map containing environment specific objects



getOutputStream
public OutputStream getOutputStream() throws IOException(Code)
Get the output stream where to write the generated resource. AbstractEnvironment.getOutputStream(int)



getOutputStream
public 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 AbstractEnvironment.getOutputStream() .



getRootContext
public String getRootContext()(Code)
Get the Root Context



getURI
public String getURI()(Code)
Returns the uri in progress. The prefix is stripped off



getURIPrefix
public String getURIPrefix()(Code)
Get the prefix of the URI in progress



getView
public String getView()(Code)
Returns the request view



globalRedirect
public void globalRedirect(boolean sessionmode, String newURL) throws IOException(Code)



hasAttribute
protected boolean hasAttribute(String name)(Code)



initComponents
protected void initComponents()(Code)
Initialize the components for the environment This gets the source resolver and the xmlizer component



isInternalRedirect
public boolean isInternalRedirect()(Code)



isResponseModified
public 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



release
public void release(org.apache.excalibur.source.Source source)(Code)
Releases a resolved resource



removeAttribute
public void removeAttribute(String name)(Code)



resolve
public Source resolve(String systemId) throws ProcessingException, SAXException, IOException(Code)
Resolve an entity.



resolveURI
public org.apache.excalibur.source.Source resolveURI(String location) throws MalformedURLException, IOException, SourceException(Code)
Get a Source object.



resolveURI
public org.apache.excalibur.source.Source resolveURI(String location, String baseURI, Map parameters) throws MalformedURLException, IOException, SourceException(Code)
Get a Source object.



setAction
protected void setAction(String action)(Code)
Allow implementations to set action later than in super() constructor Action can be set only once, and should be set in implementation's constructor.



setAttribute
public void setAttribute(String name, Object value)(Code)



setContext
protected void setContext(String context)(Code)
Set the context.



setContext
public void setContext(String prefix, String uri, String context)(Code)
Set the context. This is similar to changeContext() except that it is absolute.



setResponseIsNotModified
public void setResponseIsNotModified()(Code)
Mark the response as not modified.



setStatus
public void setStatus(int statusCode)(Code)
Set a status code



setURIPrefix
protected void setURIPrefix(String prefix)(Code)
Set the prefix of the URI in progress



setView
protected void setView(String view)(Code)
Allow implementations to set view later than in super() constructor. View can be set only once, and should be set in implementation's constructor.



startingProcessing
public void startingProcessing()(Code)
Notify that the processing starts.



tryResetResponse
public 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. true if the response was successfully reset



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.