Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Licensed to the Apache Software Foundation (ASF) under one or more
   * contributor license agreements.  See the NOTICE file distributed with
   * this work for additional information regarding copyright ownership.
   * The ASF licenses this file to You under the Apache License, Version 2.0
   * (the "License"); you may not use this file except in compliance with
   * the License.  You may obtain a copy of the License at
   * 
   *      http://www.apache.org/licenses/LICENSE-2.0
  * 
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 
 
 package org.apache.catalina.core;
 
 
 
Wrapper around a javax.servlet.http.HttpServletResponse that transforms an application response object (which might be the original one passed to a servlet, or might be based on the 2.3 javax.servlet.http.HttpServletResponseWrapper class) back into an internal org.apache.catalina.HttpResponse.

WARNING: Due to Java's lack of support for multiple inheritance, all of the logic in ApplicationResponse is duplicated in ApplicationHttpResponse. Make sure that you keep these two classes in synchronization when making changes!

Author(s):
Craig R. McClanahan
Version:
$Revision: 515 $ $Date: 2008-03-17 22:02:23 +0100 (Mon, 17 Mar 2008) $
 
 
 
 
     // ----------------------------------------------------------- Constructors
 

    
Construct a new wrapped response around the specified servlet response.

Parameters:
response The servlet response being wrapped
 
     public ApplicationHttpResponse(HttpServletResponse response) {
 
         this(responsefalse);
 
     }


    
Construct a new wrapped response around the specified servlet response.

Parameters:
response The servlet response being wrapped
included true if this response is being processed by a RequestDispatcher.include() call
 
     public ApplicationHttpResponse(HttpServletResponse response,
                                    boolean included) {
 
         super(response);
         setIncluded(included);
 
     }
 
 
     // ----------------------------------------------------- Instance Variables
 

    
Is this wrapped response the subject of an include() call?
 
     protected boolean included = false;


    
Descriptive information about this implementation.
 
     protected static final String info =
         "org.apache.catalina.core.ApplicationHttpResponse/1.0";
 
 
     // ------------------------------------------------ ServletResponse Methods
 

    
Disallow reset() calls on a included response.

Throws:
java.lang.IllegalStateException if the response has already been committed
    public void reset() {
        // If already committed, the wrapped response will throw ISE
        if (! || getResponse().isCommitted())
            getResponse().reset();
    }


    
Disallow setContentLength() calls on an included response.

Parameters:
len The new content length
    public void setContentLength(int len) {
        if (!)
            getResponse().setContentLength(len);
    }


    
Disallow setContentType() calls on an included response.

Parameters:
type The new content type
    public void setContentType(String type) {
        if (!)
            getResponse().setContentType(type);
    }


    
Disallow setLocale() calls on an included response.

Parameters:
loc The new locale
    public void setLocale(Locale loc) {
        if (!)
            getResponse().setLocale(loc);
    }


    
Ignore setBufferSize() calls on an included response.

Parameters:
size The buffer size
    public void setBufferSize(int size) {
        if (!)
            getResponse().setBufferSize(size);
    }
    // -------------------------------------------- HttpServletResponse Methods


    
Disallow addCookie() calls on an included response.

Parameters:
cookie The new cookie
    public void addCookie(Cookie cookie) {
        if (!)
            ((HttpServletResponsegetResponse()).addCookie(cookie);
    }


    
Disallow addDateHeader() calls on an included response.

Parameters:
name The new header name
value The new header value
    public void addDateHeader(String namelong value) {
        if (!)
            ((HttpServletResponsegetResponse()).addDateHeader(namevalue);
    }


    
Disallow addHeader() calls on an included response.

Parameters:
name The new header name
value The new header value
    public void addHeader(String nameString value) {
        if (!)
            ((HttpServletResponsegetResponse()).addHeader(namevalue);
    }


    
Disallow addIntHeader() calls on an included response.

Parameters:
name The new header name
value The new header value
    public void addIntHeader(String nameint value) {
        if (!)
            ((HttpServletResponsegetResponse()).addIntHeader(namevalue);
    }


    
Disallow sendError() calls on an included response.

Parameters:
sc The new status code
Throws:
java.io.IOException if an input/output error occurs
    public void sendError(int scthrows IOException {
        if (!)
            ((HttpServletResponsegetResponse()).sendError(sc);
    }


    
Disallow sendError() calls on an included response.

Parameters:
sc The new status code
msg The new message
Throws:
java.io.IOException if an input/output error occurs
    public void sendError(int scString msgthrows IOException {
        if (!)
            ((HttpServletResponsegetResponse()).sendError(scmsg);
    }


    
Disallow sendRedirect() calls on an included response.

Parameters:
location The new location
Throws:
java.io.IOException if an input/output error occurs
    public void sendRedirect(String locationthrows IOException {
        if (!)
            ((HttpServletResponsegetResponse()).sendRedirect(location);
    }


    
Disallow setDateHeader() calls on an included response.

Parameters:
name The new header name
value The new header value
    public void setDateHeader(String namelong value) {
        if (!)
            ((HttpServletResponsegetResponse()).setDateHeader(namevalue);
    }


    
Disallow setHeader() calls on an included response.

Parameters:
name The new header name
value The new header value
    public void setHeader(String nameString value) {
        if (!)
            ((HttpServletResponsegetResponse()).setHeader(namevalue);
    }


    
Disallow setIntHeader() calls on an included response.

Parameters:
name The new header name
value The new header value
    public void setIntHeader(String nameint value) {
        if (!)
            ((HttpServletResponsegetResponse()).setIntHeader(namevalue);
    }


    
Disallow setStatus() calls on an included response.

Parameters:
sc The new status code
    public void setStatus(int sc) {
        if (!)
            ((HttpServletResponsegetResponse()).setStatus(sc);
    }


    
Disallow setStatus() calls on an included response.

Parameters:
sc The new status code
msg The new message
    public void setStatus(int scString msg) {
        if (!)
            ((HttpServletResponsegetResponse()).setStatus(scmsg);
    }
    // -------------------------------------------------------- Package Methods


    
Return descriptive information about this implementation.
    public String getInfo() {
        return ();
    }


    
Return the included flag for this response.
    boolean isIncluded() {
        return (this.);
    }


    
Set the included flag for this response.

Parameters:
included The new included flag
    void setIncluded(boolean included) {
        this. = included;
    }


    
Set the response that we are wrapping.

Parameters:
response The new wrapped response
    void setResponse(HttpServletResponse response) {
        super.setResponse(response);
    }
New to GrepCode? Check out our FAQ X