<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_40) on Fri Oct 18 06:47:25 UTC 2013 -->
<title>HttpInputStream (MX4J API)</title>
<meta name="date" content="2013-10-18">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="HttpInputStream (MX4J API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/HttpInputStream.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../mx4j/tools/adaptor/http/HttpException.html" title="class in mx4j.tools.adaptor.http"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../mx4j/tools/adaptor/http/HttpOutputStream.html" title="class in mx4j.tools.adaptor.http"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?mx4j/tools/adaptor/http/HttpInputStream.html" target="_top">Frames</a></li>
<li><a href="HttpInputStream.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#fields_inherited_from_class_java.io.BufferedInputStream">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">mx4j.tools.adaptor.http</div>
<h2 title="Class HttpInputStream" class="title">Class HttpInputStream</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.io.InputStream</li>
<li>
<ul class="inheritance">
<li>java.io.FilterInputStream</li>
<li>
<ul class="inheritance">
<li>java.io.BufferedInputStream</li>
<li>
<ul class="inheritance">
<li>mx4j.tools.adaptor.http.HttpInputStream</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Closeable, java.lang.AutoCloseable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">HttpInputStream</span>
extends java.io.BufferedInputStream</pre>
<div class="block">HttpInputStream processes an HTTP request</div>
<dl><dt><span class="strong">Version:</span></dt>
<dd>$Revision: 1.3 $</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_java.io.BufferedInputStream">
<!-- -->
</a>
<h3>Fields inherited from class java.io.BufferedInputStream</h3>
<code>buf, count, marklimit, markpos, pos</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_java.io.FilterInputStream">
<!-- -->
</a>
<h3>Fields inherited from class java.io.FilterInputStream</h3>
<code>in</code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../mx4j/tools/adaptor/http/HttpInputStream.html#HttpInputStream(java.io.InputStream)">HttpInputStream</a></strong>(java.io.InputStream in)</code>
<div class="block">Constructs a new HttpInputStream</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../mx4j/tools/adaptor/http/HttpInputStream.html#getHeader(java.lang.String)">getHeader</a></strong>(java.lang.String name)</code>
<div class="block">Returns a given header by name, assumes lower case</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Map</code></td>
<td class="colLast"><code><strong><a href="../../../../mx4j/tools/adaptor/http/HttpInputStream.html#getHeaders()">getHeaders</a></strong>()</code>
<div class="block">Returns a given header by name, assumes lower case</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../mx4j/tools/adaptor/http/HttpInputStream.html#getMethod()">getMethod</a></strong>()</code>
<div class="block">Returns the method of the request</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../mx4j/tools/adaptor/http/HttpInputStream.html#getPath()">getPath</a></strong>()</code>
<div class="block">Returns the path of the request</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../mx4j/tools/adaptor/http/HttpInputStream.html#getQueryString()">getQueryString</a></strong>()</code>
<div class="block">Returns the query string</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../mx4j/tools/adaptor/http/HttpInputStream.html#getVariable(java.lang.String)">getVariable</a></strong>(java.lang.String name)</code>
<div class="block">Returns one variable value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Map</code></td>
<td class="colLast"><code><strong><a href="../../../../mx4j/tools/adaptor/http/HttpInputStream.html#getVariables()">getVariables</a></strong>()</code>
<div class="block">Returns a map with the variables passed in the request.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><strong><a href="../../../../mx4j/tools/adaptor/http/HttpInputStream.html#getVariableValues(java.lang.String)">getVariableValues</a></strong>(java.lang.String name)</code>
<div class="block">Returns one variable values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><strong><a href="../../../../mx4j/tools/adaptor/http/HttpInputStream.html#getVersion()">getVersion</a></strong>()</code>
<div class="block">Returns the version of the request</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../mx4j/tools/adaptor/http/HttpInputStream.html#parseMethod(java.lang.String)">parseMethod</a></strong>(java.lang.String method)</code>
<div class="block">Parses the connection method.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../mx4j/tools/adaptor/http/HttpInputStream.html#parseRequest(java.lang.String)">parseRequest</a></strong>(java.lang.String request)</code>
<div class="block">Parses the request</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../mx4j/tools/adaptor/http/HttpInputStream.html#parseVariables()">parseVariables</a></strong>()</code>
<div class="block">Parses the request parameters</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../mx4j/tools/adaptor/http/HttpInputStream.html#parseVersion(java.lang.String)">parseVersion</a></strong>(java.lang.String verStr)</code>
<div class="block">Parses the request HttpConstants version</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../mx4j/tools/adaptor/http/HttpInputStream.html#readHeaders()">readHeaders</a></strong>()</code>
<div class="block">Reads the headers</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../mx4j/tools/adaptor/http/HttpInputStream.html#readLine()">readLine</a></strong>()</code>
<div class="block">Reads an HTTP line</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../mx4j/tools/adaptor/http/HttpInputStream.html#readRequest()">readRequest</a></strong>()</code>
<div class="block">Reads the request parsing the headers</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.io.BufferedInputStream">
<!-- -->
</a>
<h3>Methods inherited from class java.io.BufferedInputStream</h3>
<code>available, close, mark, markSupported, read, read, reset, skip</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.io.FilterInputStream">
<!-- -->
</a>
<h3>Methods inherited from class java.io.FilterInputStream</h3>
<code>read</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="HttpInputStream(java.io.InputStream)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>HttpInputStream</h4>
<pre>public HttpInputStream(java.io.InputStream in)</pre>
<div class="block">Constructs a new HttpInputStream</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - InputStream</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getMethod()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMethod</h4>
<pre>public java.lang.String getMethod()</pre>
<div class="block">Returns the method of the request</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the method of the request GET/POST</dd></dl>
</li>
</ul>
<a name="getPath()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPath</h4>
<pre>public java.lang.String getPath()</pre>
<div class="block">Returns the path of the request</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the path of the request</dd></dl>
</li>
</ul>
<a name="getQueryString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueryString</h4>
<pre>public java.lang.String getQueryString()</pre>
<div class="block">Returns the query string</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The queryString value</dd></dl>
</li>
</ul>
<a name="getVersion()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVersion</h4>
<pre>public float getVersion()</pre>
<div class="block">Returns the version of the request</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The version value 1.0/1.1</dd></dl>
</li>
</ul>
<a name="getHeader(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeader</h4>
<pre>public java.lang.String getHeader(java.lang.String name)</pre>
<div class="block">Returns a given header by name, assumes lower case</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Name of the header</dd>
<dt><span class="strong">Returns:</span></dt><dd>The header value</dd></dl>
</li>
</ul>
<a name="getHeaders()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeaders</h4>
<pre>public java.util.Map getHeaders()</pre>
<div class="block">Returns a given header by name, assumes lower case</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Name of the header</dd>
<dt><span class="strong">Returns:</span></dt><dd>The header value</dd></dl>
</li>
</ul>
<a name="readRequest()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readRequest</h4>
<pre>public void readRequest()
throws java.io.IOException</pre>
<div class="block">Reads the request parsing the headers</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - Description of Exception</dd></dl>
</li>
</ul>
<a name="readLine()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readLine</h4>
<pre>public java.lang.String readLine()
throws java.io.IOException</pre>
<div class="block">Reads an HTTP line</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A read line</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - Emmited in case of errors reading the stream</dd></dl>
</li>
</ul>
<a name="getVariables()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVariables</h4>
<pre>public java.util.Map getVariables()</pre>
<div class="block">Returns a map with the variables passed in the request.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A map containing variables/value pairs. If a variable is
<p/>
present only once in the request the value will be a String.
<p/>
If it is present many times the variable will be a String[]</dd></dl>
</li>
</ul>
<a name="getVariable(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVariable</h4>
<pre>public java.lang.String getVariable(java.lang.String name)</pre>
<div class="block">Returns one variable value. If the variable is present many times, the first
<p/>
instance will be returned</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A String with the variable value</dd></dl>
</li>
</ul>
<a name="getVariableValues(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVariableValues</h4>
<pre>public java.lang.String[] getVariableValues(java.lang.String name)</pre>
<div class="block">Returns one variable values.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A String array with all variable instances</dd></dl>
</li>
</ul>
<a name="parseVariables()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseVariables</h4>
<pre>protected void parseVariables()
throws <a href="../../../../mx4j/tools/adaptor/http/HttpException.html" title="class in mx4j.tools.adaptor.http">HttpException</a></pre>
<div class="block">Parses the request parameters</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../mx4j/tools/adaptor/http/HttpException.html" title="class in mx4j.tools.adaptor.http">HttpException</a></code></dd></dl>
</li>
</ul>
<a name="parseMethod(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseMethod</h4>
<pre>protected void parseMethod(java.lang.String method)
throws <a href="../../../../mx4j/tools/adaptor/http/HttpException.html" title="class in mx4j.tools.adaptor.http">HttpException</a></pre>
<div class="block">Parses the connection method. GET/POST are allowed</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>method</code> - Description of Parameter</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../mx4j/tools/adaptor/http/HttpException.html" title="class in mx4j.tools.adaptor.http">HttpException</a></code> - Description of Exception</dd></dl>
</li>
</ul>
<a name="parseRequest(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseRequest</h4>
<pre>protected void parseRequest(java.lang.String request)
throws <a href="../../../../mx4j/tools/adaptor/http/HttpException.html" title="class in mx4j.tools.adaptor.http">HttpException</a></pre>
<div class="block">Parses the request</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - Request string</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../mx4j/tools/adaptor/http/HttpException.html" title="class in mx4j.tools.adaptor.http">HttpException</a></code> - Thrown if an error ocurr</dd></dl>
</li>
</ul>
<a name="parseVersion(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseVersion</h4>
<pre>protected void parseVersion(java.lang.String verStr)
throws <a href="../../../../mx4j/tools/adaptor/http/HttpException.html" title="class in mx4j.tools.adaptor.http">HttpException</a></pre>
<div class="block">Parses the request HttpConstants version</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>verStr</code> - String containing the HTTP version</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../mx4j/tools/adaptor/http/HttpException.html" title="class in mx4j.tools.adaptor.http">HttpException</a></code></dd></dl>
</li>
</ul>
<a name="readHeaders()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>readHeaders</h4>
<pre>protected void readHeaders()
throws java.io.IOException</pre>
<div class="block">Reads the headers</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/HttpInputStream.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../mx4j/tools/adaptor/http/HttpException.html" title="class in mx4j.tools.adaptor.http"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../mx4j/tools/adaptor/http/HttpOutputStream.html" title="class in mx4j.tools.adaptor.http"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?mx4j/tools/adaptor/http/HttpInputStream.html" target="_top">Frames</a></li>
<li><a href="HttpInputStream.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#fields_inherited_from_class_java.io.BufferedInputStream">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><center><small>Copyright © 2001-2005 The MX4J Contributors. All Rights Reserved.</small></center></small></p>
</body>
</html>
