Java Doc for Response.java in  » Web-Framework » rife-1.6.1 » com » uwyn » rife » engine » 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 » Web Framework » rife 1.6.1 » com.uwyn.rife.engine 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


com.uwyn.rife.engine.Response

All known Subclasses:   com.uwyn.rife.engine.AbstractResponse,
Response
public interface Response (Code)
This interface contains all the methods that the web engine needs to be able to send a response to the client.
author:
   Geert Bevin (gbevin[remove] at uwyn dot com)
version:
   $Revision: 3634 $
since:
   1.1




Method Summary
public  voidaddCookie(Cookie cookie)
     See HttpServletResponse.addCookie(Cookie) .
public  voidaddDateHeader(String name, long date)
     See HttpServletResponse.addDateHeader(Stringlong) .
public  voidaddHeader(String name, String value)
     See HttpServletResponse.addHeader(StringString) .
public  voidaddIntHeader(String name, int integer)
     See HttpServletResponse.addIntHeader(Stringint) .
public  voidclearBuffer()
     Clears the text buffer is it's enabled.
public  voidclose()
     Closed the content output stream.
public  booleancontainsHeader(String name)
     See HttpServletResponse.containsHeader(String) .
public  ResponsecreateEmbeddedResponse(String valueId, String differentiator)
     Creates a new Response instance that will be used for embedded elements.
public  voidenableTextBuffer(boolean enabled)
     Enables or disabled the text output buffer.
public  StringencodeURL(String url)
     See HttpServletResponse.encodeURL(String) .
public  voidflush()
     Forces all the streamed content to be output to the client.
public  StringgetCharacterEncoding()
     See HttpServletResponse.getCharacterEncoding .
public  StringgetContentType()
     Retrieves the content type that was explicitly set for this response.
public  ArrayList<CharSequence>getEmbeddedContent()
     Retrieves the content of the response for embedded usage and integration into another response.
public  HttpServletResponsegetHttpServletResponse()
     Retrieves the underlying HttpServletResponse .
public  LocalegetLocale()
     See HttpServletResponse.getLocale .
public  OutputStreamgetOutputStream()
     See HttpServletResponse.getOutputStream .
public  PrintWritergetWriter()
     See HttpServletResponse.getWriter .
public  booleanisContentTypeSet()
     Indicates whether this response's content type has been explicitly set.
public  booleanisEmbedded()
     Indicates whether this response is embedded into another response.
public  booleanisTextBufferEnabled()
     Indicates whether the text output buffer is enabled.
public  voidprint(Template template)
     Prints the content of a template to the request text output.
public  voidprint(Collection<CharSequence> deferredContent)
     Prints a list of text snippets to the request text output.
public  voidprint(Object value)
     Prints the string representation of an object to the request text output.
public  voidsendError(int statusCode)
     See HttpServletResponse.sendError(int) .
public  voidsendError(int statusCode, String message)
     See HttpServletResponse.sendError(intString) .
public  voidsendRedirect(String location)
     See HttpServletResponse.sendRedirect(String) .
public  voidsetContentLength(int length)
     See HttpServletResponse.setContentLength(int) .
public  voidsetContentType(String contentType)
     See HttpServletResponse.setContentType(String) .
public  voidsetDateHeader(String name, long date)
     See HttpServletResponse.setDateHeader(Stringlong) .
public  voidsetHeader(String name, String value)
     See HttpServletResponse.setHeader(StringString) .
public  voidsetIntHeader(String name, int value)
     See HttpServletResponse.setIntHeader(Stringint) .
public  voidsetLastElement(ElementSupport element)
     Sets the latest target element of this response.
public  voidsetLocale(Locale locale)
     See HttpServletResponse.setLocale(Locale) .
public  voidsetStatus(int statusCode)
     See HttpServletResponse.setStatus(int) .



Method Detail
addCookie
public void addCookie(Cookie cookie)(Code)
See HttpServletResponse.addCookie(Cookie) .
since:
   1.1



addDateHeader
public void addDateHeader(String name, long date)(Code)
See HttpServletResponse.addDateHeader(Stringlong) .
since:
   1.1



addHeader
public void addHeader(String name, String value)(Code)
See HttpServletResponse.addHeader(StringString) .
since:
   1.1



addIntHeader
public void addIntHeader(String name, int integer)(Code)
See HttpServletResponse.addIntHeader(Stringint) .
since:
   1.1



clearBuffer
public void clearBuffer()(Code)
Clears the text buffer is it's enabled.

If the text buffer is disabled, this method does nothing.
since:
   1.1




close
public void close() throws EngineException(Code)
Closed the content output stream.

All content is Response.flush flushed first.
since:
   1.1




containsHeader
public boolean containsHeader(String name)(Code)
See HttpServletResponse.containsHeader(String) .
since:
   1.1



createEmbeddedResponse
public Response createEmbeddedResponse(String valueId, String differentiator)(Code)
Creates a new Response instance that will be used for embedded elements.
Parameters:
  valueId - the template value in which the embedded element willbe processed
Parameters:
  differentiator - the embedded element differentiator the new Response instance for embedded use
