org.apache.commons.httpclient.util

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> apache >> commons >> httpclient >> [ util overview ]

PREV PACKAGE NEXT PACKAGE

Package org.apache.commons.httpclient.util

Classes and interfaces supporting the client side of the HTTP protocol.

See:
Description

Class Summary

Base64 Deprecated. The commons-codec Base64 class will be used in HttpClient 2.1

DateParser Deprecated. Use DateUtil

DateUtil A utility class for parsing and formatting HTTP dates as used in cookies and other headers.

EncodingUtil The home for utility methods that handle various encoding tasks.

ExceptionUtil The home for utility methods that handle various exception-related tasks.

HttpURLConnection Provides a HttpURLConnection wrapper around HttpClient's HttpMethod.

IdleConnectionHandler A helper class for connection managers to track idle connections.

IdleConnectionTimeoutThread A utility class for periodically closing idle connections.

LangUtils A set of utility methods to help produce consistent Object#equals(Object) and Object#hashCode methods.

ParameterFormatter This formatter produces a textual representation of attribute/value pairs.

ParameterParser A simple parser intended to parse sequences of name/value pairs.

TimeoutController Executes a task with a specified timeout.

URIUtil The URI escape and character encoding and decoding utility.

URIUtil.Coder Deprecated. use org.apache.commons.codec.net.URLCodec

Exception Summary

DateParseException An exception to indicate an error parsing a date string.

TimeoutController.TimeoutException Signals that the task timed out.

Package org.apache.commons.httpclient.util Description

Classes and interfaces supporting the client side of the HTTP protocol.

The HttpClient component supports the client-side of RFC 1945 (HTTP/1.0) and RFC 2616 (HTTP/1.1), several related specifications (RFC 2109 (Cookies), RFC 2617 (HTTP Authentication), etc.), and provides a framework by which new request types (methods) or HTTP extensions can can be easily created or supported.

The basis for the abstraction is provided by three types:

org.apache.commons.httpclient.HttpConnection: represents a network connection to some HTTP host.
org.apache.commons.httpclient.HttpMethod: represents a request to be made over some org.apache.commons.httpclient.HttpConnection and contains the server's response.
org.apache.commons.httpclient.HttpState: contains the HTTP attributes that may persist from request to request, such as cookies and authentication credentials.

and several simple bean-style classes:

org.apache.commons.httpclient.Cookie: represents HTTP cookie.
org.apache.commons.httpclient.Credentials: an interface representing a set of authentication credentials.
org.apache.commons.httpclient.Header: represents an HTTP request or response header.
org.apache.commons.httpclient.HeaderElement: represents a single element of a multi-part header.
org.apache.commons.httpclient.UsernamePasswordCredentials: a username and password pair.

org.apache.commons.httpclient.HttpClient provides a simple "user-agent" implementation that will suffice for many applications, but whose use is not required.

HttpClient also provides several utilities that may be useful when extending the framework:

org.apache.commons.httpclient.HttpMethodBase: an abstract base implementation of HttpMethod, which may be extended to create new method types or to support additional protocol HTTP features.
org.apache.commons.httpclient.HttpStatus: an enumeration of HttpStatus codes.
org.apache.commons.httpclient.ChunkedOutputStream: an java.io.OutputStream wrapper supporting the "chunked" transfer encoding.
org.apache.commons.httpclient.ChunkedInputStream: an java.io.InputStream wrapper supporting the "chunked" transfer encoding.
URIUtil: provides utilities for encoding and decoding URI's in the %HH format.

HttpClient Configuration with Java Properties

Java properties can be set at run time with the

-Dname=value
         command line arguments to the application that uses HttpClient.
         These properties can also be set programaticly by calling
         System.getProperties().setProperty(name, value).
         This is the list of properties that HttpClient recognizes:
         
         Name
             Type
             Effect
         
	 httpclient.useragent
             String
             Sets the User-Agent string to be sent on every HTTP request.
         
	 httpclient.authentication.preemptive
             boolean
             Sends authorization credentials without requiring explicit requests
                 from the web server
         
         












  
      Overview 
    Package 
      Class 
      Use 
      Deprecated 
      Index 
  









Home >> All >> org  >> apache  >> commons  >> httpclient  >> [ util overview ]

 PREV PACKAGE  NEXT PACKAGE

Class Summary
Base64	Deprecated. The commons-codec Base64 class will be used in HttpClient 2.1
DateParser	Deprecated. Use DateUtil
DateUtil	A utility class for parsing and formatting HTTP dates as used in cookies and other headers.
EncodingUtil	The home for utility methods that handle various encoding tasks.
ExceptionUtil	The home for utility methods that handle various exception-related tasks.
HttpURLConnection	Provides a `HttpURLConnection` wrapper around HttpClient's `HttpMethod`.
IdleConnectionHandler	A helper class for connection managers to track idle connections.
IdleConnectionTimeoutThread	A utility class for periodically closing idle connections.
LangUtils	A set of utility methods to help produce consistent Object#equals(Object) and Object#hashCode methods.
ParameterFormatter	This formatter produces a textual representation of attribute/value pairs.
ParameterParser	A simple parser intended to parse sequences of name/value pairs.
TimeoutController	Executes a task with a specified timeout.
URIUtil	The URI escape and character encoding and decoding utility.
URIUtil.Coder	Deprecated. use org.apache.commons.codec.net.URLCodec

Exception Summary
DateParseException	An exception to indicate an error parsing a date string.
TimeoutController.TimeoutException	Signals that the task timed out.

Name	Type	Effect
httpclient.useragent	String	Sets the User-Agent string to be sent on every HTTP request.
httpclient.authentication.preemptive	boolean	Sends authorization credentials without requiring explicit requests from the web server