Class XmlRpcSunHttpTransport

java.lang.Object

org.apache.xmlrpc.client.XmlRpcTransportImpl

org.apache.xmlrpc.client.XmlRpcStreamTransport

org.apache.xmlrpc.client.XmlRpcHttpTransport

org.apache.xmlrpc.client.XmlRpcSunHttpTransport

All Implemented Interfaces:

XmlRpcTransport

Direct Known Subclasses:

XmlRpcSun14HttpTransport

public class XmlRpcSunHttpTransport
extends XmlRpcHttpTransport

Default implementation of an HTTP transport, based on the HttpURLConnection class.

Nested Class Summary

Nested classes/interfaces inherited from class XmlRpcHttpTransport

XmlRpcHttpTransport.ByteArrayReqWriter

Nested classes/interfaces inherited from class XmlRpcStreamTransport

XmlRpcStreamTransport.GzipReqWriter, XmlRpcStreamTransport.ReqWriter, XmlRpcStreamTransport.ReqWriterImpl

Field Summary

Fields

Modifier and Type	Field	Description
private URLConnection	conn
private static final String	userAgent

Fields inherited from class XmlRpcHttpTransport

USER_AGENT

Constructor Summary

Constructors

Constructor	Description
XmlRpcSunHttpTransport(XmlRpcClient pClient)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
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 URLConnection	getURLConnection()	For use by subclasses.
protected boolean	isResponseGzipCompressed(XmlRpcStreamRequestConfig pConfig)	Returns, whether the response is gzip compressed.
protected URLConnection	newURLConnection(URL pURL)
Object	sendRequest(XmlRpcRequest pRequest)	Send an XML-RPC message.
protected void	setRequestHeader(String pHeader, String pValue)
protected void	writeRequest(XmlRpcStreamTransport.ReqWriter pWriter)

Methods inherited from class XmlRpcHttpTransport

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

Methods inherited from class XmlRpcStreamTransport

isCompressingRequest, newXMLReader, readResponse

Methods inherited from class XmlRpcTransportImpl

getClient

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

userAgent

private static final String userAgent

conn

private URLConnection conn

Constructor Details

XmlRpcSunHttpTransport

public XmlRpcSunHttpTransport(XmlRpcClient pClient)

Creates a new instance.

Parameters:

pClient - The client controlling this instance.

Method Details

newURLConnection

protected URLConnection newURLConnection(URL pURL)
                                  throws IOException

Throws:

IOException

getURLConnection

protected URLConnection getURLConnection()

For use by subclasses.

sendRequest

public Object sendRequest(XmlRpcRequest pRequest)
                   throws XmlRpcException

Description copied from interface: XmlRpcTransport

Send an XML-RPC message. This method is called to send a message to the other party.

Specified by:

sendRequest in interface XmlRpcTransport

Overrides:

sendRequest in class XmlRpcHttpTransport

Parameters:

pRequest - The request being performed.

Returns:

Result object, if invoking the remote method was successfull.

Throws:

XmlRpcException - Performing the request failed.

setRequestHeader

protected void setRequestHeader(String pHeader,
 String pValue)

Specified by:

setRequestHeader in class XmlRpcHttpTransport

close

protected void close()
              throws XmlRpcClientException

Description copied from class: XmlRpcStreamTransport

Closes the connection and ensures, that all resources are being released.

Specified by:

close in class XmlRpcStreamTransport

Throws:

XmlRpcClientException

isResponseGzipCompressed

protected boolean isResponseGzipCompressed(XmlRpcStreamRequestConfig pConfig)

Description copied from class: XmlRpcStreamTransport

Returns, whether the response is gzip compressed.

Specified by:

isResponseGzipCompressed in class XmlRpcStreamTransport

Parameters:

pConfig - The clients configuration.

Returns:

Whether the response stream is gzip compressed.

getInputStream

protected InputStream getInputStream()
                              throws XmlRpcException

Description copied from class: XmlRpcStreamTransport

Returns the input stream, from which the response is being read.

Specified by:

getInputStream in class XmlRpcStreamTransport

Throws:

XmlRpcException

writeRequest

protected void writeRequest(XmlRpcStreamTransport.ReqWriter pWriter)
                     throws IOException,
XmlRpcException,
SAXException

Specified by:

writeRequest in class XmlRpcStreamTransport

Throws:

IOException

XmlRpcException

SAXException