head	1.1;
access;
symbols;
locks; strict;
comment	@# @;


1.1
date	2001.07.17.00.29.10;	author dlr;	state Exp;
branches;
next	;


desc
@@


1.1
log
@Removed HelmHeaders Joist dependency by moving some files which I had previously overlooked from Joist into Helm.  Provided better JavaDoc for the NoodleFilter class.
@
text
@/* ================================================================
 * Copyright (c) 2000 Collab.Net.  All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 * 
 * 1. Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * 
 * 2. Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 * 
 * 3. The end-user documentation included with the redistribution, if
 * any, must include the following acknowlegement: "This product includes
 * software developed by Collab.Net <http://www.Collab.Net/>."
 * Alternately, this acknowlegement may appear in the software itself, if
 * and wherever such third-party acknowlegements normally appear.
 * 
 * 4. The hosted project names must not be used to endorse or promote
 * products derived from this software without prior written
 * permission. For written permission, please contact info@@collab.net.
 * 
 * 5. Products derived from this software may not use the "Tigris" or 
 * "Scarab" names nor may "Tigris" or "Scarab" appear in their names without 
 * prior written permission of Collab.Net.
 * 
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL COLLAB.NET OR ITS CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * ====================================================================
 * 
 * This software consists of voluntary contributions made by many
 * individuals on behalf of Collab.Net.
 */ 
package org.tigris.helm.publish;

import java.util.*;
import java.net.*;

// Java Servlet Classes
import javax.servlet.*;
import javax.servlet.http.*;

import HTTPClient.*;

/**
 * NoodleData is a per-request container of commonly used items.
 *  
 * @@author <a href="mailto:jon@@collab.net">Jon S. Stevens</a>
 */
public class NoodleData
{
    /** the servlet request */
    private HttpServletRequest req = null;
    /** the servlet response */
    private HttpServletResponse res = null;
    /** the URL for the remote connection */
    private URL url = null;
    /** post data if it exists */
    private byte[] postData = null;
    /** query data if it exists */
    private String queryData = null;
    /** the response from the URL connection */
    private byte[] responseData = null;
    /** the NVPair[] headersToSend */
    private Vector headersToSend = null;
    /** HTTPClient.HTTPResponse */
    private HTTPResponse httpResponse = null;
    
    /**
        constructor sets items that should be immediately available.
    */
    public NoodleData (HttpServletRequest req, HttpServletResponse res)
    {
        this.req = req;
        this.res = res;
        headersToSend = new Vector();
    }
    /**
        the request
    */
    public HttpServletRequest getRequest()
    {
        return this.req;
    }
    /**
        the response
    */
    public HttpServletResponse getResponse()
    {
        return this.res;
    }
    /**
        the URL
    */
    public URL getURL()
    {
        return this.url;
    }
    /**
        the URL
    */
    public void setURL(URL url)
    {
        this.url = url;
    }
    /**
        the Vector of NVPair
    */
    public void setHeadersToSend(Vector headersToSend)
    {
        this.headersToSend = headersToSend;
    }
    /**
        the Vector of NVPair
    */
    public Vector getHeadersToSend()
    {
        return this.headersToSend;
    }
    /**
        You shouldn't need to execute this method directly
    */
    NVPair[] getHeadersToSendAsNVPair()
    {
        NVPair[] result = new NVPair[headersToSend.size()];
        int i = 0;
        for (Enumeration e = headersToSend.elements(); e.hasMoreElements(); )
        {
            NVPair tmp = (NVPair) e.nextElement();
            result[i] = tmp;
            i++;
        }
        return result;
    }
    
    /**
        post data if it exists
    */
    public byte[] getPostData()
    {
        return this.postData;
    }
    /**
        post data if it exists, null if it doesn't
    */
    public void setPostData(byte[] postData)
    {
        this.postData = postData;
    }
    /**
        query data if it exists
    */
    public String getQueryData()
    {
        return this.queryData;
    }
    /**
        query data if it exists, null if it doesn't
    */
    public void setQueryData(String queryData)
    {
        this.queryData = queryData;
    }
    /**
        this is the data that is available after the HUC has been executed
    */
    public byte[] getResponseData()
    {
        return this.responseData;
    }
    /**
        this is the data that is available after the HUC has been executed
    */
    public void setResponseData(byte[] data)
    {
        this.responseData = data;
    }
    
    /**
        the HTTPClient.HTTPResponse object
    */
    public HTTPResponse getHTTPResponse()
    {
        return this.httpResponse;
    }
    /**
        the HTTPClient.HTTPResponse object
    */
    public void setHTTPResponse(HTTPResponse httpResponse)
    {
        this.httpResponse = httpResponse;
    }

    public String postProcessPageName (String page) {
        // by default, do no special transform, but subclasses can override
        return page;
    }
}
@
