EntityEnclosingMethod (learn-home-web 1.0.0 API)

java.lang.Object
- com.ptteng.course.util.aliPayUtil.apacheCommonUtil.httpclient.HttpMethodBase
- - com.ptteng.course.util.aliPayUtil.apacheCommonUtil.httpclient.methods.ExpectContinueMethod
  - - com.ptteng.course.util.aliPayUtil.apacheCommonUtil.httpclient.methods.EntityEnclosingMethod

所有已实现的接口:

HttpMethod

直接已知子类:

PostMethod, PutMethod
```
public abstract class EntityEnclosingMethod
extends ExpectContinueMethod
```
This abstract class serves as a foundation for all HTTP methods that can enclose an entity within requests

从以下版本开始:

2.0beta1

版本:

$Revision: 161963 $

作者:

Oleg Kalnichevski, Jeff Dever

字段概要

字段
限定符和类型	字段和说明
`static long`	`CONTENT_LENGTH_AUTO` 已过时。 Use `InputStreamRequestEntity.CONTENT_LENGTH_AUTO`.
`static long`	`CONTENT_LENGTH_CHUNKED` 已过时。 Use `setContentChunked(boolean)`.

构造器概要

构造器
构造器和说明

EntityEnclosingMethod()
No-arg constructor.

EntityEnclosingMethod(String uri)
Constructor specifying a URI.

构造器
构造器和说明
`EntityEnclosingMethod()` No-arg constructor.
`EntityEnclosingMethod(String uri)` Constructor specifying a URI.

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`protected void`	`addContentLengthRequestHeader(HttpState state, HttpConnection conn)` Generates `Content-Length` or `Transfer-Encoding: Chunked` request header, as long as no `Content-Length` request header already exists.
`protected void`	`addRequestHeaders(HttpState state, HttpConnection conn)` Populates the request headers map to with additional `headers` to be submitted to the given `HttpConnection`.
`protected void`	`clearRequestBody()` Clears the request body.
`protected byte[]`	`generateRequestBody()` Generates the request body.
`protected RequestEntity`	`generateRequestEntity()`
`boolean`	`getFollowRedirects()` Entity enclosing requests cannot be redirected without user intervention according to RFC 2616.
`String`	`getRequestCharSet()` Returns the request's charset.
`protected long`	`getRequestContentLength()` Returns the length of the request body.
`RequestEntity`	`getRequestEntity()`
`protected boolean`	`hasRequestContent()` Returns `true` if there is a request body to be sent.
`void`	`recycle()` 已过时。 no longer supported and will be removed in the future version of HttpClient
`void`	`setContentChunked(boolean chunked)` Sets whether or not the content should be chunked.
`void`	`setFollowRedirects(boolean followRedirects)` Entity enclosing requests cannot be redirected without user intervention according to RFC 2616.
`void`	`setRequestBody(InputStream body)` 已过时。 use `setRequestEntity(RequestEntity)`
`void`	`setRequestBody(String body)` 已过时。 use `setRequestEntity(RequestEntity)`
`void`	`setRequestContentLength(int length)` 已过时。 Use `setContentChunked(boolean)` or `setRequestEntity(RequestEntity)`
`void`	`setRequestContentLength(long length)` 已过时。 Use `setContentChunked(boolean)` or `setRequestEntity(RequestEntity)`
`void`	`setRequestEntity(RequestEntity requestEntity)`
`protected boolean`	`writeRequestBody(HttpState state, HttpConnection conn)` Writes the request body to the given `connection`.

从类继承的方法 com.ptteng.course.util.aliPayUtil.apacheCommonUtil.httpclient.methods.ExpectContinueMethod
getUseExpectHeader, setUseExpectHeader

