api/src/java/javax/portlet/ActionRequest.java

/*
 * Copyright 2003,2004 The Apache Software Foundation.
 * 
 * Licensed 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.
 */
/*
 * This source code implements specifications defined by the Java
 * Community Process. In order to remain compliant with the specification
 * DO NOT add / change / or delete method signatures!
 */
package javax.portlet;


/**
 * The <CODE>ActionRequest</CODE> represents the request sent to the portlet
 * to handle an action.
 * It extends the PortletRequest interface to provide action request
 * information to portlets.<br>
 * The portlet container creates an <CODE>ActionRequest</CODE> object and
 * passes it as argument to the portlet's <CODE>processAction</CODE> method.
 * 
 * @see PortletRequest
 * @see RenderRequest
 */
public interface ActionRequest extends PortletRequest
{



  /**
   * Retrieves the body of the HTTP request from client to
   * portal as binary data using
   * an <CODE>InputStream</CODE>. Either this method or 
   * {@link #getReader} may be called to read the body, but not both.
   * <p>
   * For HTTP POST data of type application/x-www-form-urlencoded
   * this method throws an <code>IllegalStateException</code>
   * as this data has been already processed by the 
   * portal/portlet-container and is available as request parameters.
   *
   * @return an input stream containing the body of the request
   *
   * @exception java.lang.IllegalStateException
   *                   if getReader was already called, or it is a 
   *                   HTTP POST data of type application/x-www-form-urlencoded
   * @exception java.io.IOException
   *                   if an input or output exception occurred
   */
  public java.io.InputStream getPortletInputStream () throws java.io.IOException;



  /**
   * Overrides the name of the character encoding used in the body of this
   * request. This method must be called prior to reading input 
   * using {@link #getReader} or {@link #getPortletInputStream}.
   * <p>
   * This method only sets the character set for the Reader that the
   * {@link #getReader} method returns.
   *
   * @param	enc	a <code>String</code> containing the name of 
   *			the chararacter encoding.
   *
   * @exception		java.io.UnsupportedEncodingException if this is not a valid encoding
   * @exception		java.lang.IllegalStateException      if this method is called after 
   *                                   reading request parameters or reading input using 
   *                                   <code>getReader()</code>
   */

  public void setCharacterEncoding(String enc) 
    throws java.io.UnsupportedEncodingException;


  /**
   * Retrieves the body of the HTTP request from the client to the portal
   * as character data using
   * a <code>BufferedReader</code>.  The reader translates the character
   * data according to the character encoding used on the body.
   * Either this method or {@link #getPortletInputStream} may be called to read the
   * body, not both.
   * <p>
   * For HTTP POST data of type application/x-www-form-urlencoded
   * this method throws an <code>IllegalStateException</code>
   * as this data has been already processed by the 
   * portal/portlet-container and is available as request parameters.
   *
   * @return	a <code>BufferedReader</code>
   *		containing the body of the request	
   *
   * @exception  java.io.UnsupportedEncodingException 	
   *                 if the character set encoding used is 
   * 		     not supported and the text cannot be decoded
   * @exception  java.lang.IllegalStateException   	
   *                 if {@link #getPortletInputStream} method
   * 		     has been called on this request,  it is a 
   *                   HTTP POST data of type application/x-www-form-urlencoded.
   * @exception  java.io.IOException
   *                 if an input or output exception occurred
   *
   * @see #getPortletInputStream
   */
  
  public java.io.BufferedReader getReader()
    throws java.io.UnsupportedEncodingException, java.io.IOException;
    
    
  /**
   * Returns the name of the character encoding used in the body of this request.
   * This method returns <code>null</code> if the request
   * does not specify a character encoding.
   *
   * @return		a <code>String</code> containing the name of 
   *			the chararacter encoding, or <code>null</code>
   *			if the request does not specify a character encoding.
   */
  
  public java.lang.String getCharacterEncoding();



  /**
   * Returns the MIME type of the body of the request, 
   * or null if the type is not known.
   *
   * @return		a <code>String</code> containing the name 
   *			of the MIME type of the request, or null 
   *                    if the type is not known.
   */

  public java.lang.String getContentType();


  /**
   * Returns the length, in bytes, of the request body 
   * which is made available by the input stream, or -1 if the
   * length is not known. 
   *
   *
   * @return		an integer containing the length of the 
   * 			request body or -1 if the length is not known
   *
   */

  public int getContentLength();
    

    

}