Java Doc for HttpClient.java in  » Net » Apache-common-HttpClient » org » apache » commons » httpclient » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Net » Apache common HttpClient » org.apache.commons.httpclient 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.commons.httpclient.HttpClient

HttpClient
public class HttpClient (Code)

An HTTP "user-agent", containing an HttpState HTTP state and one or more HttpConnection HTTP connections , to which HttpMethod HTTP methods can be applied.


author:
   Remy Maucherat
author:
   Rodney Waldhoff
author:
   Sean C. Sullivan
author:
   dIon Gillard
author:
   Ortwin Gl?ck
author:
   Michael Becke
author:
   Mike Bowler
author:
   Sam Maloney
author:
   Laura Werner
author:
   Oleg Kalnichevski
version:
   $Revision: 509577 $ $Date: 2007-02-20 15:28:18 +0100 (Tue, 20 Feb 2007) $



Constructor Summary
public  HttpClient()
     Creates an instance of HttpClient using default HttpClientParams parameter set .
public  HttpClient(HttpClientParams params)
     Creates an instance of HttpClient using the given HttpClientParams parameter set .
public  HttpClient(HttpClientParams params, HttpConnectionManager httpConnectionManager)
     Creates an instance of HttpClient with a user specified HttpClientParams parameter set and HttpConnectionManager HTTP connection manager .
public  HttpClient(HttpConnectionManager httpConnectionManager)
     Creates an instance of HttpClient with a user specified HttpConnectionManager HTTP connection manager .

Method Summary
public  intexecuteMethod(HttpMethod method)
     Executes the given HttpMethod HTTP method .
Parameters:
  method - the HttpMethod HTTP method to execute.
public  intexecuteMethod(HostConfiguration hostConfiguration, HttpMethod method)
     Executes the given HttpMethod HTTP method using custom HostConfiguration host configuration .
Parameters:
  hostConfiguration - The HostConfiguration host configuration to use.If null, the host configuration returned by HttpClient.getHostConfiguration will be used.
Parameters:
  method - the HttpMethod HTTP method to execute.
public  intexecuteMethod(HostConfiguration hostconfig, HttpMethod method, HttpState state)
     Executes the given HttpMethod HTTP method using the given custom HostConfiguration host configuration with the given custom HttpState HTTP state .
Parameters:
  hostconfig - The HostConfiguration host configuration to use.If null, the host configuration returned by HttpClient.getHostConfiguration will be used.
Parameters:
  method - the HttpMethod HTTP method to execute.
Parameters:
  state - the HttpState HTTP state to use when executing the method.If null, the state returned by HttpClient.getState will be used.
public  StringgetHost()
     Returns the default host.
public synchronized  HostConfigurationgetHostConfiguration()
     Returns the HostConfiguration host configuration associated with the HttpClient.
public synchronized  HttpConnectionManagergetHttpConnectionManager()
     Returns the HttpConnectionManager HTTP connection manager associated with the HttpClient.
public  HttpClientParamsgetParams()
     Returns HttpClientParams HTTP protocol parameters associated with this HttpClient.
public  intgetPort()
     Returns the default port.
public synchronized  HttpStategetState()
     Returns HttpState HTTP state associated with the HttpClient.
public synchronized  booleanisStrictMode()
     Returns the value of the strict mode flag.
public synchronized  voidsetConnectionTimeout(int newTimeoutInMilliseconds)
     Sets the timeout until a connection is etablished.
public synchronized  voidsetHostConfiguration(HostConfiguration hostConfiguration)
     Assigns the HostConfiguration host configuration to use with the HttpClient.
public synchronized  voidsetHttpConnectionFactoryTimeout(long timeout)
     Sets the timeout in milliseconds used when retrieving an HttpConnection HTTP connection from the HttpConnectionManager HTTP connection manager .
public synchronized  voidsetHttpConnectionManager(HttpConnectionManager httpConnectionManager)
     Assigns the HttpConnectionManager HTTP connection manager to use with the HttpClient.
