ServletResponse (OSGL HTTP 1.1.1 API)

java.lang.Object
- org.osgl.http.H.Response<ServletResponse>
- - org.osgl.http.servlet.ServletResponse

public class ServletResponse
extends H.Response<ServletResponse>

Field Summary
- Fields inherited from class org.osgl.http.H.Response
  outputStream, writer

Constructor Summary

Constructors
Constructor and Description

ServletResponse(javax.servlet.http.HttpServletResponse resp)

Constructors
Constructor and Description
`ServletResponse(javax.servlet.http.HttpServletResponse resp)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Class<ServletResponse>`	`_impl()` Returns the class of the implementation.
`protected void`	`_setContentType(String type)` Sub class to overwrite this method to set content type to the response
`protected void`	`_setLocale(Locale loc)` Sets the locale of the response, setting the headers (including the Content-Type's charset) as appropriate.
`void`	`addCookie(H.Cookie cookie)` Adds the specified cookie to the response.
`ServletResponse`	`addHeader(String name, String value)` Adds a response header with the given name and value.
`String`	`characterEncoding()` Returns the name of the character encoding (MIME charset) used for the body sent in this response.
`ServletResponse`	`characterEncoding(String encoding)` Returns the content type used for the MIME body sent in this response.
`void`	`commit()` Calling this method commits the response, meaning the status code and headers will be written to the client
`boolean`	`containsHeader(String name)` Returns a boolean indicating whether the named response header has already been set.
`ServletResponse`	`contentLength(long len)` Set the length of the content to be write to the response
`protected OutputStream`	`createOutputStream()`
`ServletResponse`	`header(String name, String value)` Sets a response header with the given name and value.
`Locale`	`locale()` Returns the locale assigned to the response.
`ServletResponse`	`sendError(int sc)` Sends an error response to the client using the specified status code and clearing the buffer.
`ServletResponse`	`sendError(int sc, String msg)` Sends an error response to the client using the specified status.
`ServletResponse`	`sendRedirect(String location)` Sends a temporary redirect response to the client using the specified redirect location URL.
`ServletResponse`	`status(int sc)` Sets the status code for this response.
`ServletResponse`	`writeContent(ByteBuffer buffer)` This method is not supported in ServletResponse

Methods inherited from class org.osgl.http.H.Response
addHeaderIfNotAdded, contentDisposition, contentType, context, context, current, current, etag, initContentType, locale, me, outputStream, prepareDownload, printWriter, sendError, status, writeBinary, writeContent, writeHtml, writeJSON, writer, writerCreated, writeText

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ServletResponse
```
public ServletResponse(javax.servlet.http.HttpServletResponse resp)
```
- Method Detail
  - _impl
```
protected Class<ServletResponse> _impl()
```
    Description copied from class: H.Response
    
    Returns the class of the implementation. Not to be used by application
    
    Specified by:
    
    _impl in class H.Response<ServletResponse>
    
    Returns:
    
    implementation class
  - characterEncoding
```
public String characterEncoding()
```
    Description copied from class: H.Response
    
    Returns the name of the character encoding (MIME charset) used for the body sent in this response. The character encoding may have been specified explicitly using the H.Response.characterEncoding(String) or H.Response.contentType(String) methods, or implicitly using the H.Response.locale(java.util.Locale) method. Explicit specifications take precedence over implicit specifications. Calls made to these methods after getWriter has been called or after the response has been committed have no effect on the character encoding. If no character encoding has been specified, ISO-8859-1 is returned.
    See RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt) for more information about character encoding and MIME.
    
    Specified by:
    
    characterEncoding in class H.Response<ServletResponse>
    
    Returns:
    
    a String specifying the name of the character encoding, for example, UTF-8
  - characterEncoding
```
public ServletResponse characterEncoding(String encoding)
```
    Description copied from class: H.Response
    
    Returns the content type used for the MIME body sent in this response. The content type proper must have been specified using H.Response.contentType(String) before the response is committed. If no content type has been specified, this method returns null. If a content type has been specified, and a character encoding has been explicitly or implicitly specified as described in H.Response.characterEncoding() or H.Response.writer() has been called, the charset parameter is included in the string returned. If no character encoding has been specified, the charset parameter is omitted.
    
    Specified by:
    
    characterEncoding in class H.Response<ServletResponse>
    
    Parameters:
    
    encoding - the encoding
    
    Returns:
    
    a String specifying the content type, for example, text/html; charset=UTF-8, or null
  - contentLength
```
public ServletResponse contentLength(long len)
```
    Description copied from class: H.Response
    
    Set the length of the content to be write to the response
    
    Specified by:
    
    contentLength in class H.Response<ServletResponse>
    
    Parameters:
    
    len - an long value specifying the length of the content being returned to the client; sets the Content-Length header
    
    Returns:
    
    the response it self
    
    See Also:
    
    H.Response.outputStream, H.Response.writer
  - writeContent
```
public ServletResponse writeContent(ByteBuffer buffer)
```
    This method is not supported in ServletResponse
    
    Specified by:
    
    writeContent in class H.Response<ServletResponse>
    
    Parameters:
    
    buffer - direct byte buffer
    
    Returns:
    
    this response instance
  - createOutputStream
```
protected OutputStream createOutputStream()
```
    Specified by:
    
    createOutputStream in class H.Response<ServletResponse>
  - _setContentType
```
protected void _setContentType(String type)
```
    Description copied from class: H.Response
    
    Sub class to overwrite this method to set content type to the response
    
    Specified by:
    
    _setContentType in class H.Response<ServletResponse>
    
    Parameters:
    
    type - a String specifying the MIME type of the content
  - _setLocale
