er.rest.format

Class ERXRestWriter

java.lang.Object

er.rest.format.ERXRestWriter

All Implemented Interfaces:

IERXRestWriter

Direct Known Subclasses:

ERXBinaryPListRestWriter, ERXJSONRestWriter, ERXPListRestWriter, ERXXmlRestWriter

public abstract class ERXRestWriter
extends Object
implements IERXRestWriter

Field Summary

Fields

Modifier and Type	Field and Description
protected String	contentEncoding
protected static String	ContentTypeHeaderKey The HTTP header key for the content type.
protected static String	TheDefaultResponseEncoding The default character encoding for the REST responses.

Constructor Summary

Constructors

Constructor and Description
ERXRestWriter()

Method Summary

Modifier and Type	Method and Description
void	appendHeadersToResponse(ERXRestRequestNode node, IERXRestResponse response, ERXRestContext context) Called at the end of a request to produce the output to the user.
String	contentEncoding() The character encoding to use for this REST response.
abstract String	contentType() The corresponding HTTP header content type for this REST response.
protected String	contentTypeHeaderValue() The value to be used for the content type HTTP header.
static String	defaultEncoding() The default character encoding to use for REST responses.
void	setContentEncoding(String encoding) Lets you specify the content's character encoding to be used for this REST response.
static void	setDefaultEncoding(String encoding) Lets you specify the default character encoding to be used for REST responses.

Methods inherited from class java.lang.Object

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

Methods inherited from interface er.rest.format.IERXRestWriter

appendToResponse

Field Detail

ContentTypeHeaderKey

protected static final String ContentTypeHeaderKey

The HTTP header key for the content type.

See Also:

Constant Field Values

TheDefaultResponseEncoding

protected static String TheDefaultResponseEncoding

The default character encoding for the REST responses.

contentEncoding

protected String contentEncoding

Constructor Detail

ERXRestWriter

public ERXRestWriter()

Method Detail

appendHeadersToResponse

public void appendHeadersToResponse(ERXRestRequestNode node,
                                    IERXRestResponse response,
                                    ERXRestContext context)

Description copied from interface: IERXRestWriter

Called at the end of a request to produce the output to the user.

Specified by:

appendHeadersToResponse in interface IERXRestWriter

Parameters:

node - the node to render

response - the response to write into

context - the REST context

defaultEncoding

public static String defaultEncoding()

The default character encoding to use for REST responses. The default value for this is UTF-8.

Returns:

the default character encoding

setDefaultEncoding

public static void setDefaultEncoding(String encoding)

Lets you specify the default character encoding to be used for REST responses.

Parameters:

encoding - the default character encoding

contentEncoding

public String contentEncoding()

The character encoding to use for this REST response.

Returns:

the content's character encoding

setContentEncoding

public void setContentEncoding(String encoding)

Lets you specify the content's character encoding to be used for this REST response.

Parameters:

encoding - the content's character encoding

contentType

public abstract String contentType()

The corresponding HTTP header content type for this REST response.

Returns:

content type

contentTypeHeaderValue

protected String contentTypeHeaderValue()

The value to be used for the content type HTTP header.

Returns:

content type header value