com.agapsys.rcf

Class HttpObjectSerializer

java.lang.Object

com.agapsys.rcf.HttpObjectSerializer

Direct Known Subclasses:

JsonHttpSerializer

public abstract class HttpObjectSerializer
extends Object

Serializer/Deserializer of objects in HTTP communication

Author:

Leandro Oliveira (leandro@agapsys.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpObjectSerializer.SerializerException

Constructor Summary

Constructors

Constructor and Description
HttpObjectSerializer()

Method Summary

Modifier and Type	Method and Description
abstract String	getCharset() Returns the charset used by this serializer.
abstract String	getContentType() Returns the content-type used by this serializer.
<T> T	readObject(javax.servlet.http.HttpServletRequest req, Class<T> targetClass) Return an object sent from client (contained in the request).
abstract <T> T	readObject(InputStream inputStream, String charset, Class<T> targetClass)
abstract String	toString(Object obj) Returns the string representation of an object.
void	writeObject(javax.servlet.http.HttpServletResponse resp, Object object) Sends given object to the client (contained in the response).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HttpObjectSerializer

public HttpObjectSerializer()

Method Detail

getContentType

public abstract String getContentType()

Returns the content-type used by this serializer.

Returns:

the content-type used by this serializer.

getCharset

public abstract String getCharset()

Returns the charset used by this serializer.

Returns:

the charset used by this serializer.

readObject

public final <T> T readObject(javax.servlet.http.HttpServletRequest req,
                              Class<T> targetClass)
                       throws BadRequestException,
                              IOException

Return an object sent from client (contained in the request).

Type Parameters:

T - Type of the returned object.

Parameters:

req - HTTP request.

targetClass - class of returned object.

Returns:

an instance of given target class.

Throws:

BadRequestException - if it was not possible to retrieve an object instance from given request.

IOException - if an error happened during the operation.

readObject

public abstract <T> T readObject(InputStream inputStream,
                                 String charset,
                                 Class<T> targetClass)
                          throws HttpObjectSerializer.SerializerException,
                                 IOException

Type Parameters:

T - Type of the returned object

Parameters:

inputStream - input stream

targetClass - class of returned object

charset - charset

Returns:

an instance of given target class

Throws:

HttpObjectSerializer.SerializerException - if it was not possible to retrieve an object instance from given input stream

IOException - if an error happened during the operation

writeObject

public final void writeObject(javax.servlet.http.HttpServletResponse resp,
                              Object object)
                       throws IOException

Sends given object to the client (contained in the response).

Parameters:

resp - HTTP response

object - object to be sent

Throws:

IOException - if an error happened during the operation

toString

public abstract String toString(Object obj)

Returns the string representation of an object.

Parameters:

obj - object to be converted.

Returns:

the string representation of given object.