Package de.xima.fc.mdl.response

Class ServletResponse

java.lang.Object

de.xima.fc.mdl.response.ServletResponse

All Implemented Interfaces:

IServletResponse, Serializable

Direct Known Subclasses:

WorkflowResponse

public class ServletResponse
extends Object
implements IServletResponse

Default POJO implementation of IServletResponse.

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	appendFormSessionId
protected byte[]	binValue
protected String	contentType
protected String	encoding
protected boolean	forceDownload
protected Map<String,String>	httpHeader
protected int	httpStatusCode
protected long	longValue
protected Map<String,Serializable>	sessionAttributes
protected EResponseType	type
protected String	value

Constructor Summary

Constructors

Constructor	Description
ServletResponse(IServletResponse response)	Creates a new servlet response with all data copied from a given response.
ServletResponse(EResponseType type)	Creates a new servlet response without any content.
ServletResponse(EResponseType type, long longValue)	Creates a new servlet response with a single numerical response.
ServletResponse(EResponseType type, String value)	Creates a new servlet response with plain text response.
ServletResponse(EResponseType type, String value, byte[] binValue)	Creates a new servlet response with binary response.
ServletResponse(EResponseType type, String value, byte[] binValue, boolean forceDownload)	Creates a new servlet response with binary response.

Method Summary

