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

Modelklasse für Daten welche innerhalb eines Servlet-Response behandelt werden können

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)
ServletResponse(EResponseType type)
ServletResponse(EResponseType type, long longValue)
ServletResponse(EResponseType type, String value)
ServletResponse(EResponseType type, String value, byte[] binValue)
ServletResponse(EResponseType type, String value, byte[] binValue, boolean forceDownload)

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 IServletResponse.getType() is set to EResponseType.SHOW_FILE:
String	getEncoding()	Applies only when IServletResponse.getType() is set to EResponseType.TEMPLATE, EResponseType.TEMPLATE_SYSTEM, or EResponseType.HTML.
Map<String,String>	getHttpHeader()
int	getHttpStatusCode()
long	getLongValue()	Returns an long value.
Map<String,Serializable>	getSessionAttributes()
EResponseType	getType()
String	getValue()	The plain-text data of the response, used only when IServletResponse.getType() is not set to a binary response type or redirect.
boolean	isAppendFormSessionID()
boolean	isForceDownload()	Applies only when IServletResponse.getType() is set to EResponseType.SHOW_FILE.
void	setAppendFormSessionID(boolean appendFormSessionID)
void	setBinValue(byte[] binValue)	Setter des byteValue
void	setContentType(String contentType)
void	setEncoding(String encoding)
void	setForceDownload(boolean forceDownload)
void	setHttpHeader(Map<String,String> httpHeader)
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)

ServletResponse

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

ServletResponse

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

ServletResponse

public ServletResponse(EResponseType type,
                       String value)

ServletResponse

public ServletResponse(EResponseType type,
                       long longValue)

ServletResponse

public ServletResponse(EResponseType type)

Method Detail

getValue

public String getValue()

Description copied from interface: IServletResponse

The plain-text data of the response, used only when IServletResponse.getType() is not set to a binary response type or redirect.

Specified by:

getValue in interface IServletResponse

Returns:

The plain-text content of the HTTP response.

setValue

public void setValue(String value)

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)

getBinValue

public byte[] getBinValue()

Description copied from interface: IServletResponse

The binary data for the response. Applies only when IServletResponse.getType() is set to EResponseType.SHOW_FILE.

Specified by:

getBinValue in interface IServletResponse

Returns:

The binary content of the HTTP response.

setBinValue

public void setBinValue(byte[] binValue)

Setter des byteValue

Parameters:

binValue - Byte-Array der zu setzende binValue

isForceDownload

public boolean isForceDownload()

Description copied from interface: IServletResponse

Applies only when IServletResponse.getType() is set to EResponseType.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)

getEncoding

public String getEncoding()

Description copied from interface: IServletResponse

Applies only when IServletResponse.getType() is set to EResponseType.TEMPLATE, EResponseType.TEMPLATE_SYSTEM, or EResponseType.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)

setAppendFormSessionID

public void setAppendFormSessionID(boolean appendFormSessionID)

isAppendFormSessionID

public boolean isAppendFormSessionID()

getLongValue

public long getLongValue()

Description copied from interface: IServletResponse

Returns an long value. If EResponseType.FORM_RECORD is set, this is the id of the record.

Specified by:

getLongValue in interface IServletResponse

Returns:

an long value

setLongValue

public void setLongValue(long longValue)

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)

getContentType

public String getContentType()

Description copied from interface: IServletResponse

Applies only when IServletResponse.getType() is set to EResponseType.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)

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)

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)

Parameters:

httpHeader - the httpHeader to set

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.