从类继承的方法 com.ptteng.course.util.aliPayUtil.apacheCommonUtil.httpclient.HttpMethodBase
abort, addCookieRequestHeader, addHostRequestHeader, addProxyConnectionHeader, addRequestHeader, addRequestHeader, addResponseFooter, addUserAgentRequestHeader, checkNotUsed, checkUsed, execute, generateRequestLine, getAuthenticationRealm, getContentCharSet, getDoAuthentication, getEffectiveVersion, getHostAuthState, getHostConfiguration, getMethodRetryHandler, getName, getParams, getPath, getProxyAuthenticationRealm, getProxyAuthState, getQueryString, getRecoverableExceptionCount, getRequestHeader, getRequestHeaderGroup, getRequestHeaders, getRequestHeaders, getResponseBody, getResponseBodyAsStream, getResponseBodyAsString, getResponseCharSet, getResponseContentLength, getResponseFooter, getResponseFooters, getResponseHeader, getResponseHeaderGroup, getResponseHeaders, getResponseHeaders, getResponseStream, getResponseTrailerHeaderGroup, getStatusCode, getStatusLine, getStatusText, getURI, hasBeenUsed, isAborted, isConnectionCloseForced, isHttp11, isRequestSent, isStrictMode, processResponseBody, processResponseHeaders, processStatusLine, readResponse, readResponseBody, readResponseHeaders, readStatusLine, releaseConnection, removeRequestHeader, removeRequestHeader, responseBodyConsumed, setConnectionCloseForced, setDoAuthentication, setHostConfiguration, setHttp11, setMethodRetryHandler, setParams, setPath, setQueryString, setQueryString, setRequestHeader, setRequestHeader, setResponseStream, setStrictMode, setURI, shouldCloseConnection, validate, writeRequest, writeRequestHeaders, writeRequestLine

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - CONTENT_LENGTH_AUTO
```
public static final long CONTENT_LENGTH_AUTO
```
    已过时。 Use InputStreamRequestEntity.CONTENT_LENGTH_AUTO.
    
    The content length will be calculated automatically. This implies buffering of the content.
    
    另请参阅:
    
    常量字段值
  - CONTENT_LENGTH_CHUNKED
```
public static final long CONTENT_LENGTH_CHUNKED
```
    已过时。 Use setContentChunked(boolean).
    
    The request will use chunked transfer encoding. Content length is not calculated and the content is not buffered.
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - EntityEnclosingMethod
```
public EntityEnclosingMethod()
```
    No-arg constructor.
    
    从以下版本开始:
    
    2.0
  - EntityEnclosingMethod
```
public EntityEnclosingMethod(String uri)
```
    Constructor specifying a URI.
    
    参数:
    
    uri - either an absolute or relative URI
    
    从以下版本开始:
    
    2.0
- 方法详细资料
  - hasRequestContent
```
protected boolean hasRequestContent()
```
    Returns true if there is a request body to be sent.
    This method must be overridden by sub-classes that implement alternative request content input methods
    
    指定者:
    
    hasRequestContent 在类中 ExpectContinueMethod
    
    返回:
    
    boolean
    
    从以下版本开始:
    
    2.0beta1
  - clearRequestBody
```
protected void clearRequestBody()
```
    Clears the request body.
    This method must be overridden by sub-classes that implement alternative request content input methods.
    
    从以下版本开始:
    
    2.0beta1
  - generateRequestBody
```
protected byte[] generateRequestBody()
```
    Generates the request body.
    This method must be overridden by sub-classes that implement alternative request content input methods.
    
    返回:
    
    request body as an array of bytes. If the request content has not been set, returns null.
    
    从以下版本开始:
    
    2.0beta1
  - generateRequestEntity
```
protected RequestEntity generateRequestEntity()
```
  - getFollowRedirects
```
public boolean getFollowRedirects()
```
    Entity enclosing requests cannot be redirected without user intervention according to RFC 2616.
    
    指定者:
    
    getFollowRedirects 在接口中 HttpMethod
    
    覆盖:
    
    getFollowRedirects 在类中 HttpMethodBase
    
    返回:
    
    false.
    
    从以下版本开始:
    
    2.0
  - setFollowRedirects
