org.apache.xmlrpc.client

Class XmlRpcCommonsTransport

Implemented Interfaces:
XmlRpcTransport

public class XmlRpcCommonsTransport
extends XmlRpcHttpTransport

An HTTP transport factory, which is based on the Jakarta Commons HTTP Client.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.xmlrpc.client.XmlRpcHttpTransport

XmlRpcHttpTransport.ByteArrayReqWriter

Nested classes/interfaces inherited from class org.apache.xmlrpc.client.XmlRpcStreamTransport

XmlRpcStreamTransport.GzipReqWriter, XmlRpcStreamTransport.ReqWriter, XmlRpcStreamTransport.ReqWriterImpl

Field Summary

protected HttpClient
client
protected PostMethod
method

Fields inherited from class org.apache.xmlrpc.client.XmlRpcHttpTransport

USER_AGENT

Constructor Summary

XmlRpcCommonsTransport(XmlRpcCommonsTransportFactory pFactory)
Creates a new instance.

Method Summary

protected void
close()
Closes the connection and ensures, that all resources are being released.
protected InputStream
getInputStream()
Returns the input stream, from which the response is being read.
protected void
initHttpHeaders(XmlRpcRequest pRequest)
protected boolean
isRedirectRequired()
protected boolean
isResponseGzipCompressed()
protected boolean
isResponseGzipCompressed(XmlRpcStreamRequestConfig pConfig)
Returns, whether the response is gzip compressed.
protected HttpClient
newHttpClient()
protected PostMethod
newPostMethod(XmlRpcHttpClientConfig pConfig)
protected void
resetClientForRedirect()
protected void
setContentLength(int pLength)
protected void
setCredentials(XmlRpcHttpClientConfig pConfig)
protected void
setRequestHeader(String pHeader, String pValue)
protected void
writeRequest(XmlRpcStreamTransport.ReqWriter pWriter)

Methods inherited from class org.apache.xmlrpc.client.XmlRpcHttpTransport

getUserAgent, initHttpHeaders, isUsingByteArrayOutput, newReqWriter, sendRequest, setCompressionHeaders, setContentLength, setCredentials, setRequestHeader

Methods inherited from class org.apache.xmlrpc.client.XmlRpcStreamTransport

close, getInputStream, isCompressingRequest, isResponseGzipCompressed, newReqWriter, newXMLReader, readResponse, sendRequest, writeRequest

Methods inherited from class org.apache.xmlrpc.client.XmlRpcTransportImpl

getClient

Field Details

client

protected final HttpClient client

method

protected PostMethod method

Constructor Details

XmlRpcCommonsTransport

public XmlRpcCommonsTransport(XmlRpcCommonsTransportFactory pFactory)
Creates a new instance.
Parameters:
pFactory - The factory, which created this transport.

Method Details

close

protected void close()
            throws XmlRpcClientException
Closes the connection and ensures, that all resources are being released.
Overrides:
close in interface XmlRpcStreamTransport

getInputStream

protected InputStream getInputStream()
            throws XmlRpcException
Returns the input stream, from which the response is being read.
Overrides:
getInputStream in interface XmlRpcStreamTransport

initHttpHeaders

protected void initHttpHeaders(XmlRpcRequest pRequest)
            throws XmlRpcClientException
Overrides:
initHttpHeaders in interface XmlRpcHttpTransport

isRedirectRequired

protected boolean isRedirectRequired()

isResponseGzipCompressed

protected boolean isResponseGzipCompressed()

isResponseGzipCompressed

protected boolean isResponseGzipCompressed(XmlRpcStreamRequestConfig pConfig)
Returns, whether the response is gzip compressed.
Overrides:
isResponseGzipCompressed in interface XmlRpcStreamTransport
Parameters:
pConfig - The clients configuration.
Returns:
Whether the response stream is gzip compressed.

newHttpClient

protected HttpClient newHttpClient()

newPostMethod

protected PostMethod newPostMethod(XmlRpcHttpClientConfig pConfig)

resetClientForRedirect

protected void resetClientForRedirect()
            throws XmlRpcException

setContentLength

protected void setContentLength(int pLength)
Overrides:
setContentLength in interface XmlRpcHttpTransport

setCredentials

protected void setCredentials(XmlRpcHttpClientConfig pConfig)
            throws XmlRpcClientException
Overrides:
setCredentials in interface XmlRpcHttpTransport

setRequestHeader

protected void setRequestHeader(String pHeader,
                                String pValue)
Overrides:
setRequestHeader in interface XmlRpcHttpTransport

writeRequest

protected void writeRequest(XmlRpcStreamTransport.ReqWriter pWriter)
            throws XmlRpcException
Overrides:
writeRequest in interface XmlRpcStreamTransport

Copyright © 2001-2007 Apache Software Foundation. All Rights Reserved.