since:
   1.5



enableTextBuffer
public void enableTextBuffer(boolean enabled)(Code)
Enables or disabled the text output buffer.

The buffer is enabled by default and its buffered contents will be flushed when the buffer is disabled.
Parameters:
  enabled - true to enable the text buffer; or

false to disable it
since:
   1.1




encodeURL
public String encodeURL(String url)(Code)
See HttpServletResponse.encodeURL(String) .
since:
   1.1



flush
public void flush() throws EngineException(Code)
Forces all the streamed content to be output to the client.

If the text buffer is enabled, this will flush its content to the output stream first.
since:
   1.1




getCharacterEncoding
public String getCharacterEncoding()(Code)
See HttpServletResponse.getCharacterEncoding .
since:
   1.1



getContentType
public String getContentType()(Code)
Retrieves the content type that was explicitly set for this response. the content type as a String; or

null if the content type wasn't set
See Also:   Response.setContentType
since:
   1.5.1




getEmbeddedContent
public ArrayList<CharSequence> getEmbeddedContent()(Code)
Retrieves the content of the response for embedded usage and integration into another response. the embedded content; or

null if the response is not embedded.
since:
   1.1




getHttpServletResponse
public HttpServletResponse getHttpServletResponse()(Code)
Retrieves the underlying HttpServletResponse . the underlying HttpServletResponse instance; or

null if this response isn't backed byHttpServletResponse
since:
   1.1




getLocale
public Locale getLocale()(Code)
See HttpServletResponse.getLocale .
since:
   1.1



getOutputStream
public OutputStream getOutputStream() throws EngineException(Code)
See HttpServletResponse.getOutputStream .
since:
   1.1



getWriter
public PrintWriter getWriter() throws IOException(Code)
See HttpServletResponse.getWriter .
since:
   1.1



isContentTypeSet
public boolean isContentTypeSet()(Code)
Indicates whether this response's content type has been explicitly set. true if it has been set; or

false otherwise
See Also:   Response.setContentType
since:
   1.3




isEmbedded
public boolean isEmbedded()(Code)
Indicates whether this response is embedded into another response. true if the response is embedded; or

false otherwise.
since:
   1.1




isTextBufferEnabled
public boolean isTextBufferEnabled()(Code)
Indicates whether the text output buffer is enabled. true when the text buffer is enabled; or

false when it is disabled.
since:
   1.1




print
public void print(Template template) throws EngineException(Code)
Prints the content of a template to the request text output.
Parameters:
  template - the template that will be printed
exception:
  com.uwyn.rife.engine.exceptions.EngineException - if an erroroccurs during the output of the template content
See Also:   Response.print(Collection)
See Also:   Response.print(Object)
since:
   1.1



print
public void print(Collection<CharSequence> deferredContent) throws EngineException(Code)
Prints a list of text snippets to the request text output.
Parameters:
  deferredContent - the text snippets that will be printed
exception:
  com.uwyn.rife.engine.exceptions.EngineException - if an erroroccurs during the output of the text snippets
See Also:   Response.print(Template)
See Also:   Response.print(Object)
since:
   1.1



print
public void print(Object value) throws EngineException(Code)
Prints the string representation of an object to the request text output. The string representation will be created through a String.valueOf(value) call.
Parameters:
  value - the object that will be output
exception:
  com.uwyn.rife.engine.exceptions.EngineException - if an erroroccurs during the output of the content
See Also:   Response.print(Template)
See Also:   Response.print(Collection)
since:
   1.1



sendError
public void sendError(int statusCode) throws EngineException(Code)
See HttpServletResponse.sendError(int) .
since:
   1.1



sendError
public void sendError(int statusCode, String message) throws EngineException(Code)
See HttpServletResponse.sendError(intString) .
since:
   1.1



sendRedirect
public void sendRedirect(String location) throws EngineException(Code)
See HttpServletResponse.sendRedirect(String) .
since:
   1.1



setContentLength
public void setContentLength(int length) throws EngineException(Code)
See HttpServletResponse.setContentLength(int) .
since:
   1.1



setContentType
public void setContentType(String contentType)(Code)
See HttpServletResponse.setContentType(String) .
since:
   1.1



setDateHeader
public void setDateHeader(String name, long date)(Code)
See HttpServletResponse.setDateHeader(Stringlong) .
since:
   1.1



setHeader
public void setHeader(String name, String value)(Code)
See HttpServletResponse.setHeader(StringString) .
since:
   1.1



setIntHeader
public void setIntHeader(String name, int value)(Code)
See HttpServletResponse.setIntHeader(Stringint) .
since:
   1.1



setLastElement
public void setLastElement(ElementSupport element)(Code)
Sets the latest target element of this response. This method is called repeatedly by the engine to make it possible to trace which elements have been processed.
Parameters:
  element - an element that has been executed in the context of thisresponse
since:
   1.1



setLocale
public void setLocale(Locale locale)(Code)
See HttpServletResponse.setLocale(Locale) .
since:
   1.1



setStatus
public void setStatus(int statusCode)(Code)
See HttpServletResponse.setStatus(int) .
since:
   1.1



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