```
public void setFollowRedirects(boolean followRedirects)
```
    Entity enclosing requests cannot be redirected without user intervention according to RFC 2616.
    
    指定者:
    
    setFollowRedirects 在接口中 HttpMethod
    
    覆盖:
    
    setFollowRedirects 在类中 HttpMethodBase
    
    参数:
    
    followRedirects - must always be false
  - setRequestContentLength
```
public void setRequestContentLength(int length)
```
    已过时。 Use setContentChunked(boolean) or setRequestEntity(RequestEntity)
    
    Sets length information about the request body.
    Note: If you specify a content length the request is unbuffered. This prevents redirection and automatic retry if a request fails the first time. This means that the HttpClient can not perform authorization automatically but will throw an Exception. You will have to set the necessary 'Authorization' or 'Proxy-Authorization' headers manually.
    
    参数:
    
    length - size in bytes or any of CONTENT_LENGTH_AUTO, CONTENT_LENGTH_CHUNKED. If number of bytes or CONTENT_LENGTH_CHUNKED is specified the content will not be buffered internally and the Content-Length header of the request will be used. In this case the user is responsible to supply the correct content length. If CONTENT_LENGTH_AUTO is specified the request will be buffered before it is sent over the network.
  - getRequestCharSet
```
public String getRequestCharSet()
```
    Returns the request's charset. The charset is parsed from the request entity's content type, unless the content type header has been set manually.
    
    覆盖:
    
    getRequestCharSet 在类中 HttpMethodBase
    
    返回:
    
    String The character set.
    
    从以下版本开始:
    
    3.0
    
    另请参阅:
    
    RequestEntity.getContentType()
  - setRequestContentLength
```
public void setRequestContentLength(long length)
```
    已过时。 Use setContentChunked(boolean) or setRequestEntity(RequestEntity)
    
    Sets length information about the request body.
    Note: If you specify a content length the request is unbuffered. This prevents redirection and automatic retry if a request fails the first time. This means that the HttpClient can not perform authorization automatically but will throw an Exception. You will have to set the necessary 'Authorization' or 'Proxy-Authorization' headers manually.
    
    参数:
    
    length - size in bytes or any of CONTENT_LENGTH_AUTO, CONTENT_LENGTH_CHUNKED. If number of bytes or CONTENT_LENGTH_CHUNKED is specified the content will not be buffered internally and the Content-Length header of the request will be used. In this case the user is responsible to supply the correct content length. If CONTENT_LENGTH_AUTO is specified the request will be buffered before it is sent over the network.
  - setContentChunked
```
public void setContentChunked(boolean chunked)
```
    Sets whether or not the content should be chunked.
    
    参数:
    
    chunked - true if the content should be chunked
    
    从以下版本开始:
    
    3.0
  - getRequestContentLength
```
protected long getRequestContentLength()
```
    Returns the length of the request body.
    
    返回:
    
    number of bytes in the request body
  - addRequestHeaders
```
protected void addRequestHeaders(HttpState state,
                                 HttpConnection conn)
                          throws IOException,
                                 HttpException
```
    Populates the request headers map to with additional headers to be submitted to the given HttpConnection.
    This implementation adds tt>Content-Length or Transfer-Encoding headers.
    
    Subclasses may want to override this method to to add additional headers, and may choose to invoke this implementation (via super) to add the "standard" headers.
    
    覆盖:
    
    addRequestHeaders 在类中 ExpectContinueMethod
    
    参数:
    
    state - the state information associated with this method
    
    conn - the connection used to execute this HTTP method
    
    抛出:
    
    IOException - if an I/O (transport) error occurs. Some transport exceptions can be recovered from.
    
    HttpException - if a protocol exception occurs. Usually protocol exceptions cannot be recovered from.
    
    从以下版本开始:
    
    3.0
    
    另请参阅:
    
    HttpMethodBase.writeRequestHeaders(com.ptteng.course.util.aliPayUtil.apacheCommonUtil.httpclient.HttpState, com.ptteng.course.util.aliPayUtil.apacheCommonUtil.httpclient.HttpConnection)
  - addContentLengthRequestHeader
