Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.apache.commons.httpclient.auth.* (26)org.apache.commons.httpclient.contrib.* (12)
org.apache.commons.httpclient.cookie.* (16)org.apache.commons.httpclient.methods.* (28)
org.apache.commons.httpclient.params.* (12)org.apache.commons.httpclient.protocol.* (7)
org.apache.commons.httpclient.server.* (26)org.apache.commons.httpclient.ssl.* (2)
org.apache.commons.httpclient.util.* (14)

org.apache.commons.httpclient: Javadoc index of package org.apache.commons.httpclient.


Package Samples:

org.apache.commons.httpclient.methods.multipart: Classes implementing org.apache.commons.httpclient.HttpMethod     for the base HTTP methods.  
org.apache.commons.httpclient.util: Classes and interfaces supporting the client side of the HTTP protocol.  
org.apache.commons.httpclient.server
org.apache.commons.httpclient.methods
org.apache.commons.httpclient.cookie
org.apache.commons.httpclient.protocol
org.apache.commons.httpclient.auth
org.apache.commons.httpclient.contrib.ssl
org.apache.commons.httpclient.contrib.utils
org.apache.commons.httpclient.params
org.apache.commons.httpclient.contrib.methods.multipart
org.apache.commons.httpclient.contrib.proxy
org.apache.commons.httpclient.ssl

Classes:

AuthSSLProtocolSocketFactory: AuthSSLProtocolSocketFactory can be used to validate the identity of the HTTPS server against a list of trusted certificates and to authenticate to the HTTPS server using a private key. AuthSSLProtocolSocketFactory will enable server authentication when supplied with a truststore file containg one or several trusted certificates. The client secure socket will reject the connection during the SSL session handshake if the target HTTPS server attempts to authenticate itself with a non-trusted certificate. Use JDK keytool utility to import a trusted certificate and generate a truststore file: keytool ...
URI: The interface for the URI(Uniform Resource Identifiers) version of RFC 2396. This class has the purpose of supportting of parsing a URI reference to extend any specific protocols, the character encoding of the protocol to be transported and the charset of the document. A URI is always in an "escaped" form, since escaping or unescaping a completed URI might change its semantics. Implementers should be careful not to escape or unescape the same string more than once, since unescaping an already unescaped string might lead to misinterpreting a percent data character as another escaped character, or ...
HttpConnection: An abstraction of an HTTP java.io.InputStream and java.io.OutputStream pair, together with the relevant attributes. The following options are set on the socket before getting the input/output streams in the open() 55 method: Socket Method Sockets Option Configuration Socket.setTcpNoDelay(boolean) > Socket.setTcpNoDelay(boolean) 55 SO_NODELAY HttpConnectionParams.setTcpNoDelay(boolean) > HttpConnectionParams.setTcpNoDelay(boolean) 55 Socket.setSoTimeout(int) > Socket.setSoTimeout(int) 55 SO_TIMEOUT HttpConnectionParams.setSoTimeout(int) > HttpConnectionParams.setSoTimeout(int) 55 Socket.setSendBufferSize(int) ...
ParameterFormatter: This formatter produces a textual representation of attribute/value pairs. It comforms to the generic grammar and formatting rules outlined in the Section 2.1 and Section 3.6 of RFC 2616 2.1 Augmented BNF Many HTTP/1.1 header field values consist of words separated by LWS or special characters. These special characters MUST be in a quoted string to be used within a parameter value (as defined in section 3.6). token = 1* separators = "(" | ")" | " " | "@" | "," | ";" | ":" | "\" | | "/" | "[" | "]" | "?" | "=" | "{" | "}" | SP | HT A string of text is parsed as a single word if it is quoted using ...
HeaderElement: One element of an HTTP header's value. Some HTTP headers (such as the set-cookie header) have values that can be decomposed into multiple elements. Such headers must be in the following form: header = [ element ] *( "," [ element ] ) element = name [ "=" [ value ] ] *( ";" [ param ] ) param = name [ "=" [ value ] ] name = token value = ( token | quoted-string ) token = 1*<any char except "=", ",", ";", <"> and white space> quoted-string = <"> *( text | quoted-char ) <"> text = any char except <"> quoted-char = "\" char Any amount of white space is allowed between any ...
HttpVersion: HTTP version, as specified in RFC 2616. HTTP uses a "<major>.<minor>" numbering scheme to indicate versions of the protocol. The protocol versioning policy is intended to allow the sender to indicate the format of a message and its capacity for understanding further HTTP communication, rather than the features obtained via that communication. No change is made to the version number for the addition of message components which do not affect communication behavior or which only add to extensible field values. The <minor> number is incremented when the changes made to the protocol ...
ContentLengthInputStream: Cuts the wrapped InputStream off after a specified number of bytes. Implementation note: Choices abound. One approach would pass through the InputStream.mark(int) > InputStream.mark(int) 55 and InputStream.reset() > InputStream.reset() 55 calls to the underlying stream. That's tricky, though, because you then have to start duplicating the work of keeping track of how much a reset rewinds. Further, you have to watch out for the "readLimit", and since the semantics for the readLimit leave room for differing implementations, you might get into a lot of trouble. Alternatively, you could make this class ...
MultipartRequestEntity: Implements a request entity suitable for an HTTP multipart POST method. The HTTP multipart POST method is defined in section 3.3 of RFC1867 : The media-type multipart/form-data follows the rules of all multipart MIME data streams as outlined in RFC 1521. The multipart/form-data contains a series of parts. Each part is expected to contain a content-disposition header where the value is "form-data" and a name attribute specifies the field name within the form, e.g., 'content-disposition: form-data; name="xxxxx"', where xxxxx is the field name corresponding to that field. Field names originally in ...
EasySSLProtocolSocketFactory: EasySSLProtocolSocketFactory can be used to creats SSL java.net.Socket s that accept self-signed certificates. This socket factory SHOULD NOT be used for productive systems due to security reasons, unless it is a concious decision and you are perfectly aware of security implications of accepting self-signed certificates Example of using custom protocol socket factory for a specific host: Protocol easyhttps = new Protocol("https", new EasySSLProtocolSocketFactory(), 443); HttpClient client = new HttpClient(); client.getHostConfiguration().setHost("localhost", 443, easyhttps); // use relative url ...
HttpMethodBase: An abstract base implementation of HttpMethod. At minimum, subclasses will need to override: getName() 55 to return the approriate name for this method When a method requires additional request headers, subclasses will typically want to override: addRequestHeaders(HttpState,HttpConnection) 55 to write those headers When a method expects specific response headers, subclasses may want to override: processResponseHeaders(HttpState,HttpConnection) 55 to handle those headers
PluginProxyUtil: A utility class that gives applets the ability to detect proxy host settings. This was adapted from a post from Chris Forster on 20030227 to a Sun Java forum here: http://forum.java.sun.com/thread.jspa?threadID=364342&tstart=120 The algorithm - which relies on Sun java plugin internal classes in some cases - was maintained, but the following changes were made: 1. Logging was used to allow control of debug type messages. 2. Reflection is used instead of direct references to Sun internal classes to avoid the need to have these classes in the CLASSPATH to compile. 3. Removed the use of global variables ...
CredentialsProvider: Credentials provider interface can be used to provide HTTP method with a means to request authentication credentials if no credentials have been given or given credentials are incorrect. HttpClient makes no provisions to check whether the same credentials have been tried already. It is a responsibility of the custom credentials provider to keep track of authentication attempts and to ensure that credentials known to be invalid are not retried. HttpClient will simply store the set of credentials returned by the custom credentials provider in the http state object and will attempt to use these credentials ...
AuthScheme: This interface represents an abstract challenge-response oriented authentication scheme. An authentication scheme should be able to support the following functions: Parse and process the challenge sent by the targer server in response to request for a protected resource Provide its textual designation Provide its parameters, if available Provide the realm this authentication scheme is applicable to, if available Generate authorization string for the given set of credentials, request method and URI as specificed in the HTTP request line in response to the actual authorization challenge Authentication ...
ExpectContinueMethod: This abstract class serves as a foundation for all HTTP methods that support 'Expect: 100-continue' handshake. The purpose of the 100 (Continue) status (refer to section 10.1.1 of the RFC 2616 for more details) is to allow a client that is sending a request message with a request body to determine if the origin server is willing to accept the request (based on the request headers) before the client sends the request body. In some cases, it might either be inappropriate or highly inefficient for the client to send the body if the server will reject the message without looking at the body. 'Expect: ...
Authenticator: Utility methods for HTTP authorization and authentication. This class provides utility methods for generating responses to HTTP www and proxy authentication challenges. A client SHOULD assume that all paths at or deeper than the depth of the last symbolic element in the path field of the Request-URI also are within the protection space specified by the BasicScheme realm value of the current challenge. A client MAY preemptively send the corresponding Authorization header with requests for resources in that space without receipt of another challenge from the server. Similarly, when a client sends ...
HttpAuthenticator: Utility methods for HTTP authorization and authentication. This class provides utility methods for generating responses to HTTP www and proxy authentication challenges. A client SHOULD assume that all paths at or deeper than the depth of the last symbolic element in the path field of the Request-URI also are within the protection space specified by the basic realm value of the current challenge. A client MAY preemptively send the corresponding Authorization header with requests for resources in that space without receipt of another challenge from the server. Similarly, when a client sends a request ...
PostMethod: Implements the HTTP POST method. The HTTP POST method is defined in section 9.5 of RFC2616 : The POST method is used to request that the origin server accept the entity enclosed in the request as a new subordinate of the resource identified by the Request-URI in the Request-Line. POST is designed to allow a uniform method to cover the following functions: Annotation of existing resources Posting a message to a bulletin board, newsgroup, mailing list, or similar group of articles Providing a block of data, such as the result of submitting a form, to a data-handling process Extending a database through ...
DigestScheme: Digest authentication scheme as defined in RFC 2617. Both MD5 (default) and MD5-sess are supported. Currently only qop=auth or no qop is supported. qop=auth-int is unsupported. If auth and auth-int are provided, auth is used. Credential charset is configured via the credential charset 55 parameter. Since the digest username is included as clear text in the generated Authentication header, the charset of the username must be compatible with the http element charset 55 . TODO: make class more stateful regarding repeated authentication requests
MultipartPostMethod: Implements the HTTP multipart POST method. The HTTP multipart POST method is defined in section 3.3 of RFC1867 : The media-type multipart/form-data follows the rules of all multipart MIME data streams as outlined in RFC 1521. The multipart/form-data contains a series of parts. Each part is expected to contain a content-disposition header where the value is "form-data" and a name attribute specifies the field name within the form, e.g., 'content-disposition: form-data; name="xxxxx"', where xxxxx is the field name corresponding to that field. Field names originally in non-ASCII character sets may ...
ResponseConsumedWatcher: When a response stream has been consumed, various parts of the HttpClient implementation need to respond appropriately. When one of the three types of java.io.InputStream , one of AutoCloseInputStream (package), ContentLengthInputStream , or ChunkedInputStream finishes with its content, either because all content has been consumed, or because it was explicitly closed, it notifies its corresponding method via this interface.
HeadMethod: Implements the HTTP HEAD method. The HTTP HEAD method is defined in section 9.4 of RFC2616 : The HEAD method is identical to GET except that the server MUST NOT return a message-body in the response. The metainformation contained in the HTTP headers in response to a HEAD request SHOULD be identical to the information sent in response to a GET request. This method can be used for obtaining metainformation about the entity implied by the request without transferring the entity-body itself. This method is often used for testing hypertext links for validity, accessibility, and recent modification.
GetMethod: Implements the HTTP GET method. The HTTP GET method is defined in section 9.3 of RFC2616 : The GET method means retrieve whatever information (in the form of an entity) is identified by the Request-URI. If the Request-URI refers to a data-producing process, it is the produced data which shall be returned as the entity in the response and not the source text of the process, unless that text happens to be the output of the process. GetMethods will follow redirect requests from the http server by default. This behavour can be disabled by calling setFollowRedirects(false).
NTLM: Provides an implementation of the NTLM authentication protocol. This class provides methods for generating authentication challenge responses for the NTLM authentication protocol. The NTLM protocol is a proprietary Microsoft protocol and as such no RFC exists for it. This class is based upon the reverse engineering efforts of a wide range of people. Please note that an implementation of JCE must be correctly installed and configured when using NTLM support. This class should not be used externally to HttpClient as it's API is specifically designed to work with HttpClient's use case, in particular ...
NTLM: Provides an implementation of the NTLM authentication protocol. This class provides methods for generating authentication challenge responses for the NTLM authentication protocol. The NTLM protocol is a proprietary Microsoft protocol and as such no RFC exists for it. This class is based upon the reverse engineering efforts of a wide range of people. Please note that an implementation of JCE must be correctly installed and configured when using NTLM support. This class should not be used externally to HttpClient as it's API is specifically designed to work with HttpClient's use case, in particular ...
AuthPolicy: Authentication policy class. The Authentication policy provides corresponding authentication scheme interfrace for a given type of authorization challenge. The following specifications are provided: Basic : Basic authentication scheme as defined in RFC2617 (considered inherently insecure, but most widely supported) Digest : Digest authentication scheme as defined in RFC2617 NTLM : The NTLM scheme is a proprietary Microsoft Windows Authentication protocol (considered to be the most secure among currently supported authentication schemes)

Home | Contact Us | Privacy Policy | Terms of Service