public  voidsetParams(HttpClientParams params)
     Assigns HttpClientParams HTTP protocol parameters for this HttpClient.
public synchronized  voidsetState(HttpState state)
     Assigns HttpState HTTP state for the HttpClient.
public synchronized  voidsetStrictMode(boolean strictMode)
     Defines how strictly the method follows the HTTP protocol specification (see RFC 2616 and other relevant RFCs).
public synchronized  voidsetTimeout(int newTimeoutInMilliseconds)
     Sets the socket timeout (SO_TIMEOUT) in milliseconds which is the timeout for waiting for data.


Constructor Detail
HttpClient
public HttpClient()(Code)
Creates an instance of HttpClient using default HttpClientParams parameter set .
See Also:   HttpClientParams



HttpClient
public HttpClient(HttpClientParams params)(Code)
Creates an instance of HttpClient using the given HttpClientParams parameter set .
Parameters:
  params - The HttpClientParams parameters to use.
See Also:   HttpClientParams
since:
   3.0



HttpClient
public HttpClient(HttpClientParams params, HttpConnectionManager httpConnectionManager)(Code)
Creates an instance of HttpClient with a user specified HttpClientParams parameter set and HttpConnectionManager HTTP connection manager .
Parameters:
  params - The HttpClientParams parameters to use.
Parameters:
  httpConnectionManager - The HttpConnectionManager connection managerto use.
since:
   3.0



HttpClient
public HttpClient(HttpConnectionManager httpConnectionManager)(Code)
Creates an instance of HttpClient with a user specified HttpConnectionManager HTTP connection manager .
Parameters:
  httpConnectionManager - The HttpConnectionManager connection managerto use.
since:
   2.0




Method Detail
executeMethod
public int executeMethod(HttpMethod method) throws IOException, HttpException(Code)
Executes the given HttpMethod HTTP method .
Parameters:
  method - the HttpMethod HTTP method to execute. the method's response code
throws:
  IOException - If an I/O (transport) error occurs. Some transport exceptionscan be recovered from.
throws:
  HttpException - If a protocol exception occurs. Usually protocol exceptions cannot be recovered from.



executeMethod
public int executeMethod(HostConfiguration hostConfiguration, HttpMethod method) throws IOException, HttpException(Code)
Executes the given HttpMethod HTTP method using custom HostConfiguration host configuration .
Parameters:
  hostConfiguration - The HostConfiguration host configuration to use.If null, the host configuration returned by HttpClient.getHostConfiguration will be used.
Parameters:
  method - the HttpMethod HTTP method to execute. the method's response code
throws:
  IOException - If an I/O (transport) error occurs. Some transport exceptionscan be recovered from.
throws:
  HttpException - If a protocol exception occurs. Usually protocol exceptions cannot be recovered from.
since:
   2.0



executeMethod
public int executeMethod(HostConfiguration hostconfig, HttpMethod method, HttpState state) throws IOException, HttpException(Code)
Executes the given HttpMethod HTTP method using the given custom HostConfiguration host configuration with the given custom HttpState HTTP state .
Parameters:
  hostconfig - The HostConfiguration host configuration to use.If null, the host configuration returned by HttpClient.getHostConfiguration will be used.
Parameters:
  method - the HttpMethod HTTP method to execute.
Parameters:
  state - the HttpState HTTP state to use when executing the method.If null, the state returned by HttpClient.getState will be used. the method's response code
throws:
  IOException - If an I/O (transport) error occurs. Some transport exceptionscan be recovered from.
throws:
  HttpException - If a protocol exception occurs. Usually protocol exceptions cannot be recovered from.
since:
   2.0



getHost
public String getHost()(Code)
Returns the default host. The default host.



getHostConfiguration
public synchronized HostConfiguration getHostConfiguration()(Code)
Returns the HostConfiguration host configuration associated with the HttpClient. HostConfiguration host configuration
since:
   2.0



