de.uplanet.lucy.server.connector

Interface IServerBridgeResponse

public interface IServerBridgeResponse

Version:

$Revision: 183106 $

Method Summary

Modifier and Type	Method and Description
void	addCookie(de.uplanet.net.http.ICookie p_cookie) Add a cookie to the response or replace a cookie in the response.
java.nio.charset.Charset	getCharset() Get this response's charset.
java.lang.String	getCharsetName() Get this response charset's name.
java.util.List<de.uplanet.net.http.ICookie>	getCookieList() Get a reference to the internal cookie list.
java.lang.String	getHeaderValue(java.lang.String p_strKey) Get a header info value to a specified key.
java.util.Map<java.lang.String,java.lang.String>	getHeaderValueMap() Get a reference to the internal header map.
java.io.OutputStream	getOutputStream() Get the socket output stream.
java.lang.String	getReasonPhrase() Deprecated.
int	getStatus() Get the HTTP status.
java.io.Writer	getWriter() Get a writer to the underlying output stream with the given charset.
void	setCharset(java.lang.String p_strCharsetName, java.nio.charset.Charset p_charset) Set this response's charset.
void	setHeaderValue(java.lang.String p_strKey, java.lang.String p_strValue) Set one name-value pair into the header map.
void	setStatus(int p_iStatus) Set the HTTP status and message.
void	setStatus(int p_iStatus, java.lang.String p_strReasonPhrase) Deprecated. Use setStatus(int) instead.

Method Detail

setStatus

void setStatus(int p_iStatus)

Set the HTTP status and message.

Parameters:

p_iStatus - The HTTP status code.

setStatus

@Deprecated
void setStatus(int p_iStatus,
                           java.lang.String p_strReasonPhrase)

Deprecated. Use setStatus(int) instead.

Set the HTTP status and message.

Parameters:

p_iStatus - The HTTP status code.

p_strReasonPhrase - The reason phrase.

getStatus

int getStatus()

Get the HTTP status.

Returns:

The HTTP status.

getReasonPhrase

@Deprecated
java.lang.String getReasonPhrase()

Deprecated.

Get the HTTP status reason phrase.

Note: This method is for internal use only. It must not be used in scripts.

Returns:

The HTTP status reason phrase.

setHeaderValue

void setHeaderValue(java.lang.String p_strKey,
                    java.lang.String p_strValue)

Set one name-value pair into the header map.

Parameters:

p_strKey - The header key.

p_strValue - The header value.

getHeaderValue

java.lang.String getHeaderValue(java.lang.String p_strKey)

Get a header info value to a specified key.

Parameters:

p_strKey - The header info key.

Returns:

The header value.

getHeaderValueMap

java.util.Map<java.lang.String,java.lang.String> getHeaderValueMap()

Get a reference to the internal header map.

Note: This method is for internal use only. It must not be used in scripts.

Returns:

The header map.

addCookie

void addCookie(de.uplanet.net.http.ICookie p_cookie)

Add a cookie to the response or replace a cookie in the response.

An already existing cookie is being replaced if it is considered equal according to RFC 2965, 3.3.3, ie.

• it comes from same domain (case-insensitive),
• has the same name (case-insensitive),
• and has the same path (case-sensitive).

Parameters:

p_cookie - The cookie to be added.

getCookieList

java.util.List<de.uplanet.net.http.ICookie> getCookieList()

Get a reference to the internal cookie list.

Note: This method is for internal use only. It must not be used in scripts.

Returns:

The cookie list.

getOutputStream

java.io.OutputStream getOutputStream()

Get the socket output stream.

Returns:

The socket output stream.

getCharsetName

java.lang.String getCharsetName()

Get this response charset's name.

Returns:

The charset.

getCharset

java.nio.charset.Charset getCharset()

Get this response's charset.

Returns:

The charset.

setCharset

void setCharset(java.lang.String p_strCharsetName,
                java.nio.charset.Charset p_charset)

Set this response's charset.

This method should only be called once.

Parameters:

p_strCharsetName - The name of the charset to be set.

p_charset - The charset to be set.

getWriter

java.io.Writer getWriter()

Get a writer to the underlying output stream with the given charset.

Returns:

The writer.