org.apache.xmlrpc.client.XmlRpcStreamTransport Class Reference

Inheritance diagram for org.apache.xmlrpc.client.XmlRpcStreamTransport:

List of all members.

Classes
class	GzipReqWriter
interface	ReqWriter
class	ReqWriterImpl
Public Member Functions
Object	sendRequest (XmlRpcRequest pRequest) throws XmlRpcException
Protected Member Functions
abstract void	close () throws XmlRpcClientException
abstract InputStream	getInputStream () throws XmlRpcException
boolean	isCompressingRequest (XmlRpcStreamRequestConfig pConfig)
abstract boolean	isResponseGzipCompressed (XmlRpcStreamRequestConfig pConfig)
ReqWriter	newReqWriter (XmlRpcRequest pRequest) throws XmlRpcException, IOException, SAXException
XMLReader	newXMLReader () throws XmlRpcException
Object	readResponse (XmlRpcStreamRequestConfig pConfig, InputStream pStream) throws XmlRpcException
abstract void	writeRequest (ReqWriter pWriter) throws XmlRpcException, IOException, SAXException
	XmlRpcStreamTransport (XmlRpcClient pClient)

---

Detailed Description

Implementation of a transport class, which is based on an output stream for sending the request and an input stream for receiving the response,

Definition at line 44 of file XmlRpcStreamTransport.java.

---

Constructor & Destructor Documentation

org.apache.xmlrpc.client.XmlRpcStreamTransport.XmlRpcStreamTransport

(

XmlRpcClient

pClient

)

[inline, protected]

Creates a new instance on behalf of the given client.

Definition at line 101 of file XmlRpcStreamTransport.java.

---

Member Function Documentation

abstract void org.apache.xmlrpc.client.XmlRpcStreamTransport.close

(

)

throws XmlRpcClientException [protected, pure virtual]

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

Implemented in org.apache.xmlrpc.client.XmlRpcCommonsTransport, org.apache.xmlrpc.client.XmlRpcLiteHttpTransport, org.apache.xmlrpc.client.XmlRpcSunHttpTransport, and org.apache.xmlrpc.client.XmlRpcLocalStreamTransport.

abstract InputStream org.apache.xmlrpc.client.XmlRpcStreamTransport.getInputStream

(

)

throws XmlRpcException [protected, pure virtual]

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

Implemented in org.apache.xmlrpc.client.XmlRpcLiteHttpTransport, org.apache.xmlrpc.client.XmlRpcCommonsTransport, org.apache.xmlrpc.client.XmlRpcSunHttpTransport, and org.apache.xmlrpc.client.XmlRpcLocalStreamTransport.

boolean org.apache.xmlrpc.client.XmlRpcStreamTransport.isCompressingRequest

(

XmlRpcStreamRequestConfig

pConfig

)

[inline, protected]

Definition at line 121 of file XmlRpcStreamTransport.java.

abstract boolean org.apache.xmlrpc.client.XmlRpcStreamTransport.isResponseGzipCompressed

(

XmlRpcStreamRequestConfig

pConfig

)

[protected, pure virtual]

Returns, whether the response is gzip compressed.

Parameters:

pConfig

The clients configuration.

Returns:

Whether the response stream is gzip compressed.

Implemented in org.apache.xmlrpc.client.XmlRpcLiteHttpTransport, org.apache.xmlrpc.client.XmlRpcCommonsTransport, org.apache.xmlrpc.client.XmlRpcSunHttpTransport, and org.apache.xmlrpc.client.XmlRpcLocalStreamTransport.

ReqWriter org.apache.xmlrpc.client.XmlRpcStreamTransport.newReqWriter

(

XmlRpcRequest

pRequest

)

throws XmlRpcException, IOException, SAXException [inline, protected]

Creates a new instance of ReqWriter.

Exceptions:

XmlRpcException	Creating the instance failed.
IOException	Creating the instance failed, because an IOException occurs.
SAXException	Creating the instance failed, because the request could not be parsed.

Reimplemented in org.apache.xmlrpc.client.XmlRpcHttpTransport, and org.apache.xmlrpc.client.XmlRpcLocalStreamTransport.

Definition at line 134 of file XmlRpcStreamTransport.java.

XMLReader org.apache.xmlrpc.client.XmlRpcStreamTransport.newXMLReader

(

)

throws XmlRpcException [inline, protected]

Definition at line 175 of file XmlRpcStreamTransport.java.

Object org.apache.xmlrpc.client.XmlRpcStreamTransport.readResponse	(	XmlRpcStreamRequestConfig	pConfig,
		InputStream	pStream
	)		throws XmlRpcException [inline, protected]

Definition at line 179 of file XmlRpcStreamTransport.java.

Object org.apache.xmlrpc.client.XmlRpcStreamTransport.sendRequest

(

XmlRpcRequest

pRequest

)

throws XmlRpcException [inline]

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

Parameters:

pRequest

The request being performed.

Returns:

Result object, if invoking the remote method was successfull.

Exceptions:

XmlRpcException

Performing the request failed.

Implements org.apache.xmlrpc.client.XmlRpcTransport.

Reimplemented in org.apache.xmlrpc.client.XmlRpcHttpTransport, org.apache.xmlrpc.client.XmlRpcLiteHttpTransport, and org.apache.xmlrpc.client.XmlRpcSunHttpTransport.

Definition at line 146 of file XmlRpcStreamTransport.java.

abstract void org.apache.xmlrpc.client.XmlRpcStreamTransport.writeRequest

(

ReqWriter

pWriter

)

throws XmlRpcException, IOException, SAXException [protected, pure virtual]

Implemented in org.apache.xmlrpc.client.XmlRpcLiteHttpTransport, org.apache.xmlrpc.client.XmlRpcSunHttpTransport, and org.apache.xmlrpc.client.XmlRpcLocalStreamTransport.

---

The documentation for this class was generated from the following file:

• XmlRpcStreamTransport.java