Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.util
Class ContentTypeResponseWrapper

java.lang.Object
  extended by javax.servlet.ServletResponseWrapper
      extended by javax.servlet.http.HttpServletResponseWrapper
          extended by com.jivesoftware.util.ContentTypeResponseWrapper
All Implemented Interfaces:
javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse

public class ContentTypeResponseWrapper
extends javax.servlet.http.HttpServletResponseWrapper

The class wraps the Response object to ensure that the character set for the response is always set. This is done by overriding calls to setContentType and appending the ";charset=" information if it is not already present.


Field Summary
 
Fields inherited from interface javax.servlet.http.HttpServletResponse
SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CONTINUE, SC_CREATED, SC_EXPECTATION_FAILED, SC_FORBIDDEN, SC_FOUND, SC_GATEWAY_TIMEOUT, SC_GONE, SC_HTTP_VERSION_NOT_SUPPORTED, SC_INTERNAL_SERVER_ERROR, SC_LENGTH_REQUIRED, SC_METHOD_NOT_ALLOWED, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_MULTIPLE_CHOICES, SC_NO_CONTENT, SC_NON_AUTHORITATIVE_INFORMATION, SC_NOT_ACCEPTABLE, SC_NOT_FOUND, SC_NOT_IMPLEMENTED, SC_NOT_MODIFIED, SC_OK, SC_PARTIAL_CONTENT, SC_PAYMENT_REQUIRED, SC_PRECONDITION_FAILED, SC_PROXY_AUTHENTICATION_REQUIRED, SC_REQUEST_ENTITY_TOO_LARGE, SC_REQUEST_TIMEOUT, SC_REQUEST_URI_TOO_LONG, SC_REQUESTED_RANGE_NOT_SATISFIABLE, SC_RESET_CONTENT, SC_SEE_OTHER, SC_SERVICE_UNAVAILABLE, SC_SWITCHING_PROTOCOLS, SC_TEMPORARY_REDIRECT, SC_UNAUTHORIZED, SC_UNSUPPORTED_MEDIA_TYPE, SC_USE_PROXY
 
Constructor Summary
ContentTypeResponseWrapper(javax.servlet.http.HttpServletResponse response, java.lang.String encoding)
          Constructs a new ContentTypeResponseWrapper.
 
Method Summary
 boolean getOverrideCharset()
          Returns the value of overrideCharset.
 void setContentType(java.lang.String contentType)
          Overrides the super class setContentType method to check that a "charset" is always specified as part of the content type.
 void setOverrideCharset(boolean overrideCharset)
          Sets the value of overrideCharset.
 
Methods inherited from class javax.servlet.http.HttpServletResponseWrapper
addCookie, addDateHeader, addHeader, addIntHeader, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, sendError, sendError, sendRedirect, setDateHeader, setHeader, setIntHeader, setStatus, setStatus
 
Methods inherited from class javax.servlet.ServletResponseWrapper
flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getResponse, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setLocale, setResponse
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.servlet.ServletResponse
flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setLocale
 

Constructor Detail

ContentTypeResponseWrapper

public ContentTypeResponseWrapper(javax.servlet.http.HttpServletResponse response,
                                  java.lang.String encoding)
Constructs a new ContentTypeResponseWrapper. The encoding should be set to the value of JiveGlobals.getCharacterEncoding(). However, it can be overridden and a null value is valid. If encoding is null then the DEFAULT_CHAR_ENCODING is used.

Parameters:
response - the Servlet response.
encoding - the encoding to use. If null then the DEFAULT_CHAR_ENCODING is used.
Method Detail

getOverrideCharset

public boolean getOverrideCharset()
Returns the value of overrideCharset. If overrideCharset is true then calls to setContentType(String) will always inject the value of 'encoding' passed to the constructor, even if the contentType passed to setContentType(String) contains a charset= declaration.

Returns:
true if the content type charset will always be overridden, false otherwise.

setOverrideCharset

public void setOverrideCharset(boolean overrideCharset)
Sets the value of overrideCharset. If overrideCharset is true then calls to setContentType(String) will always inject the value of 'encoding' passed to the constructor, even if the contentType passed to setContentType(String) contains a charset= declaration.

Parameters:
overrideCharset - true if the content type charset should always be overridden, false otherwise.

setContentType

public void setContentType(java.lang.String contentType)
Overrides the super class setContentType method to check that a "charset" is always specified as part of the content type. If no "charset" parameter is part of the given contentType then the encoding set in the constructor is used.

Specified by:
setContentType in interface javax.servlet.ServletResponse
Overrides:
setContentType in class javax.servlet.ServletResponseWrapper
Parameters:
contentType - the content type being set

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.