org.xlightweb.IHttpMessage Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xlightweb
xLightweb is a lightweight, high performance, scalable web network library
There is a newer version: 2.13.2
/*
 *  Copyright (c) xlightweb.org, 2008 - 2010. All rights reserved.
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Please refer to the LGPL license at: http://www.gnu.org/copyleft/lesser.txt
 * The latest copy of this software may be found on http://www.xlightweb.org/
 */
package org.xlightweb;

import java.util.Enumeration;
import java.util.Set;





/**
 * Http Message 
 * @author [email protected]
 */
public interface IHttpMessage extends IPart  {
	
	public static final String DEFAULT_ENCODING_KEY = "org.xlightweb.message.defaultencoding";    
	public static final String DEFAULT_ENCODING = System.getProperty(DEFAULT_ENCODING_KEY, "ISO-8859-1");
	 

	public static final String GET_METHOD = "GET";
	public static final String POST_METHOD = "POST";
	public static final String HEAD_METHOD = "HEAD";
	public static final String PUT_METHOD = "PUT";
	public static final String DELETE_METHOD = "DELETE";
	public static final String TRACE_METHOD = "TRACE";
	public static final String CONNECT_METHOD = "CONNECT";
	public static final String OPTIONS_METHOD = "OPTIONS";
	

	
    /**
     * Returns the length, in bytes, of the message body 
     * and made available by the input stream, or -1 if the
     * length is not known. 
     *
     * @return	an integer containing the length of the message body or -1 if the length is not known
     */
	int getContentLength();
	
	
	
	/**
	 * sets the content length in bytes
	 * 
	 * @param length  the content length in bytes
	 */
	void setContentLength(int length);
	
	

	/**
	 * sets the MIME type of the body of the message
	 * 
	 * @param type the MIME type of the body of the message
	 */
	void setContentType(String type);

	
    /**
     * Returns the MIME type of the body of the messag, or 
     * null if the type is not known. 
     *
     * @return  a String containing the name of the MIME type of 
     * 			the message, or null if the type is not known
     */
	String getContentType();
		
	

	/**
	 * returns the Transfer-Encoding header parameter or null if the header is not set
     *
     * @return the Transfer-Encoding header parameter or null if the header is not set
	 */
	String getTransferEncoding();

	
	/**
	 * sets the Transfer-Encoding parameter
	 *   
	 * @param transferEncoding the Transfer-Encoding parameter
	 */
	void setTransferEncoding(String transferEncoding);
	
	
    /**
     * Returns the name of the character encoding used in the body of this
     * message.  If the header defines no encoding, the default encoding will be returned
     *
     * @return a String containing the name of the character encoding
     *
     */
	String getCharacterEncoding();
	
	
	/**
	 * returns the message header 
	 * 
	 * @return the message header
	 */
	IHttpMessageHeader getMessageHeader();
	
	
	
	/**
	 * Returns the name and version of the protocol the message 
	 * uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1.  
	 * 
	 * @return a String containing the protocol name and version number
	 */
	String getProtocol();
	


	/**
	 * Returns the version of the protocol the message 
	 * uses in the form majorVersion.minorVersion, for example, 1.1.  
	 * 
	 * @return a String containing the protocol version number
	 */
	String getProtocolVersion();
	
	
	   

    /**
     * Stores an attribute in this header. Attributes are reset between messages.  
     *
     * 

Attribute names should follow the same conventions as
     * package names. 
     *
     * @param name		a String specifying 
     *					the name of the attribute
     * @param o			the Object to be stored
     *
     */
    void setAttribute(String name, Object o);
    


    /**
     * Returns the value of the named attribute as an Object,
     * or null if no attribute of the given name exists. 
     *
     * 

Attribute names should follow the same conventions as package
     * names.
     *
     * @param name	a String specifying the name of the attribute
     * @return  an Object containing the value of the attribute, 
     *          or null if the attribute does not exist
     */
    Object getAttribute(String name);
    
    

    /**
     * Returns an Enumeration containing the
     * names of the attributes available to this message. 
     * This method returns an empty Enumeration
     * if the message has no attributes available to it.
     * 
     *
     * @return an Enumeration of strings containing the names
     *         of the message's attributes
     *
     */
    @SuppressWarnings("unchecked")
	Enumeration getAttributeNames();
    
    

    /**
     * Returns an Set containing the
     * names of the attributes available to this messaget. 
     * This method returns an empty Set
     * if the request has no attributes available to it.
     * 
     *
     * @return	an Set of strings 
     *			containing the names of the message's attributes
     *
     */
    Set getAttributeNameSet();
  

    /**
     * removes all hop-by-hop headers without Transfer-Encoding if set to chunked 
     */
    void removeHopByHopHeaders();    
}