org.gatein.pc.api.invocation.response

Class ContentResponse

java.lang.Object

org.gatein.pc.api.invocation.response.PortletInvocationResponse

org.gatein.pc.api.invocation.response.ContentResponse

Direct Known Subclasses:

FragmentResponse

public class ContentResponse
extends PortletInvocationResponse

Data produced.

Version:

$Revision: 5602 $

Author:

Julien Viet

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_BYTES .
static int	TYPE_CHARS .
static int	TYPE_EMPTY .

Constructor Summary

Constructors

Constructor and Description
ContentResponse(ContentResponse that, CacheControl cacheControl)
ContentResponse(ResponseProperties properties, Map<String,Object> attributes, String contentType, CacheControl cacheControl)
ContentResponse(ResponseProperties properties, Map<String,Object> attributes, String contentType, String encoding, byte[] bytes, CacheControl cacheControl)
ContentResponse(ResponseProperties properties, Map<String,Object> attributes, String contentType, String encoding, String chars, CacheControl cacheControl)

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getAttributes()
byte[]	getBytes() Return the bytes of the content held by the fragment.
CacheControl	getCacheControl()
String	getChars() Return the chars of the content held by the fragment.
String	getContent() Return the content as a string, when the character encoding is set, it will be used for binary content, otherwise the UTF-8 will be used.
String	getContent(Charset charset) Return the content as a string, the provided charset will be used for binary content.
String	getContentType() Return the content type of the generated fragment.
String	getEncoding()
ResponseProperties	getProperties()
int	getType()

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_EMPTY

public static final int TYPE_EMPTY

.

See Also:

Constant Field Values

TYPE_CHARS

public static final int TYPE_CHARS

.

See Also:

Constant Field Values

TYPE_BYTES

public static final int TYPE_BYTES

.

See Also:

Constant Field Values

Constructor Detail

ContentResponse

public ContentResponse(ResponseProperties properties,
                       Map<String,Object> attributes,
                       String contentType,
                       String encoding,
                       byte[] bytes,
                       CacheControl cacheControl)

ContentResponse

public ContentResponse(ResponseProperties properties,
                       Map<String,Object> attributes,
                       String contentType,
                       String encoding,
                       String chars,
                       CacheControl cacheControl)

ContentResponse

public ContentResponse(ResponseProperties properties,
                       Map<String,Object> attributes,
                       String contentType,
                       CacheControl cacheControl)

ContentResponse

public ContentResponse(ContentResponse that,
                       CacheControl cacheControl)

Method Detail

getEncoding

public String getEncoding()

getProperties

public ResponseProperties getProperties()

getCacheControl

public CacheControl getCacheControl()

getAttributes

public Map<String,Object> getAttributes()

getType

public int getType()

getContent

public String getContent()
                  throws UnsupportedCharsetException

Return the content as a string, when the character encoding is set, it will be used for binary content, otherwise the UTF-8 will be used.

Returns:

the content

Throws:

UnsupportedCharsetException - when the response encoding is not supported

getContent

public String getContent(Charset charset)

Return the content as a string, the provided charset will be used for binary content.

Returns:

the content

getBytes

public byte[] getBytes()
                throws IllegalArgumentException

Return the bytes of the content held by the fragment.

Returns:

the bytes

Throws:

IllegalArgumentException - if the type is not bytes

getChars

public String getChars()
                throws IllegalArgumentException

Return the chars of the content held by the fragment.

Returns:

the chars

Throws:

IllegalArgumentException - if the type is not chars

getContentType

public String getContentType()

Return the content type of the generated fragment.

Returns:

the content type