Java Doc for WrapperResponse.java in  » Web-Services » restlet-1.0.8 » org » restlet » util » 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 Services » restlet 1.0.8 » org.restlet.util 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.restlet.data.Response
   org.restlet.util.WrapperResponse

WrapperResponse
public class WrapperResponse extends Response (Code)
Request wrapper. Useful for application developer who need to enrich the request with application related properties and behavior.
See Also:    The decorator (aka * wrapper) pattern
author:
   Jerome Louvel (contact@noelios.com)



Constructor Summary
public  WrapperResponse(Response wrappedResponse)
     Constructor.

Method Summary
public  Set<Method>getAllowedMethods()
     Returns the set of methods allowed on the requested resource.
public  Map<String, Object>getAttributes()
     Returns a modifiable attributes map that can be used by developers to save information relative to the message.
public  ChallengeRequestgetChallengeRequest()
     Returns the authentication request sent by an origin server to a client.
public  Series<CookieSetting>getCookieSettings()
     Returns the cookie settings provided by the server.
public  Set<Dimension>getDimensions()
     Returns the set of selecting dimensions on which the response entity may vary.
public  RepresentationgetEntity()
     Returns the entity representation.
public  DomRepresentationgetEntityAsDom()
     Returns the entity as a DOM representation.
Note that this triggers the parsing of the entity into a reusable DOM document stored in memory.
This method and the related getEntity*() methods can only be invoked once.
public  FormgetEntityAsForm()
     Returns the entity as a DOM representation.
Note that this triggers the parsing of the entity into a reusable DOM document stored in memory.
This method and the related getEntity*() methods can only be invoked once.
public  ObjectgetEntityAsObject()
     Returns the entity as a higher-level object.
public  SaxRepresentationgetEntityAsSax()
     Returns the entity as a SAX representation.
Note that this kind of representation can only be parsed once.
public  ReferencegetRedirectRef()
     Returns the reference that the client should follow for redirections or resource creations.
public  RequestgetRequest()
    
public  ServerInfogetServerInfo()
     Returns the server-specific information.
public  StatusgetStatus()
     Returns the status.
protected  ResponsegetWrappedResponse()
     Returns the wrapped response.
public  booleanisEntityAvailable()
     Indicates if a content is available and can be sent.
public  voidredirectPermanent(Reference targetRef)
     Permanently redirects the client to a target URI.
public  voidredirectPermanent(String targetUri)
     Permanently redirects the client to a target URI.
public  voidredirectSeeOther(Reference targetRef)
     Redirects the client to a different URI that SHOULD be retrieved using a GET method on that resource.
public  voidredirectSeeOther(String targetUri)
     Redirects the client to a different URI that SHOULD be retrieved using a GET method on that resource.
public  voidredirectTemporary(Reference targetRef)
     Temporarily redirects the client to a target URI.
public  voidredirectTemporary(String targetUri)
     Temporarily redirects the client to a target URI.
public  voidsetChallengeRequest(ChallengeRequest request)
     Sets the authentication request sent by an origin server to a client.
public  voidsetEntity(Object object)
     Sets the entity from a higher-level object.
public  voidsetEntity(Representation entity)
     Sets the entity representation.
public  voidsetEntity(String value, MediaType mediaType)
     Sets a textual entity.
public  voidsetRedirectRef(Reference redirectRef)
     Sets the reference that the client should follow for redirections or resource creations.
public  voidsetRedirectRef(String redirectUri)
     Sets the reference that the client should follow for redirections or resource creations.
public  voidsetRequest(WrapperRequest request)
     Sets the associated request.
public  voidsetRequest(Request request)
     Sets the associated request.
public  voidsetStatus(Status status)
     Sets the status.
public  voidsetStatus(Status status, String message)
     Sets the status.


Constructor Detail
WrapperResponse
public WrapperResponse(Response wrappedResponse)(Code)
Constructor.
Parameters:
  wrappedResponse - The wrapped response.




Method Detail
getAllowedMethods
public Set<Method> getAllowedMethods()(Code)
Returns the set of methods allowed on the requested resource. This property only has to be updated when a status CLIENT_ERROR_METHOD_NOT_ALLOWED is set. The list of allowed methods.



