Servlet::ServletResponse - servlet response interface

- NAME
- SYNOPSIS
- DESCRIPTION
- METHODS
- SEE ALSO
- AUTHOR

# NAME

Servlet::ServletResponse - servlet response interface

# SYNOPSIS

      $response->flushBuffer();

      my $size = $response->getBufferSize();

      my $encoding = $response->getCharacterEncoding();

      my $locale = $response->getLocale();

      my $output = $response->getOutputHandle();

      my $writer = $response->getWriter();

      my $flag = $response->isCommitted();

      $response->reset();

      $response->resetBuffer();

      $response->setBufferSize($size);

      $response->setContentLength($length);

      $response->setContentType($type);

      $response->setLocale($locale);

# DESCRIPTION

This interface defines an object that assists a servlet in sending a response to the client. The servlet container creates the object and passes it as an argument to the servlet's `service()` method.

# METHODS

`flushBuffer()`
  Forces any content in the buffer to be written to the client. A call to this method automatically commits the resopnse, meaning the status code and headers will be written.

  Throws:

  Servlet::Util::IOException
`getBufferSize()`
  Returns the actual buffer size used for the response, or 0 if no buffering is used.

`getCharacterEncoding()`
  Returns the name of the character encoding used in the body of this response. If not charset has been assigned, it is implicitly set to ISO-8859-1.

`getLocale()`
  Returns the locale assigned to the response.

`getOutputHandle()`
  Returns a IO::Handle suitable for writing binary data in the response. The servlet container does not encode the binary data.

  Calling `flush()` commits the response.

  Either this method or `getWriter()` may be called to write the body, not both.

  Throws:

  Servlet::Util::IllegalStateException
    if the `getWriter()` method has already been called for this response

  Servlet::Util::IOException
    if an input or output exception occurred

`getWriter()`
  Returns a XXX object that can send character text to the client. The character encoding used is the one specified in the charset parameter of `setContentType()`, which must be called before calling this metod for the charset to take effect.

  If necessary, the content type of the response is modified to reflect the character encoding used.

  Calling `flush()` commits the response.

  Either this method or `getOutputHandle()` may be called to write the body, not both.

  Throws:

  Servlet::Util::UnsupportedEncodingException
    if the charset specified in `setContentType()` cannot be used

  Servlet::Util::IllegalStateException
    if the `getOutputHandle()` method has already been called for this request

  Servlet::Util::IOException
    if an input or output exception occurred

`isCommitted()`
  Returns a boolean indicating if the response has been committed. A committed response has already had its status code and headers written.

`reset()`
  Clears any data that exists in the buuffer as well as the status code and headers.

  Throws:

  Servlet::Util::IllegalStateException
    if the response has already been committed

`resetBuffer()`
  Clears the content of the underlying buffer in the response without clearing headers or status code.

  Throws:

  Servlet::Util::IllegalStateException
    if the response has already been committed

`setBufferSize($size)`
  Sets the preferred buffer size for the body of the response. The servlet container will use a buffer at least as large as the size requested. The actual buffer size can be found using `getBufferSize()`.

  A larger buffer allows more content to be written before anything is actually sent, thus providing the servlet with more time to set appropriate status codes and headers. A smaller buffer decreases server memory load and allows the client to start receiving data more quickly.

  This method must be called before any response body content is written.

  Parameters:

  $size
    The preferred buffer size

  Throws:

  Servlet::Util::IllegalStateException
    if content has been written to the buffer

`setContentLength($len)`
  Sets the length of the content body in the response. In HTTP servlets, this method sets the HTTP Content-Length header.

  Parameters:

  $len
    The length of the content being returned to the client

`setContentLength($len)`
  Sets the length of the content body in the response. In HTTP servlets, this method sets the HTTP Content-Length header.

  Parameters:

  $len
    The length of the content being returned to the client

`setContentType($type)`
  Sets the content type of the response. The content type may include the type of character encoding used, for example text/html; charset=ISO-8859-4.

  If calling `getWriter()`, this method should be called first.

  Parameters:

  $type
    The MIME type of the content

`setLocale($loc)`
  Sets the locale of the response, setting the headers (including the charset attribute of the Content-Type) as appropriate.

  This method should be called before a call to `getWriter()`.

  By default, the response locale is the default locale for the server.

  Parameters:

  $loc
    The locale of the response

# SEE ALSO

the IO::Handle manpage

# AUTHOR

Brian Moseley, bcm@maz.org