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.coyote;
 
 
Response object.

Author(s):
James Duncan Davidson [duncan@eng.sun.com]
Jason Hunter [jch@eng.sun.com]
James Todd [gonzo@eng.sun.com]
Harish Prabandham
Hans Bergsten <hans@gefionsoftware.com>
Remy Maucherat
 
 public final class Response {
 
 
     // ----------------------------------------------------------- Constructors
 
 
     public Response() {
     }
 
 
     // ----------------------------------------------------- Class Variables
 
    
Default locale as mandated by the spec.
 
     private static Locale DEFAULT_LOCALE = Locale.getDefault();
 
 
     // ----------------------------------------------------- Instance Variables
 
    
Status code.
 
     protected int status = 200;


    
Status message.
 
     protected String message = null;


    
Response headers.
 
     protected MimeHeaders headers = new MimeHeaders();


    
Associated output buffer.
 
     protected OutputBuffer outputBuffer;


    
Notes.
 
     protected Object notes[] = new Object[.];


    
Committed flag.
 
     protected boolean commited = false;


    
Action hook.
 
     public ActionHook hook;


    
HTTP specific fields.
    protected String contentType = null;
    protected String contentLanguage = null;
    protected long contentLength = -1;
    private Locale locale = ;
    // General informations
    private long bytesWritten=0;

    
Holds request error exception.
    protected Throwable errorException = null;

    
Has the charset been explicitly set.
    protected boolean charsetSet = false;

    
Request error URI.
    protected String errorURI = null;
    protected Request req;
    protected int lastWrite = 1;
    protected boolean flushLeftovers = true;
    
    protected String sendfilePath = null;
    protected long sendfileStart = 0;
    protected long sendfileEnd = 0;
    // ------------------------------------------------------------- Properties
    public Request getRequest() {
        return ;
    }
    public void setRequestRequest req ) {
        this.=req;
    }
    public OutputBuffer getOutputBuffer() {
        return ;
    }
    public void setOutputBuffer(OutputBuffer outputBuffer) {
        this. = outputBuffer;
    }
    public MimeHeaders getMimeHeaders() {
        return ;
    }
    public ActionHook getHook() {
        return ;
    }
    public void setHook(ActionHook hook) {
        this. = hook;
    }
    // -------------------- Per-Response "notes" --------------------
    public final void setNote(int posObject value) {
        [pos] = value;
    }
    public final Object getNote(int pos) {
        return [pos];
    }
    // -------------------- Actions --------------------
    public void action(ActionCode actionCodeObject param) {
        if ( != null) {
            ifparam==null ) 
                .action(actionCodethis);
            else
                .action(actionCodeparam);
        }
    }
    // -------------------- State --------------------
    
    public boolean getFlushLeftovers() {
        return ;
    }
    
    public void setFlushLeftovers(boolean flushLeftovers) {
        this. = flushLeftovers;
    }
    
    public int getLastWrite() {
         = false;
        return ;
    }
    
    public void setLastWrite(int lastWrite) {
        this. = lastWrite;
    }
    public int getStatus() {
        return ;
    }

    
    
Set the response status
 
    public void setStatusint status ) {
        this. = status;
    }


    
Get the status message.
    public String getMessage() {
        return ;
    }


    
Set the status message.
    public void setMessage(String message) {
        this. = message;
    }
    public boolean isCommitted() {
        return ;
    }
    public void setCommitted(boolean v) {
        this. = v;
    }
    // -----------------Error State --------------------


    
Set the error Exception that occurred during request processing.
    public void setErrorException(Throwable t) {
         = t;
    }


    
Get the Exception that occurred during request processing.
    public Throwable getErrorException() {
        return ;
    }
    public boolean isExceptionPresent() {
        return (  != null );
    }


    
Set request URI that caused an error during request processing.
    public void setErrorURI(String uri) {
         = uri;
    }


    
Get the request URI that caused the original error.
    public String getErrorURI() {
        return ;
    }
    // -------------------- Methods --------------------
    
    
    public void reset() 
        throws IllegalStateException {
        
        if () {
            throw new IllegalStateException();
        }
        recycle();
    }
    public void finish() throws IOException {
        action(.this);
    }
    public void acknowledge() throws IOException {
        action(.this);
    }
    // -------------------- Headers --------------------
    
Warning: This method always returns false for Content-Type and Content-Length.
    public boolean containsHeader(String name) {
        return .getHeader(name) != null;
    }
    public void setHeader(String nameString value) {
        char cc=name.charAt(0);
        ifcc=='C' || cc=='c' ) {
            ifcheckSpecialHeader(namevalue) )
            return;
        }
        .setValue(name).setStringvalue);
    }
    public void addHeader(String nameString value) {
        char cc=name.charAt(0);
        ifcc=='C' || cc=='c' ) {
            ifcheckSpecialHeader(namevalue) )
            return;
        }
        .addValue(name).setStringvalue );
    }

    
    