```
protected void addContentLengthRequestHeader(HttpState state,
                                             HttpConnection conn)
                                      throws IOException,
                                             HttpException
```
    Generates Content-Length or Transfer-Encoding: Chunked request header, as long as no Content-Length request header already exists.
    
    参数:
    
    state - current state of http requests
    
    conn - the connection to use for I/O
    
    抛出:
    
    IOException - when errors occur reading or writing to/from the connection
    
    HttpException - when a recoverable error occurs
  - setRequestBody
```
public void setRequestBody(InputStream body)
```
    已过时。 use setRequestEntity(RequestEntity)
    
    Sets the request body to be the specified inputstream.
    
    参数:
    
    body - Request body content as InputStream
  - setRequestBody
```
public void setRequestBody(String body)
```
    已过时。 use setRequestEntity(RequestEntity)
    
    Sets the request body to be the specified string. The string will be submitted, using the encoding specified in the Content-Type request header.
    Example: setRequestHeader("Content-type", "text/xml; charset=UTF-8");
    Would use the UTF-8 encoding. If no charset is specified, the default content encoding is used (ISO-8859-1).
    
    参数:
    
    body - Request body content as a string
  - writeRequestBody
```
protected boolean writeRequestBody(HttpState state,
                                   HttpConnection conn)
                            throws IOException,
                                   HttpException
```
    Writes the request body to the given connection.
    
    覆盖:
    
    writeRequestBody 在类中 HttpMethodBase
    
    参数:
    
    state - the state information associated with this method
    
    conn - the connection used to execute this HTTP method
    
    返回:
    
    true
    
    抛出:
    
    IOException - if an I/O (transport) error occurs. Some transport exceptions can be recovered from.
    
    HttpException - if a protocol exception occurs. Usually protocol exceptions cannot be recovered from.
  - recycle
```
public void recycle()
```
    已过时。 no longer supported and will be removed in the future version of HttpClient
    
    Recycles the HTTP method so that it can be used again. Note that all of the instance variables will be reset once this method has been called. This method will also release the connection being used by this HTTP method.
    
    指定者:
    
    recycle 在接口中 HttpMethod
    
    覆盖:
    
    recycle 在类中 HttpMethodBase
    
    另请参阅:
    
    HttpMethodBase.releaseConnection()
  - getRequestEntity
```
public RequestEntity getRequestEntity()
```
    返回:
    
    Returns the requestEntity.
    
    从以下版本开始:
    
    3.0
  - setRequestEntity
```
public void setRequestEntity(RequestEntity requestEntity)
```
    参数:
    
    requestEntity - The requestEntity to set.
    
    从以下版本开始:
    
    3.0

类 EntityEnclosingMethod

字段概要

构造器概要

方法概要

从类继承的方法 com.ptteng.course.util.aliPayUtil.apacheCommonUtil.httpclient.methods.ExpectContinueMethod

从类继承的方法 com.ptteng.course.util.aliPayUtil.apacheCommonUtil.httpclient.HttpMethodBase

从类继承的方法 java.lang.Object

字段详细资料

CONTENT_LENGTH_AUTO

CONTENT_LENGTH_CHUNKED

构造器详细资料

EntityEnclosingMethod

EntityEnclosingMethod

方法详细资料

hasRequestContent

clearRequestBody

generateRequestBody

generateRequestEntity

getFollowRedirects

setFollowRedirects

setRequestContentLength

getRequestCharSet

setRequestContentLength

setContentChunked

getRequestContentLength

addRequestHeaders

addContentLengthRequestHeader

setRequestBody

setRequestBody

writeRequestBody

recycle

getRequestEntity

setRequestEntity