/lib/docs/org/apache/xmlrpc/util/HttpUtil.html
HTML | 401 lines | 337 code | 42 blank | 22 comment | 0 complexity | 24086d266105390b98a569a6a8c7af5e MD5 | raw file
Possible License(s): LGPL-3.0, Apache-2.0, GPL-3.0, GPL-2.0, AGPL-3.0, JSON, BSD-3-Clause
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <!--NewPage-->
- <HTML>
- <HEAD>
- <!-- Generated by javadoc (build 1.6.0_0) on Mon Apr 20 21:45:57 CEST 2009 -->
- <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
- <TITLE>
- HttpUtil (Apache XML-RPC 3.1.2 API)
- </TITLE>
- <META NAME="date" CONTENT="2009-04-20">
- <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
- <SCRIPT type="text/javascript">
- function windowTitle()
- {
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="HttpUtil (Apache XML-RPC 3.1.2 API)";
- }
- }
- </SCRIPT>
- <NOSCRIPT>
- </NOSCRIPT>
- </HEAD>
- <BODY BGCOLOR="white" onload="windowTitle();">
- <HR>
- <!-- ========= START OF TOP NAVBAR ======= -->
- <A NAME="navbar_top"><!-- --></A>
- <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
- <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
- <TR>
- <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
- <A NAME="navbar_top_firstrow"><!-- --></A>
- <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
- <TR ALIGN="center" VALIGN="top">
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
- <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/HttpUtil.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
- </TR>
- </TABLE>
- </TD>
- <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
- </EM>
- </TD>
- </TR>
- <TR>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- PREV CLASS
- <A HREF="../../../../org/apache/xmlrpc/util/LimitedInputStream.html" title="class in org.apache.xmlrpc.util"><B>NEXT CLASS</B></A></FONT></TD>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../index.html?org/apache/xmlrpc/util/HttpUtil.html" target="_top"><B>FRAMES</B></A>
- <A HREF="HttpUtil.html" target="_top"><B>NO FRAMES</B></A>
- <SCRIPT type="text/javascript">
- <!--
- if(window==top) {
- document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
- }
- //-->
- </SCRIPT>
- <NOSCRIPT>
- <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
- </NOSCRIPT>
- </FONT></TD>
- </TR>
- <TR>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
- </TR>
- </TABLE>
- <A NAME="skip-navbar_top"></A>
- <!-- ========= END OF TOP NAVBAR ========= -->
- <HR>
- <!-- ======== START OF CLASS DATA ======== -->
- <H2>
- <FONT SIZE="-1">
- org.apache.xmlrpc.util</FONT>
- <BR>
- Class HttpUtil</H2>
- <PRE>
- java.lang.Object
- <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.xmlrpc.util.HttpUtil</B>
- </PRE>
- <HR>
- <DL>
- <DT><PRE>public class <B>HttpUtil</B><DT>extends java.lang.Object</DL>
- </PRE>
- <P>
- Provides utility functions useful in HTTP communications
- <P>
- <P>
- <HR>
- <P>
- <!-- ======== CONSTRUCTOR SUMMARY ======== -->
- <A NAME="constructor_summary"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
- <B>Constructor Summary</B></FONT></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/util/HttpUtil.html#HttpUtil()">HttpUtil</A></B>()</CODE>
- <BR>
- </TD>
- </TR>
- </TABLE>
-
- <!-- ========== METHOD SUMMARY =========== -->
- <A NAME="method_summary"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
- <B>Method Summary</B></FONT></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static java.lang.String</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/util/HttpUtil.html#encodeBasicAuthentication(java.lang.String, java.lang.String, java.lang.String)">encodeBasicAuthentication</A></B>(java.lang.String pUser,
- java.lang.String pPassword,
- java.lang.String pEncoding)</CODE>
- <BR>
- Creates the Base64 encoded credentials for HTTP Basic Authentication.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static java.lang.String</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/util/HttpUtil.html#getNonIdentityTransferEncoding(java.lang.String)">getNonIdentityTransferEncoding</A></B>(java.lang.String pHeaderValue)</CODE>
- <BR>
- Returns, whether the HTTP header value <code>pHeaderValue</code>
- indicates, that another encoding than "identity" is used.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static boolean</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/util/HttpUtil.html#isUsingGzipEncoding(java.util.Enumeration)">isUsingGzipEncoding</A></B>(java.util.Enumeration pValues)</CODE>
- <BR>
- Returns, whether the HTTP header values in <code>pValues</code>
- indicate, that GZIP encoding is used or may be used.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static boolean</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/util/HttpUtil.html#isUsingGzipEncoding(java.lang.String)">isUsingGzipEncoding</A></B>(java.lang.String pHeaderValue)</CODE>
- <BR>
- Returns, whether the HTTP header value <code>pHeaderValue</code>
- indicates, that GZIP encoding is used or may be used.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/util/HttpUtil.html#parseAuthorization(org.apache.xmlrpc.common.XmlRpcHttpRequestConfigImpl, java.lang.String)">parseAuthorization</A></B>(<A HREF="../../../../org/apache/xmlrpc/common/XmlRpcHttpRequestConfigImpl.html" title="class in org.apache.xmlrpc.common">XmlRpcHttpRequestConfigImpl</A> pConfig,
- java.lang.String pLine)</CODE>
- <BR>
- Parses an "Authorization" header and adds the username and password
- to <code>pConfig</code>.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static java.lang.String</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/util/HttpUtil.html#readLine(java.io.InputStream, byte[])">readLine</A></B>(java.io.InputStream pIn,
- byte[] pBuffer)</CODE>
- <BR>
- Reads a header line from the input stream <code>pIn</code>
- and converts it into a string.</TD>
- </TR>
- </TABLE>
- <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
- <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
- </TR>
- </TABLE>
-
- <P>
- <!-- ========= CONSTRUCTOR DETAIL ======== -->
- <A NAME="constructor_detail"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
- <B>Constructor Detail</B></FONT></TH>
- </TR>
- </TABLE>
- <A NAME="HttpUtil()"><!-- --></A><H3>
- HttpUtil</H3>
- <PRE>
- public <B>HttpUtil</B>()</PRE>
- <DL>
- </DL>
- <!-- ============ METHOD DETAIL ========== -->
- <A NAME="method_detail"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
- <B>Method Detail</B></FONT></TH>
- </TR>
- </TABLE>
- <A NAME="encodeBasicAuthentication(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- encodeBasicAuthentication</H3>
- <PRE>
- public static java.lang.String <B>encodeBasicAuthentication</B>(java.lang.String pUser,
- java.lang.String pPassword,
- java.lang.String pEncoding)
- throws java.io.UnsupportedEncodingException</PRE>
- <DL>
- <DD>Creates the Base64 encoded credentials for HTTP Basic Authentication.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>pUser</CODE> - User name, or null, if no Basic Authentication is being used.<DD><CODE>pPassword</CODE> - Users password, or null, if no Basic Authentication is being used.<DD><CODE>pEncoding</CODE> - Encoding being used for conversion of the credential string into a byte array.
- <DT><B>Returns:</B><DD>Base64 encoded credentials, for use in the HTTP header
- <DT><B>Throws:</B>
- <DD><CODE>java.io.UnsupportedEncodingException</CODE> - The encoding <code>pEncoding</code> is invalid.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="isUsingGzipEncoding(java.lang.String)"><!-- --></A><H3>
- isUsingGzipEncoding</H3>
- <PRE>
- public static boolean <B>isUsingGzipEncoding</B>(java.lang.String pHeaderValue)</PRE>
- <DL>
- <DD>Returns, whether the HTTP header value <code>pHeaderValue</code>
- indicates, that GZIP encoding is used or may be used.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>pHeaderValue</CODE> - The HTTP header value being parsed. This is typically
- the value of "Content-Encoding", or "Accept-Encoding".
- <DT><B>Returns:</B><DD>True, if the header value suggests that GZIP encoding is or may
- be used.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getNonIdentityTransferEncoding(java.lang.String)"><!-- --></A><H3>
- getNonIdentityTransferEncoding</H3>
- <PRE>
- public static java.lang.String <B>getNonIdentityTransferEncoding</B>(java.lang.String pHeaderValue)</PRE>
- <DL>
- <DD>Returns, whether the HTTP header value <code>pHeaderValue</code>
- indicates, that another encoding than "identity" is used.
- This is typically the value of "Transfer-Encoding", or "TE".
- <P>
- <DD><DL>
- <DT><B>Returns:</B><DD>Null, if the transfer encoding in use is "identity".
- Otherwise, another transfer encoding.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="isUsingGzipEncoding(java.util.Enumeration)"><!-- --></A><H3>
- isUsingGzipEncoding</H3>
- <PRE>
- public static boolean <B>isUsingGzipEncoding</B>(java.util.Enumeration pValues)</PRE>
- <DL>
- <DD>Returns, whether the HTTP header values in <code>pValues</code>
- indicate, that GZIP encoding is used or may be used.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>pValues</CODE> - The HTTP header values being parsed. These are typically
- the values of "Content-Encoding", or "Accept-Encoding".
- <DT><B>Returns:</B><DD>True, if the header values suggests that GZIP encoding is or may
- be used.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="readLine(java.io.InputStream, byte[])"><!-- --></A><H3>
- readLine</H3>
- <PRE>
- public static java.lang.String <B>readLine</B>(java.io.InputStream pIn,
- byte[] pBuffer)
- throws java.io.IOException</PRE>
- <DL>
- <DD>Reads a header line from the input stream <code>pIn</code>
- and converts it into a string.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>pIn</CODE> - The input stream being read.<DD><CODE>pBuffer</CODE> - A buffer being used for temporary storage.
- The buffers length is a limit of the header lines length.
- <DT><B>Returns:</B><DD>Next header line or null, if no more header lines
- are available.
- <DT><B>Throws:</B>
- <DD><CODE>java.io.IOException</CODE> - Reading the header line failed.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="parseAuthorization(org.apache.xmlrpc.common.XmlRpcHttpRequestConfigImpl, java.lang.String)"><!-- --></A><H3>
- parseAuthorization</H3>
- <PRE>
- public static void <B>parseAuthorization</B>(<A HREF="../../../../org/apache/xmlrpc/common/XmlRpcHttpRequestConfigImpl.html" title="class in org.apache.xmlrpc.common">XmlRpcHttpRequestConfigImpl</A> pConfig,
- java.lang.String pLine)</PRE>
- <DL>
- <DD>Parses an "Authorization" header and adds the username and password
- to <code>pConfig</code>.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>pConfig</CODE> - The request configuration being created.<DD><CODE>pLine</CODE> - The header being parsed, including the "basic" part.</DL>
- </DD>
- </DL>
- <!-- ========= END OF CLASS DATA ========= -->
- <HR>
- <!-- ======= START OF BOTTOM NAVBAR ====== -->
- <A NAME="navbar_bottom"><!-- --></A>
- <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
- <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
- <TR>
- <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
- <A NAME="navbar_bottom_firstrow"><!-- --></A>
- <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
- <TR ALIGN="center" VALIGN="top">
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
- <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/HttpUtil.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
- </TR>
- </TABLE>
- </TD>
- <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
- </EM>
- </TD>
- </TR>
- <TR>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- PREV CLASS
- <A HREF="../../../../org/apache/xmlrpc/util/LimitedInputStream.html" title="class in org.apache.xmlrpc.util"><B>NEXT CLASS</B></A></FONT></TD>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../index.html?org/apache/xmlrpc/util/HttpUtil.html" target="_top"><B>FRAMES</B></A>
- <A HREF="HttpUtil.html" target="_top"><B>NO FRAMES</B></A>
- <SCRIPT type="text/javascript">
- <!--
- if(window==top) {
- document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
- }
- //-->
- </SCRIPT>
- <NOSCRIPT>
- <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
- </NOSCRIPT>
- </FONT></TD>
- </TR>
- <TR>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
- </TR>
- </TABLE>
- <A NAME="skip-navbar_bottom"></A>
- <!-- ======== END OF BOTTOM NAVBAR ======= -->
- <HR>
- Copyright © 2001-2009 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
- </BODY>
- </HTML>