org.restlet.gwt.data
Class Message

java.lang.Object
  extended by org.restlet.gwt.data.Message
Direct Known Subclasses:
Request, Response

public abstract class Message
extends java.lang.Object

Generic message exchanged between client and server connectors.

Author:
Jerome Louvel

Constructor Summary
Message()
          Constructor.
Message(Representation entity)
          Constructor.
 
Method Summary
 java.util.Map<java.lang.String,java.lang.Object> getAttributes()
          Returns the modifiable map of attributes that can be used by developers to save information relative to the message.
 Representation getEntity()
          Returns the entity representation.
 Form getEntityAsForm()
          Returns the entity as a form.
This method can be called several times and will always return the same form instance.
 JsonRepresentation getEntityAsJson()
          Returns the entity as a JSON representation.
This method can be called several times and will always return the same representation instance.
 XmlRepresentation getEntityAsXml()
          Returns the entity as a XML DOM representation.
This method can be called several times and will always return the same representation instance.
 boolean isEntityAvailable()
          Indicates if a content is available and can be sent.
 void release()
          Releases the message's entity.
 void setAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes)
          Sets the modifiable map of attributes
 void setEntity(Representation entity)
          Sets the entity representation.
 void setEntity(java.lang.String value, MediaType mediaType)
          Sets a textual entity.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Message

public Message()
Constructor.


Message

public Message(Representation entity)
Constructor.

Parameters:
entity - The payload of the message.
Method Detail

getAttributes

public java.util.Map<java.lang.String,java.lang.Object> getAttributes()
Returns the modifiable map of attributes that can be used by developers to save information relative to the message. Creates a new instance if no one has been set. 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.
org.restlet.https.clientCertificates List For requests received via a secure connector, indicates the ordered list of client certificates, if they are available and accessible.
Adding standard HTTP headers is forbidden because it could conflict with the connector's internal behavior, limit portability or prevent future optimizations.

Returns:
The modifiable attributes map.

getEntity

public Representation getEntity()
Returns the entity representation.

Returns:
The entity representation.

getEntityAsForm

public Form getEntityAsForm()
Returns the entity as a form.
This method can be called several times and will always return the same form instance. Note that if the entity is large this method can result in important memory consumption.

Returns:
The entity as a form.

getEntityAsJson

public JsonRepresentation getEntityAsJson()
Returns the entity as a JSON representation.
This method can be called several times and will always return the same representation instance. Note that if the entity is large this method can result in important memory consumption.

Returns:
The entity as a JSON representation.

getEntityAsXml

public XmlRepresentation getEntityAsXml()
Returns the entity as a XML DOM representation.
This method can be called several times and will always return the same representation instance. Note that if the entity is large this method can result in important memory consumption.

Returns:
The entity as a XML DOM representation.

isEntityAvailable

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

Returns:
True if a content is available and can be sent.

release

public void release()
Releases the message's entity. If the entity is transient and hasn't been read yet, all the remaining content will be discarded, any open socket, channel, file or similar source of content will be immediately closed.


setAttributes

public void setAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes)
Sets the modifiable map of attributes

Parameters:
attributes - The modifiable map of attributes

setEntity

public void setEntity(Representation entity)
Sets the entity representation.

Parameters:
entity - The entity representation.

setEntity

public void setEntity(java.lang.String value,
                      MediaType mediaType)
Sets a textual entity.

Parameters:
value - The represented string.
mediaType - The representation's media type.


Copyright © 2005-2008 Noelios Technologies.