Module org.apache.wicket.request

Package org.apache.wicket.request

Class Response

java.lang.Object

org.apache.wicket.request.Response

Direct Known Subclasses:

ByteArrayResponse, NullResponse, StringResponse, WebResponse

public abstract class Response
extends Object

Abstract base class for different implementations of response writing.

The implementation may not support calling both write(byte[]) and write(CharSequence) on the same Response instance.

Author:

Matej Knopp, igor.vaynberg

Constructor Summary

Constructors

Constructor	Description
Response()

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the response
abstract String	encodeURL(CharSequence url)	Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged.
abstract Object	getContainerResponse()	Provides access to the low-level container response object that implementaion of this Response delegate to.
OutputStream	getOutputStream()	Returns an OutputStream suitable for writing binary data in the response.
void	reset()	Called when the Response needs to reset itself.
abstract void	write(byte[] array)	Writes the buffer to output.
abstract void	write(byte[] array, int offset, int length)	Writes the buffer to output.
abstract void	write(CharSequence sequence)	Writes the CharSequence to output.

Methods inherited from class java.lang.Object

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

Constructor Details

Response

public Response()

Method Details

write

public abstract void write(CharSequence sequence)

Writes the CharSequence to output.

Parameters:

sequence -

Throws:

IllegalStateException - if write(byte[]) has already been called on this instance

write

public abstract void write(byte[] array)

Writes the buffer to output.

Parameters:

array - the data.

Throws:

IllegalStateException - if write(CharSequence) has already been called on this instance

write

public abstract void write(byte[] array,
 int offset,
 int length)

Writes the buffer to output.

Parameters:

array - the data.

offset - the start offset in the data.

length - the number of bytes to write.

Throws:

IllegalStateException - if write(CharSequence) has already been called on this instance

Since:

1.5.1

close

public void close()

Closes the response

encodeURL

public abstract String encodeURL(CharSequence url)

Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged.

Parameters:

url -

Returns:

encoded URL

reset

public void reset()

Called when the Response needs to reset itself. Subclasses can empty there buffer or build up state.

getContainerResponse

public abstract Object getContainerResponse()

Provides access to the low-level container response object that implementaion of this Response delegate to. This allows users to access features provided by the container response but not by generalized Wicket Response objects.

Returns:

low-level container response object, or null if none

getOutputStream

public OutputStream getOutputStream()

Returns an OutputStream suitable for writing binary data in the response. The servlet container does not encode the binary data.

Calling flush() on the OutputStream commits the response.

This method returns an output stream that delegates to write(byte[]), write(byte[], int, int), and close() methods of this response instance

Returns:

output stream