org.apache.xmlrpc.client
Class XmlRpcSunHttpTransport

java.lang.Object
  extended by org.apache.xmlrpc.client.XmlRpcTransportImpl
      extended by org.apache.xmlrpc.client.XmlRpcStreamTransport
          extended by org.apache.xmlrpc.client.XmlRpcHttpTransport
              extended by 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 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
 
Fields inherited from class org.apache.xmlrpc.client.XmlRpcHttpTransport
USER_AGENT
 
Constructor Summary
XmlRpcSunHttpTransport(XmlRpcClient pClient)
          Creates a new instance.
 
Method Summary
protected  void close()
          Closes the connection and ensures, that all resources are being released.
protected  java.io.InputStream getInputStream()
          Returns the input stream, from which the response is being read.
protected  java.net.URLConnection getURLConnection()
          For use by subclasses.
protected  boolean isResponseGzipCompressed(XmlRpcStreamRequestConfig pConfig)
          Returns, whether the response is gzip compressed.
protected  java.net.URLConnection newURLConnection(java.net.URL pURL)
           
 java.lang.Object sendRequest(XmlRpcRequest pRequest)
          Send an XML-RPC message.
protected  void setRequestHeader(java.lang.String pHeader, java.lang.String pValue)
           
protected  void writeRequest(XmlRpcStreamTransport.ReqWriter pWriter)
           
 
Methods inherited from class org.apache.xmlrpc.client.XmlRpcHttpTransport
getUserAgent, initHttpHeaders, isUsingByteArrayOutput, newReqWriter, setCompressionHeaders, setContentLength, setCredentials
 
Methods inherited from class org.apache.xmlrpc.client.XmlRpcStreamTransport
isCompressingRequest, newXMLReader, readResponse
 
Methods inherited from class org.apache.xmlrpc.client.XmlRpcTransportImpl
getClient
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XmlRpcSunHttpTransport

public XmlRpcSunHttpTransport(XmlRpcClient pClient)
Creates a new instance.

Parameters:
pClient - The client controlling this instance.
Method Detail

newURLConnection

protected java.net.URLConnection newURLConnection(java.net.URL pURL)
                                           throws java.io.IOException
Throws:
java.io.IOException

getURLConnection

protected java.net.URLConnection getURLConnection()
For use by subclasses.


sendRequest

public java.lang.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(java.lang.String pHeader,
                                java.lang.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 java.io.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 java.io.IOException,
                            XmlRpcException,
                            org.xml.sax.SAXException
Specified by:
writeRequest in class XmlRpcStreamTransport
Throws:
java.io.IOException
XmlRpcException
org.xml.sax.SAXException


Copyright © 2001-2010 The Apache Software Foundation. All Rights Reserved.