getHttpConnectionManager
public synchronized HttpConnectionManager getHttpConnectionManager()(Code)
Returns the HttpConnectionManager HTTP connection manager associated with the HttpClient. HttpConnectionManager HTTP connection manager
since:
   2.0



getParams
public HttpClientParams getParams()(Code)
Returns HttpClientParams HTTP protocol parameters associated with this HttpClient.
since:
   3.0
See Also:   HttpClientParams



getPort
public int getPort()(Code)
Returns the default port. The default port.



getState
public synchronized HttpState getState()(Code)
Returns HttpState HTTP state associated with the HttpClient.
See Also:   HttpClient.setState(HttpState) the shared client state



isStrictMode
public synchronized boolean isStrictMode()(Code)
Returns the value of the strict mode flag. true if strict mode is enabled, false otherwise
See Also:   HttpClient.setStrictMode(boolean)org.apache.commons.httpclient.params.HttpClientParams.getParameter(String)



setConnectionTimeout
public synchronized void setConnectionTimeout(int newTimeoutInMilliseconds)(Code)
Sets the timeout until a connection is etablished. A value of zero means the timeout is not used. The default value is zero.
See Also:   HttpConnection.setConnectionTimeout(int)
Parameters:
  newTimeoutInMilliseconds - Timeout in milliseconds.org.apache.commons.httpclient.params.HttpConnectionManagerParams.setConnectionTimeout(int)HttpConnectionManager.getParams



setHostConfiguration
public synchronized void setHostConfiguration(HostConfiguration hostConfiguration)(Code)
Assigns the HostConfiguration host configuration to use with the HttpClient.
Parameters:
  hostConfiguration - The HostConfiguration host configuration to set
since:
   2.0



setHttpConnectionFactoryTimeout
public synchronized void setHttpConnectionFactoryTimeout(long timeout)(Code)
Sets the timeout in milliseconds used when retrieving an HttpConnection HTTP connection from the HttpConnectionManager HTTP connection manager .
Parameters:
  timeout - the timeout in milliseconds
See Also:   HttpConnectionManager.getConnection(HostConfigurationlong)org.apache.commons.httpclient.params.HttpClientParams.setConnectionManagerTimeout(long)HttpClient.getParams



setHttpConnectionManager
public synchronized void setHttpConnectionManager(HttpConnectionManager httpConnectionManager)(Code)
Assigns the HttpConnectionManager HTTP connection manager to use with the HttpClient.
Parameters:
  httpConnectionManager - The HttpConnectionManager HTTP connection managerto set
since:
   2.0



setParams
public void setParams(HttpClientParams params)(Code)
Assigns HttpClientParams HTTP protocol parameters for this HttpClient.
since:
   3.0
See Also:   HttpClientParams



setState
public synchronized void setState(HttpState state)(Code)
Assigns HttpState HTTP state for the HttpClient.
See Also:   HttpClient.getState()
Parameters:
  state - the new HttpState HTTP state for the client



setStrictMode
public synchronized void setStrictMode(boolean strictMode)(Code)
Defines how strictly the method follows the HTTP protocol specification (see RFC 2616 and other relevant RFCs). In the strict mode the method precisely implements the requirements of the specification, whereas in non-strict mode it attempts to mimic the exact behaviour of commonly used HTTP agents, which many HTTP servers expect.
Parameters:
  strictMode - true for strict mode, false otherwise
See Also:   HttpClient.isStrictMode()HttpClientParams.setParameter(StringObject)



setTimeout
public synchronized void setTimeout(int newTimeoutInMilliseconds)(Code)
Sets the socket timeout (SO_TIMEOUT) in milliseconds which is the timeout for waiting for data. A timeout value of zero is interpreted as an infinite timeout.
Parameters:
  newTimeoutInMilliseconds - Timeout in millisecondsorg.apache.commons.httpclient.params.HttpConnectionManagerParams.setSoTimeout(int)HttpConnectionManager.getParams



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.