The modifiable attributes map.
getAttributes
public Map<String, Object> getAttributes()(Code)
Returns a modifiable attributes map that can be used by developers to save information relative to the message. This is an easier alternative to the creation of a wrapper instance around the whole message.

In addition, this map is a shared space between the developer and the connectors. In this case, it is used to exchange information that is not uniform across all protocols and couldn't therefore be directly included in the API. For this purpose, all attribute names starting with "org.restlet" are reserved. Currently the following attributes are used:
Attribute name Class name Description
org.restlet.http.headers org.restlet.data.Form Server HTTP connectors must provide all request headers and client HTTP connectors must provide all response headers, exactly as they were received. In addition, developers can also use this attribute to specify non-standard headers that should be added to the request or to the response.
Adding standard HTTP headers is forbidden because it could conflict with the connector's internal behavior, limit portability or prevent future optimizations.



getChallengeRequest
public ChallengeRequest getChallengeRequest()(Code)
Returns the authentication request sent by an origin server to a client. The authentication request sent by an origin server to a client.



getCookieSettings
public Series<CookieSetting> getCookieSettings()(Code)
Returns the cookie settings provided by the server. The cookie settings provided by the server.



getDimensions
public Set<Dimension> getDimensions()(Code)
Returns the set of selecting dimensions on which the response entity may vary. If some server-side content negotiation is done, this set should be properly updated, other it can be left empty. The set of dimensions on which the response entity may vary.



getEntity
public Representation getEntity()(Code)
Returns the entity representation. The entity representation.



getEntityAsDom
public DomRepresentation getEntityAsDom()(Code)
Returns the entity as a DOM representation.
Note that this triggers the parsing of the entity into a reusable DOM document stored in memory.
This method and the related getEntity*() methods can only be invoked once. The entity as a DOM representation.



getEntityAsForm
public Form getEntityAsForm()(Code)
Returns the entity as a DOM representation.
Note that this triggers the parsing of the entity into a reusable DOM document stored in memory.
This method and the related getEntity*() methods can only be invoked once. The entity as a DOM representation.



getEntityAsObject
public Object getEntityAsObject()(Code)
Returns the entity as a higher-level object. This object is created by the Application's converter service. If you want to use this method to facilitate the processing of request entities, you need to provide a custom implementation of the ConverterService class, overriding the toObject(Representation) method.
Note that this triggers the parsing of the entity.
This method and the related getEntity*() methods can only be invoked once. The entity as a higher-level object.



getEntityAsSax
public SaxRepresentation getEntityAsSax()(Code)
Returns the entity as a SAX representation.
Note that this kind of representation can only be parsed once. If you evaluate an XPath expression, it can also only be done once. If you need to reuse the entity multiple times, consider using the getEntityAsDom() method instead. The entity as a SAX representation.



getRedirectRef
public Reference getRedirectRef()(Code)
Returns the reference that the client should follow for redirections or resource creations. The redirection reference.



getRequest
public Request getRequest()(Code)
Returns the associated request The associated request



getServerInfo
public ServerInfo getServerInfo()(Code)
Returns the server-specific information. The server-specific information.



getStatus
public Status getStatus()(Code)
Returns the status. The status.



getWrappedResponse
protected Response getWrappedResponse()(Code)
Returns the wrapped response. The wrapped response.



isEntityAvailable
public boolean isEntityAvailable()(Code)
Indicates if a content is available and can be sent. Several conditions must be met: the content must exists and have some available data. True if a content is available and can be sent.



redirectPermanent
public void redirectPermanent(Reference targetRef)(Code)
Permanently redirects the client to a target URI. The client is expected to reuse the same method for the new request.
Parameters:
  targetRef - The target URI reference.



redirectPermanent
public void redirectPermanent(String targetUri)(Code)
Permanently redirects the client to a target URI. The client is expected to reuse the same method for the new request.
Parameters:
  targetUri - The target URI.