Set internal fields for special header names. Called from set/addHeader. Return true if the header is special, no need to set the header.
    private boolean checkSpecialHeaderString nameString value) {
        // XXX Eliminate redundant fields !!!
        // ( both header and in special fields )
        ifname.equalsIgnoreCase"Content-Type" ) ) {
            setContentTypevalue );
            return true;
        }
        ifname.equalsIgnoreCase"Content-Length" ) ) {
            try {
                long cL=Long.parseLongvalue );
                setContentLengthcL );
                return true;
            } catchNumberFormatException ex ) {
                // Do nothing - the spec doesn't have any "throws" 
                // and the user might know what he's doing
                return false;
            }
        }
        ifname.equalsIgnoreCase"Content-Language" ) ) {
            // XXX XXX Need to construct Locale or something else
        }
        return false;
    }


    
Signal that we're done with the headers, and body will follow. Any implementation needs to notify ContextManager, to allow interceptors to fix headers.
    public void sendHeaders() throws IOException {
        action(.this);
         = true;
    }
    // -------------------- I18N --------------------
    public Locale getLocale() {
        return ;
    }

    
Called explicitely by user to set the Content-Language and the default encoding
    public void setLocale(Locale locale) {
        if (locale == null) {
            return;  // throw an exception?
        }
        // Save the locale for use by getLocale()
        this. = locale;
        // Set the contentLanguage for header output
         = locale.getLanguage();
        if (( != null) && (.length() > 0)) {
            String country = locale.getCountry();
            StringBuilder value = new StringBuilder();
            if ((country != null) && (country.length() > 0)) {
                value.append('-');
                value.append(country);
            }
             = value.toString();
        }
    }

    
Return the content language.
    public String getContentLanguage() {
        return ;
    }
    /*
     * Overrides the name of the character encoding used in the body
     * of the response. This method must be called prior to writing output
     * using getWriter().
     *
     * @param charset String containing the name of the chararacter encoding.
     */
    public void setCharacterEncoding(String charset) {
        if (isCommitted())
            return;
        if (charset == null)
            return;
         = charset;
        =true;
    }
    public String getCharacterEncoding() {
        return ;
    }

    
Sets the content type. This method must preserve any response charset that may already have been set via a call to response.setContentType(), response.setLocale(), or response.setCharacterEncoding().

Parameters:
type the content type
    public void setContentType(String type) {
        int semicolonIndex = -1;
        if (type == null) {
            this. = null;
            return;
        }
        /*
         * Remove the charset param (if any) from the Content-Type, and use it
         * to set the response encoding.
         * The most recent response encoding setting will be appended to the
         * response's Content-Type (as its charset param) by getContentType();
         */
        boolean hasCharset = false;
        int len = type.length();
        int index = type.indexOf(';');
        while (index != -1) {
            semicolonIndex = index;
            index++;
            while (index < len && Character.isSpace(type.charAt(index))) {
                index++;
            }
            if (index+8 < len
                    && type.charAt(index) == 'c'
                    && type.charAt(index+1) == 'h'
                    && type.charAt(index+2) == 'a'
                    && type.charAt(index+3) == 'r'
                    && type.charAt(index+4) == 's'
                    && type.charAt(index+5) == 'e'
                    && type.charAt(index+6) == 't'
                    && type.charAt(index+7) == '=') {
                hasCharset = true;
                break;
            }
            index = type.indexOf(';'index);
        }
        if (!hasCharset) {
            this. = type;
            return;
        }
        this. = type.substring(0, semicolonIndex);
        String tail = type.substring(index+8);
        int nextParam = tail.indexOf(';');
        String charsetValue = null;
        if (nextParam != -1) {
            this. += tail.substring(nextParam);
            charsetValue = tail.substring(0, nextParam);
        } else {
            charsetValue = tail;
        }
        // The charset value may be quoted, but must not contain any quotes.
        if (charsetValue != null && charsetValue.length() > 0) {
            =true;
            charsetValue = charsetValue.replace('"'' ');
            this. = charsetValue.trim();
        }
    }
    public String getContentType() {
        String ret = ;
        if (ret != null 
            &&  != null
            && ) {
            ret = ret + ";charset=" + ;
        }
        return ret;
    }
    
    public void setContentLength(int contentLength) {
        this. = contentLength;
    }
    public void setContentLength(long contentLength) {
        this. = contentLength;
    }
    public int getContentLength() {
        long length = getContentLengthLong();
        
        if (length < .) {
            return (intlength;
        }
        return -1;
    }
    
    public long getContentLengthLong() {
        return ;
    }
    public String getSendfilePath() {
        return ;
    }
    public void setSendfilePath(String sendfilePath) {
        this. = sendfilePath;
    }
    public long getSendfileStart() {
        return ;
    }
    public void setSendfileStart(long sendfileStart) {
        this. = sendfileStart;
    }
    public long getSendfileEnd() {
        return ;
    }
    public void setSendfileEnd(long sendfileEnd) {
        this. = sendfileEnd;
    }

    
Write a chunk of bytes.
    public void doWrite(ByteChunk chunk/*byte buffer[], int pos, int count*/)
        throws IOException
    {
        .doWrite(chunkthis);
        +=chunk.getLength();
    }
    // --------------------
    
    public void recycle() {
        
         = null;
         = null;
         = ;
         = false;
         = -1;
         = 200;
         = null;
         = false;
         = null;
         = null;
        .clear();
         = null;
        // update counters
         = 1;
        =0;
    }
    public long getBytesWritten() {
        return ;
    }
    public void setBytesWritten(long bytesWritten) {
        this. = bytesWritten;
    }
New to GrepCode? Check out our FAQ X