Modifier and Type	Method	Description
void	addHttpHeader(String name, String value)	Adds an HTTP header with the given name.
byte[]	getBinValue()	The binary data for the response.
String	getContentType()	Applies only when type is set to SHOW_FILE:
String	getEncoding()	Applies only when type is set to TEMPLATE, TEMPLATE_SYSTEM, or HTML.
Map<String,String>	getHttpHeader()
int	getHttpStatusCode()
long	getLongValue()	Applies only when type is set to FORM_RECORD is set, this is the ID of the form record to which to redirect.
Map<String,Serializable>	getSessionAttributes()
EResponseType	getType()
String	getValue()	When type is set to a binary response type (e.g.
boolean	isAppendFormSessionID()	Deprecated. Does not have any effect anymore.
boolean	isForceDownload()	Applies only when type is set to SHOW_FILE.
void	setAppendFormSessionID(boolean appendFormSessionID)	Deprecated. Does not have any effect anymore.
void	setBinValue(byte[] binValue)
void	setContentType(String contentType)
void	setEncoding(String encoding)
void	setForceDownload(boolean forceDownload)
void	setHttpHeader(Map<String,String> httpHeader)	Removes all existing headers and sets a new map of HTTP headers to send with the response.
void	setHttpStatusCode(int httpStatusCode)
void	setLongValue(long longValue)
void	setSessionAttributes(Map<String,Serializable> sessionAttributes)
void	setType(EResponseType type)
void	setValue(String value)

Methods inherited from class java.lang.Object

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

Field Detail

value

protected String value

longValue

protected long longValue

contentType

protected String contentType

sessionAttributes

protected Map<String,Serializable> sessionAttributes

httpHeader

protected Map<String,String> httpHeader

encoding

protected String encoding

binValue

protected byte[] binValue

type

protected EResponseType type

forceDownload

protected boolean forceDownload

appendFormSessionId

protected boolean appendFormSessionId

httpStatusCode

protected int httpStatusCode

Constructor Detail

ServletResponse

public ServletResponse(IServletResponse response)

Creates a new servlet response with all data copied from a given response. Can be used to modify a servlet response.

Parameters:

response - An existing servlet response from which to copy the data.

ServletResponse

public ServletResponse(EResponseType type,
                       String value,
                       byte[] binValue,
                       boolean forceDownload)

Creates a new servlet response with binary response.

Parameters:

type - The value for IServletResponse.getType().

value - The value for IServletResponse.getValue(), the name of the file.

binValue - The value for IServletResponse.getBinValue(), the content of the file.

forceDownload - The value for IServletResponse.isForceDownload().

ServletResponse

public ServletResponse(EResponseType type,
                       String value,
                       byte[] binValue)

Creates a new servlet response with binary response.

Parameters:

type - The value for IServletResponse.getType().

value - The value for IServletResponse.getValue(), the name of the file.

binValue - The value for IServletResponse.getBinValue(), the content of the file.

ServletResponse

public ServletResponse(EResponseType type,
                       String value)

Creates a new servlet response with plain text response.

Parameters:

type - The value for IServletResponse.getType().

value - The value for IServletResponse.getValue(), the content of the file or the redirect URL.

ServletResponse

public ServletResponse(EResponseType type,
                       long longValue)

Creates a new servlet response with a single numerical response.

Parameters:

type - The value for IServletResponse.getType().

longValue - The value for IServletResponse.getLongValue(), e.g. the form record ID when the type is FORM_RECORD.

ServletResponse

public ServletResponse(EResponseType type)

Creates a new servlet response without any content.

Parameters:

type - The value for IServletResponse.getType().

Method Detail

getValue

public String getValue()

Description copied from interface: IServletResponse

When type is set to a binary response type (e.g. SHOW_FILE), the file name of the returned file.

When type is set to a non-binary response (e.g. JSON), the plain-text content of the response.

When type is set to REDIRECT, the URL to which to redirect.

Specified by:

getValue in interface IServletResponse

Returns:

The plain-text content of the HTTP response.

setValue

public void setValue(String value)

Parameters:

value - The new value for IServletResponse.getValue().

getType

public EResponseType getType()

Specified by:

getType in interface IServletResponse

Returns:

The type of response, such as whether a plain text or binary file should be returned, or a redirect should be performed.

setType

public void setType(EResponseType type)

Parameters:

type - The new value for IServletResponse.getType().

getBinValue

public byte[] getBinValue()

Description copied from interface: IServletResponse

The binary data for the response. Applies only when type is set to SHOW_FILE.

Specified by:

getBinValue in interface IServletResponse

Returns:

The binary content of the HTTP response.

setBinValue

public void setBinValue(byte[] binValue)

Parameters:

binValue - The new value for IServletResponse.getBinValue().

isForceDownload

public boolean isForceDownload()

Description copied from interface: IServletResponse

Applies only when type is set to SHOW_FILE.

Specified by:

isForceDownload in interface IServletResponse

Returns:

If true, attempts to prevent browsers from showing the binary content inline. If false, the browser may show the content inline, which is useful for PDF, image or plain text files. Please note that support for this differs between browsers.

setForceDownload

public void setForceDownload(boolean forceDownload)

Parameters:

forceDownload - The new value for IServletResponse.isForceDownload().

getEncoding

public String getEncoding()

Description copied from interface: IServletResponse

Applies only when type is set to TEMPLATE, TEMPLATE_SYSTEM, or HTML.

Specified by:

getEncoding in interface IServletResponse

Returns:

The encoding that is to be used for encoding the response.

setEncoding

public void setEncoding(String encoding)

Parameters:

encoding - The new value for IServletResponse.getEncoding().

setAppendFormSessionID

@Deprecated
public void setAppendFormSessionID(boolean appendFormSessionID)

Deprecated.

Does not have any effect anymore.

Parameters:

appendFormSessionID - The new value that is returned by isAppendFormSessionID().

isAppendFormSessionID

@Deprecated
public boolean isAppendFormSessionID()

Deprecated.

Does not have any effect anymore.

Returns:

Returns the boolean flag as set by setAppendFormSessionID(boolean).

getLongValue

public long getLongValue()

Description copied from interface: IServletResponse

Applies only when type is set to FORM_RECORD is set, this is the ID of the form record to which to redirect.

Specified by:

getLongValue in interface IServletResponse

Returns:

The long value content for the response.

setLongValue

public void setLongValue(long longValue)

Parameters:

longValue - The new value for IServletResponse.getLongValue().

getHttpStatusCode

public int getHttpStatusCode()

Specified by:

getHttpStatusCode in interface IServletResponse

Returns:

The HTTP status code of the HTTP response.

setHttpStatusCode

public void setHttpStatusCode(int httpStatusCode)

Parameters:

httpStatusCode - The new value for IServletResponse.getHttpStatusCode().

getContentType

public String getContentType()

Description copied from interface: IServletResponse

Applies only when type is set to SHOW_FILE:

Must return the content type (=mime type) that is to be sent along with the binary data. When this is either null or blank, an attempt is made to guess the content type from the binary data. Please note that this may fail to determine the actual content type, you should always provide a content type.

Specified by:

getContentType in interface IServletResponse

Returns:

The content type of the binary data.

setContentType

public void setContentType(String contentType)

Parameters:

contentType - The new value for IServletResponse.getContentType().

getSessionAttributes

public Map<String,Serializable> getSessionAttributes()

Specified by:

getSessionAttributes in interface IServletResponse

Returns:

A Map with attributes that should be written to the HttpSession. Existing values in the HttpSession are overwritten.

setSessionAttributes

public void setSessionAttributes(Map<String,Serializable> sessionAttributes)

Parameters:

sessionAttributes - The new value for IServletResponse.getSessionAttributes().

getHttpHeader

public Map<String,String> getHttpHeader()

Specified by:

getHttpHeader in interface IServletResponse

Returns:

A Map of HTTP headers that should be sent along with the HTTP response.

setHttpHeader

public void setHttpHeader(Map<String,String> httpHeader)

Removes all existing headers and sets a new map of HTTP headers to send with the response.

Parameters:

httpHeader - The new value for IServletResponse.getHttpHeader().

addHttpHeader

public void addHttpHeader(String name,
                          String value)

Adds an HTTP header with the given name. When a value exists already for that name, it is overwritten.

Parameters:

name - Name of the header.

value - Value of the header.