Interface RequestEntity
-
- All Known Implementing Classes:
ByteArrayRequestEntity,FileRequestEntity,InputStreamRequestEntity,MultipartRequestEntity,StringRequestEntity
@Deprecated public interface RequestEntityDeprecated.Jakarta Commons HttpClient 3.x is deprecated in the Jenkins project. It is not recommended to use it in any new code. Instead, use HTTP client API plugins as a dependency in your code. E.g. Apache HttpComponents Client API 4.x Plugin or Async HTTP Client Plugin.- Since:
- 3.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description longgetContentLength()Deprecated.Gets the request entity's length.java.lang.StringgetContentType()Deprecated.Gets the entity's content type.booleanisRepeatable()Deprecated.Tests ifwriteRequest(OutputStream)can be called more than once.voidwriteRequest(java.io.OutputStream out)Deprecated.Writes the request entity to the given stream.
-
-
-
Method Detail
-
isRepeatable
boolean isRepeatable()
Deprecated.Tests ifwriteRequest(OutputStream)can be called more than once.- Returns:
- true if the entity can be written to
OutputStreammore than once, false otherwise.
-
writeRequest
void writeRequest(java.io.OutputStream out) throws java.io.IOExceptionDeprecated.Writes the request entity to the given stream.- Parameters:
out-- Throws:
java.io.IOException
-
getContentLength
long getContentLength()
Deprecated.Gets the request entity's length. This method should return a non-negative value if the content length is known or a negative value if it is not. In the latter case theEntityEnclosingMethodwill use chunk encoding to transmit the request entity.- Returns:
- a non-negative value when content length is known or a negative value when content length is not known
-
getContentType
java.lang.String getContentType()
Deprecated.Gets the entity's content type. This content type will be used as the value for the "Content-Type" header.- Returns:
- the entity's content type
- See Also:
HttpMethod.setRequestHeader(String, String)
-
-