redirectSeeOther
public void redirectSeeOther(Reference targetRef)(Code)
Redirects the client to a different URI that SHOULD be retrieved using a GET method on that resource. This method exists primarily to allow the output of a POST-activated script to redirect the user agent to a selected resource. The new URI is not a substitute reference for the originally requested resource.
Parameters:
  targetRef - The target reference.



redirectSeeOther
public void redirectSeeOther(String targetUri)(Code)
Redirects the client to a different URI that SHOULD be retrieved using a GET method on that resource. This method exists primarily to allow the output of a POST-activated script to redirect the user agent to a selected resource. The new URI is not a substitute reference for the originally requested resource.
Parameters:
  targetUri - The target URI.



redirectTemporary
public void redirectTemporary(Reference targetRef)(Code)
Temporarily redirects the client to a target URI. The client is expected to reuse the same method for the new request.
Parameters:
  targetRef - The target reference.



redirectTemporary
public void redirectTemporary(String targetUri)(Code)
Temporarily redirects the client to a target URI. The client is expected to reuse the same method for the new request.
Parameters:
  targetUri - The target URI.



setChallengeRequest
public void setChallengeRequest(ChallengeRequest request)(Code)
Sets the authentication request sent by an origin server to a client.
Parameters:
  request - The authentication request sent by an origin server to aclient.



setEntity
public void setEntity(Object object)(Code)
Sets the entity from a higher-level object. This object is converted to a representation using the Application's converter service. If you want to use this method to facilitate the setting of entities, you need to provide a custom implementation of the ConverterService class, overriding the toRepresentation(Object) method.
Parameters:
  object - The higher-level object.



setEntity
public void setEntity(Representation entity)(Code)
Sets the entity representation.
Parameters:
  entity - The entity representation.



setEntity
public void setEntity(String value, MediaType mediaType)(Code)
Sets a textual entity.
Parameters:
  value - The represented string.
Parameters:
  mediaType - The representation's media type.



setRedirectRef
public void setRedirectRef(Reference redirectRef)(Code)
Sets the reference that the client should follow for redirections or resource creations.
Parameters:
  redirectRef - The redirection reference.



setRedirectRef
public void setRedirectRef(String redirectUri)(Code)
Sets the reference that the client should follow for redirections or resource creations.
Parameters:
  redirectUri - The redirection URI.



setRequest
public void setRequest(WrapperRequest request)(Code)
Sets the associated request.
Parameters:
  request - The associated request



setRequest
public void setRequest(Request request)(Code)
Sets the associated request.
Parameters:
  request - The associated request



setStatus
public void setStatus(Status status)(Code)
Sets the status.
Parameters:
  status - The status to set.



setStatus
public void setStatus(Status status, String message)(Code)
Sets the status.
Parameters:
  status - The status to set.
Parameters:
  message - The status message.



Methods inherited from org.restlet.data.Response
public Set<Method> getAllowedMethods()(Code)(Java Doc)
public ChallengeRequest getChallengeRequest()(Code)(Java Doc)
public Series<CookieSetting> getCookieSettings()(Code)(Java Doc)
public Set<Dimension> getDimensions()(Code)(Java Doc)
public Reference getRedirectRef()(Code)(Java Doc)
public Request getRequest()(Code)(Java Doc)
public ServerInfo getServerInfo()(Code)(Java Doc)
public Status getStatus()(Code)(Java Doc)
public void redirectPermanent(String targetUri)(Code)(Java Doc)
public void redirectPermanent(Reference targetRef)(Code)(Java Doc)
public void redirectSeeOther(String targetUri)(Code)(Java Doc)
public void redirectSeeOther(Reference targetRef)(Code)(Java Doc)
public void redirectTemporary(String targetUri)(Code)(Java Doc)
public void redirectTemporary(Reference targetRef)(Code)(Java Doc)
public void setChallengeRequest(ChallengeRequest request)(Code)(Java Doc)
public void setRedirectRef(Reference redirectRef)(Code)(Java Doc)
public void setRedirectRef(String redirectUri)(Code)(Java Doc)
public void setRequest(Request request)(Code)(Java Doc)
public void setStatus(Status status)(Code)(Java Doc)
public void setStatus(Status status, String message)(Code)(Java Doc)

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