```
protected void _setLocale(Locale loc)
```
    Description copied from class: H.Response
    
    Sets the locale of the response, setting the headers (including the Content-Type's charset) as appropriate. This method should be called before a call to H.Response.writer(). By default, the response locale is the default locale for the server.
    
    Specified by:
    
    _setLocale in class H.Response<ServletResponse>
    
    Parameters:
    
    loc - the locale of the response
    
    See Also:
    
    H.Response.locale()
  - locale
```
public Locale locale()
```
    Description copied from class: H.Response
    
    Returns the locale assigned to the response.
    
    Specified by:
    
    locale in class H.Response<ServletResponse>
    
    Returns:
    
    locale
    
    See Also:
    
    H.Response.locale(java.util.Locale)
  - addCookie
```
public void addCookie(H.Cookie cookie)
```
    Description copied from class: H.Response
    
    Adds the specified cookie to the response. This method can be called multiple times to add more than one cookie.
    
    Specified by:
    
    addCookie in class H.Response<ServletResponse>
    
    Parameters:
    
    cookie - the Cookie to return to the client
  - containsHeader
```
public boolean containsHeader(String name)
```
    Description copied from class: H.Response
    
    Returns a boolean indicating whether the named response header has already been set.
    
    Specified by:
    
    containsHeader in class H.Response<ServletResponse>
    
    Parameters:
    
    name - the header name
    
    Returns:
    
    true if the named response header has already been set; false otherwise
  - sendError
```
public ServletResponse sendError(int sc,
                                 String msg)
```
    Description copied from class: H.Response
    
    Sends an error response to the client using the specified status. The server defaults to creating the response to look like an HTML-formatted server error page containing the specified message, setting the content type to "text/html", leaving cookies and other headers unmodified. If an error-page declaration has been made for the web application corresponding to the status code passed in, it will be served back in preference to the suggested msg parameter.
    If the response has already been committed, this method throws an IllegalStateException. After using this method, the response should be considered to be committed and should not be written to.
    
    Specified by:
    
    sendError in class H.Response<ServletResponse>
    
    Parameters:
    
    sc - the error status code
    
    msg - the descriptive message
    
    Returns:
    
    the response itself
  - sendError
```
public ServletResponse sendError(int sc)
```
    Description copied from class: H.Response
    
    Sends an error response to the client using the specified status code and clearing the buffer.
    If the response has already been committed, this method throws an IllegalStateException. After using this method, the response should be considered to be committed and should not be written to.
    
    Specified by:
    
    sendError in class H.Response<ServletResponse>
    
    Parameters:
    
    sc - the error status code
    
    Returns:
    
    the response itself
  - sendRedirect
```
public ServletResponse sendRedirect(String location)
```
    Description copied from class: H.Response
    
    Sends a temporary redirect response to the client using the specified redirect location URL. This method can accept relative URLs; the servlet container must convert the relative URL to an absolute URL before sending the response to the client. If the location is relative without a leading '/' the container interprets it as relative to the current request URI. If the location is relative with a leading '/' the container interprets it as relative to the servlet container root.
    If the response has already been committed, this method throws an IllegalStateException. After using this method, the response should be considered to be committed and should not be written to.
    
    Specified by:
    
    sendRedirect in class H.Response<ServletResponse>
    
    Parameters:
    
    location - the redirect location URL
    
    Returns:
    
    the response itself
  - header
```
public ServletResponse header(String name,
                              String value)
```
    Description copied from class: H.Response
    
    Sets a response header with the given name and value. If the header had already been set, the new value overwrites the previous one. The containsHeader method can be used to test for the presence of a header before setting its value.
    
    Specified by:
    
    header in class H.Response<ServletResponse>
    
    Parameters:
    
    name - the name of the header
    
    value - the header value If it contains octet string, it should be encoded according to RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt)
    
    Returns:
    
    the response itself
    
    See Also:
    
    H.Response.containsHeader(java.lang.String), H.Response.addHeader(java.lang.String, java.lang.String)
  - status
```
public ServletResponse status(int sc)
```
    Description copied from class: H.Response
    
    Sets the status code for this response. This method is used to set the return status code when there is no error (for example, for the status codes SC_OK or SC_MOVED_TEMPORARILY). If there is an error, and the caller wishes to invoke an error-page defined in the web application, the sendError method should be used instead.
    The container clears the buffer and sets the Location header, preserving cookies and other headers.
    
    Specified by:
    
    status in class H.Response<ServletResponse>
    
    Parameters:
    
    sc - the status code
    
    Returns:
    
    the response itself
    
    See Also:
    
    H.Response.sendError(int, java.lang.String), H.Response.status(int)
  - addHeader
```
public ServletResponse addHeader(String name,
                                 String value)
```
    Description copied from class: H.Response
    
    Adds a response header with the given name and value. This method allows response headers to have multiple values.
    
    Specified by:
    
    addHeader in class H.Response<ServletResponse>
    
    Parameters:
    
    name - the name of the header
    
    value - the additional header value If it contains octet string, it should be encoded according to RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt)
    
    Returns:
    
    this response itself
    
    See Also:
    
    H.Response.header(String, String)
  - commit
```
public void commit()
```
    Description copied from class: H.Response
    
    Calling this method commits the response, meaning the status code and headers will be written to the client
    
    Specified by:
    
    commit in class H.Response<ServletResponse>

Class ServletResponse

Field Summary

Fields inherited from class org.osgl.http.H.Response

Constructor Summary

Method Summary

Methods inherited from class org.osgl.http.H.Response

Methods inherited from class java.lang.Object

Constructor Detail

ServletResponse

Method Detail

_impl

characterEncoding

characterEncoding

contentLength

writeContent

createOutputStream

_setContentType

_setLocale

locale

addCookie

containsHeader

sendError

sendError

sendRedirect

header

status

addHeader

commit