Class ManualClosingApacheHttpClient43Engine
java.lang.Object
org.jboss.resteasy.client.jaxrs.engines.ManualClosingApacheHttpClient43Engine
- All Implemented Interfaces:
ClientHttpEngine,ApacheHttpClientEngine
- Direct Known Subclasses:
ApacheHttpClient43Engine
@Deprecated(forRemoval=true,
since="6.2")
public class ManualClosingApacheHttpClient43Engine
extends Object
implements ApacheHttpClientEngine
Deprecated, for removal: This API element is subject to removal in a future version.
An Apache HTTP engine for use with the new Builder Config style.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.jboss.resteasy.client.jaxrs.engines.ApacheHttpClientEngine
ApacheHttpClientEngine.MemoryUnit -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final booleanDeprecated, for removal: This API element is subject to removal in a future version.protected booleanDeprecated, for removal: This API element is subject to removal in a future version.protected final AtomicBooleanDeprecated, for removal: This API element is subject to removal in a future version.protected org.apache.http.HttpHostDeprecated, for removal: This API element is subject to removal in a future version.protected intDeprecated.protected ApacheHttpClientEngine.MemoryUnitDeprecated.protected PathDeprecated, for removal: This API element is subject to removal in a future version.Temp directory to write output request stream to.protected booleanDeprecated, for removal: This API element is subject to removal in a future version.protected HostnameVerifierDeprecated, for removal: This API element is subject to removal in a future version.protected final org.apache.http.client.HttpClientDeprecated, for removal: This API element is subject to removal in a future version.protected HttpContextProviderDeprecated, for removal: This API element is subject to removal in a future version.protected intDeprecated, for removal: This API element is subject to removal in a future version.protected SSLContextDeprecated, for removal: This API element is subject to removal in a future version. -
Constructor Summary
ConstructorsConstructorDescriptionDeprecated, for removal: This API element is subject to removal in a future version.ManualClosingApacheHttpClient43Engine(org.apache.http.client.HttpClient httpClient) Deprecated, for removal: This API element is subject to removal in a future version.ManualClosingApacheHttpClient43Engine(org.apache.http.client.HttpClient httpClient, boolean closeHttpClient) Deprecated, for removal: This API element is subject to removal in a future version.ManualClosingApacheHttpClient43Engine(org.apache.http.client.HttpClient httpClient, HttpContextProvider httpContextProvider) Deprecated, for removal: This API element is subject to removal in a future version.ManualClosingApacheHttpClient43Engine(org.apache.http.HttpHost defaultProxy) Deprecated, for removal: This API element is subject to removal in a future version. -
Method Summary
Modifier and TypeMethodDescriptionprotected org.apache.http.HttpEntitybuildEntity(ClientInvocation request) Deprecated, for removal: This API element is subject to removal in a future version.Build the HttpEntity to be sent to the Service as part of (POST) request.protected voidcleanUpAfterExecute(org.apache.http.client.methods.HttpRequestBase httpMethod) Deprecated, for removal: This API element is subject to removal in a future version.If passed httpMethod is of type HttpPost then obtain its entity.voidclose()Deprecated, for removal: This API element is subject to removal in a future version.protected voidcommitHeaders(ClientInvocation request, org.apache.http.client.methods.HttpRequestBase httpMethod) Deprecated, for removal: This API element is subject to removal in a future version.protected InputStreamDeprecated, for removal: This API element is subject to removal in a future version.protected org.apache.http.client.HttpClientDeprecated, for removal: This API element is subject to removal in a future version.protected org.apache.http.client.methods.HttpRequestBasecreateHttpMethod(String url, String restVerb) Deprecated, for removal: This API element is subject to removal in a future version.static CaseInsensitiveMap<String> extractHeaders(org.apache.http.HttpResponse response) Deprecated, for removal: This API element is subject to removal in a future version.org.apache.http.HttpHostDeprecated, for removal: This API element is subject to removal in a future version.intDeprecated.Deprecated, for removal: This API element is subject to removal in a future version.Returns the memory threshold of the amount of data to hold in memory.Deprecated.Deprecated, for removal: This API element is subject to removal in a future version.Deprecated, for removal: This API element is subject to removal in a future version.Needed for Client.getHostnameVerifier()org.apache.http.client.HttpClientDeprecated, for removal: This API element is subject to removal in a future version.intDeprecated, for removal: This API element is subject to removal in a future version.Response stream is wrapped in a BufferedInputStream.Deprecated, for removal: This API element is subject to removal in a future version.Needed for Client.getSslContext();protected StringDeprecated, for removal: This API element is subject to removal in a future version.Use context information, which will include node name, to avoid conflicts in case of multiple VMS using same temp directory location.jakarta.ws.rs.core.Responseinvoke(jakarta.ws.rs.client.Invocation inv) Deprecated, for removal: This API element is subject to removal in a future version.booleanDeprecated, for removal: This API element is subject to removal in a future version.booleanisClosed()Deprecated, for removal: This API element is subject to removal in a future version.booleanDeprecated, for removal: This API element is subject to removal in a future version.protected voidloadHttpMethod(ClientInvocation request, org.apache.http.client.methods.HttpRequestBase httpMethod) Deprecated, for removal: This API element is subject to removal in a future version.voidsetChunked(boolean chunked) Deprecated, for removal: This API element is subject to removal in a future version.voidsetFileUploadInMemoryThresholdLimit(int fileUploadInMemoryThresholdLimit) Deprecated.voidsetFileUploadMemoryThreshold(Threshold threshold) Deprecated, for removal: This API element is subject to removal in a future version.Sets the memory threshold for the amount of content to hold in memory before it offloads to offline storage.voidsetFileUploadMemoryUnit(ApacheHttpClientEngine.MemoryUnit fileUploadMemoryUnit) Deprecated.voidsetFileUploadTempFileDir(File fileUploadTempFileDir) Deprecated, for removal: This API element is subject to removal in a future version.voidsetFollowRedirects(boolean followRedirects) Deprecated, for removal: This API element is subject to removal in a future version.voidsetHostnameVerifier(HostnameVerifier hostnameVerifier) Deprecated, for removal: This API element is subject to removal in a future version.protected voidsetRedirectNotRequired(ClientInvocation request, org.apache.http.client.methods.HttpRequestBase httpMethod) Deprecated, for removal: This API element is subject to removal in a future version.protected voidsetRedirectRequired(ClientInvocation request, org.apache.http.client.methods.HttpRequestBase httpMethod) Deprecated, for removal: This API element is subject to removal in a future version.voidsetResponseBufferSize(int responseBufferSize) Deprecated, for removal: This API element is subject to removal in a future version.Response stream is wrapped in a BufferedInputStream.voidsetSslContext(SSLContext sslContext) Deprecated, for removal: This API element is subject to removal in a future version.
-
Field Details
-
httpClient
protected final org.apache.http.client.HttpClient httpClientDeprecated, for removal: This API element is subject to removal in a future version. -
closed
Deprecated, for removal: This API element is subject to removal in a future version. -
allowClosingHttpClient
protected final boolean allowClosingHttpClientDeprecated, for removal: This API element is subject to removal in a future version. -
httpContextProvider
Deprecated, for removal: This API element is subject to removal in a future version. -
sslContext
Deprecated, for removal: This API element is subject to removal in a future version. -
hostnameVerifier
Deprecated, for removal: This API element is subject to removal in a future version. -
responseBufferSize
protected int responseBufferSizeDeprecated, for removal: This API element is subject to removal in a future version. -
defaultProxy
protected org.apache.http.HttpHost defaultProxyDeprecated, for removal: This API element is subject to removal in a future version. -
chunked
protected boolean chunkedDeprecated, for removal: This API element is subject to removal in a future version. -
followRedirects
protected boolean followRedirectsDeprecated, for removal: This API element is subject to removal in a future version. -
fileUploadInMemoryThresholdLimit
Deprecated.For uploading File's over JAX-RS framework, this property, together withfileUploadMemoryUnit, defines the maximum File size allowed in memory. If fileSize exceeds this size, it will be stored tofileUploadTempFileDir.
Defaults to 1 MB -
fileUploadMemoryUnit
Deprecated.- See Also:
-
fileUploadTempFileDir
Deprecated, for removal: This API element is subject to removal in a future version.Temp directory to write output request stream to. Any file to be uploaded has to be written out to the output request stream to be sent to the service and when the File is too huge the output request stream is written out to the disk rather than to memory.
Defaults to JVM temp directory.
-
-
Constructor Details
-
ManualClosingApacheHttpClient43Engine
public ManualClosingApacheHttpClient43Engine()Deprecated, for removal: This API element is subject to removal in a future version. -
ManualClosingApacheHttpClient43Engine
public ManualClosingApacheHttpClient43Engine(org.apache.http.HttpHost defaultProxy) Deprecated, for removal: This API element is subject to removal in a future version. -
ManualClosingApacheHttpClient43Engine
public ManualClosingApacheHttpClient43Engine(org.apache.http.client.HttpClient httpClient) Deprecated, for removal: This API element is subject to removal in a future version. -
ManualClosingApacheHttpClient43Engine
public ManualClosingApacheHttpClient43Engine(org.apache.http.client.HttpClient httpClient, boolean closeHttpClient) Deprecated, for removal: This API element is subject to removal in a future version. -
ManualClosingApacheHttpClient43Engine
public ManualClosingApacheHttpClient43Engine(org.apache.http.client.HttpClient httpClient, HttpContextProvider httpContextProvider) Deprecated, for removal: This API element is subject to removal in a future version.
-
-
Method Details
-
getResponseBufferSize
public int getResponseBufferSize()Deprecated, for removal: This API element is subject to removal in a future version.Response stream is wrapped in a BufferedInputStream. Default is 8192. Value of 0 will not wrap it. Value of -1 will use a SelfExpandingBufferedInputStream- Returns:
- response buffer size
-
setResponseBufferSize
public void setResponseBufferSize(int responseBufferSize) Deprecated, for removal: This API element is subject to removal in a future version.Response stream is wrapped in a BufferedInputStream. Default is 8192. Value of 0 will not wrap it. Value of -1 will use a SelfExpandingBufferedInputStream- Parameters:
responseBufferSize- response buffer size
-
getFileUploadInMemoryThresholdLimit
Deprecated.Based on memory unit- Returns:
- threshold limit
-
setFileUploadInMemoryThresholdLimit
Deprecated. -
getFileUploadMemoryThreshold
Deprecated, for removal: This API element is subject to removal in a future version.Returns the memory threshold of the amount of data to hold in memory.- Returns:
- the memory threshold
-
setFileUploadMemoryThreshold
Deprecated, for removal: This API element is subject to removal in a future version.Sets the memory threshold for the amount of content to hold in memory before it offloads to offline storage.- Parameters:
threshold- the in memory threshold
-
getFileUploadMemoryUnit
Deprecated. -
setFileUploadMemoryUnit
@Deprecated public void setFileUploadMemoryUnit(ApacheHttpClientEngine.MemoryUnit fileUploadMemoryUnit) Deprecated. -
getFileUploadTempFileDir
Deprecated, for removal: This API element is subject to removal in a future version. -
setFileUploadTempFileDir
Deprecated, for removal: This API element is subject to removal in a future version. -
getHttpClient
public org.apache.http.client.HttpClient getHttpClient()Deprecated, for removal: This API element is subject to removal in a future version. -
getSslContext
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:ClientHttpEngineNeeded for Client.getSslContext();- Specified by:
getSslContextin interfaceClientHttpEngine- Returns:
SSLContext
-
setSslContext
Deprecated, for removal: This API element is subject to removal in a future version. -
getHostnameVerifier
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:ClientHttpEngineNeeded for Client.getHostnameVerifier()- Specified by:
getHostnameVerifierin interfaceClientHttpEngine- Returns:
HostnameVerifier
-
setHostnameVerifier
Deprecated, for removal: This API element is subject to removal in a future version. -
extractHeaders
Deprecated, for removal: This API element is subject to removal in a future version. -
createBufferedStream
Deprecated, for removal: This API element is subject to removal in a future version. -
invoke
public jakarta.ws.rs.core.Response invoke(jakarta.ws.rs.client.Invocation inv) Deprecated, for removal: This API element is subject to removal in a future version.- Specified by:
invokein interfaceClientHttpEngine
-
createHttpMethod
protected org.apache.http.client.methods.HttpRequestBase createHttpMethod(String url, String restVerb) Deprecated, for removal: This API element is subject to removal in a future version. -
loadHttpMethod
protected void loadHttpMethod(ClientInvocation request, org.apache.http.client.methods.HttpRequestBase httpMethod) throws Exception Deprecated, for removal: This API element is subject to removal in a future version.- Throws:
Exception
-
commitHeaders
protected void commitHeaders(ClientInvocation request, org.apache.http.client.methods.HttpRequestBase httpMethod) Deprecated, for removal: This API element is subject to removal in a future version. -
isChunked
public boolean isChunked()Deprecated, for removal: This API element is subject to removal in a future version. -
setChunked
public void setChunked(boolean chunked) Deprecated, for removal: This API element is subject to removal in a future version. -
isFollowRedirects
public boolean isFollowRedirects()Deprecated, for removal: This API element is subject to removal in a future version.- Specified by:
isFollowRedirectsin interfaceClientHttpEngine
-
setFollowRedirects
public void setFollowRedirects(boolean followRedirects) Deprecated, for removal: This API element is subject to removal in a future version.- Specified by:
setFollowRedirectsin interfaceClientHttpEngine
-
cleanUpAfterExecute
protected void cleanUpAfterExecute(org.apache.http.client.methods.HttpRequestBase httpMethod) Deprecated, for removal: This API element is subject to removal in a future version.If passed httpMethod is of type HttpPost then obtain its entity. If the entity has an enclosing File then delete it by invoking this method after the request has completed. The entity will have an enclosing File only if it was too huge to fit into memory.- Parameters:
httpMethod- - the httpMethod to clean up.
-
buildEntity
Deprecated, for removal: This API element is subject to removal in a future version.Build the HttpEntity to be sent to the Service as part of (POST) request. Creates a off-memoryFileEntityor a regular in-memoryByteArrayEntitydepending on if the request OutputStream fit into memory when built by calling.- Parameters:
request- -- Returns:
- - the built HttpEntity
- Throws:
IOException- -
-
getTempfilePrefix
Deprecated, for removal: This API element is subject to removal in a future version.Use context information, which will include node name, to avoid conflicts in case of multiple VMS using same temp directory location.- Returns:
- -
-
createDefaultHttpClient
protected org.apache.http.client.HttpClient createDefaultHttpClient()Deprecated, for removal: This API element is subject to removal in a future version. -
getDefaultProxy
public org.apache.http.HttpHost getDefaultProxy()Deprecated, for removal: This API element is subject to removal in a future version. -
setRedirectRequired
protected void setRedirectRequired(ClientInvocation request, org.apache.http.client.methods.HttpRequestBase httpMethod) Deprecated, for removal: This API element is subject to removal in a future version. -
setRedirectNotRequired
protected void setRedirectNotRequired(ClientInvocation request, org.apache.http.client.methods.HttpRequestBase httpMethod) Deprecated, for removal: This API element is subject to removal in a future version. -
isClosed
public boolean isClosed()Deprecated, for removal: This API element is subject to removal in a future version. -
close
public void close()Deprecated, for removal: This API element is subject to removal in a future version.- Specified by:
closein interfaceClientHttpEngine
-
ClientHttpEnginewill be replaced.