org.apache.xmlrpc.serializer.XmlRpcWriter Class Reference

List of all members.

Public Member Functions
void	write (XmlRpcRequest pRequest) throws SAXException
void	write (XmlRpcRequestConfig pConfig, Object pResult) throws SAXException
void	write (XmlRpcRequestConfig pConfig, int pCode, String pMessage) throws SAXException
void	write (XmlRpcRequestConfig pConfig, int pCode, String pMessage, Throwable pThrowable) throws SAXException
	XmlRpcWriter (XmlRpcStreamConfig pConfig, ContentHandler pHandler, TypeFactory pTypeFactory)
Static Public Attributes
static final String	EXTENSIONS_URI = "http://ws.apache.org/xmlrpc/namespaces/extensions"
Protected Member Functions
void	writeValue (Object pObject) throws SAXException
Private Attributes
final XmlRpcStreamConfig	config
final ContentHandler	handler
final TypeFactory	typeFactory
Static Private Attributes
static final Attributes	ZERO_ATTRIBUTES = new AttributesImpl()

---

Detailed Description

This class is responsible for writing an XmlRpc request or an XmlRpc response to an output stream.

Definition at line 40 of file XmlRpcWriter.java.

---

Constructor & Destructor Documentation

org.apache.xmlrpc.serializer.XmlRpcWriter.XmlRpcWriter	(	XmlRpcStreamConfig	pConfig,
		ContentHandler	pHandler,
		TypeFactory	pTypeFactory
	)		[inline]

Creates a new instance.

Parameters:

pConfig	The clients configuration.
pHandler	The target SAX handler.
pTypeFactory	The type factory being used to create serializers.

Definition at line 54 of file XmlRpcWriter.java.

---

Member Function Documentation

void org.apache.xmlrpc.serializer.XmlRpcWriter.write

(

XmlRpcRequest

pRequest

)

throws SAXException [inline]

Writes a clients request to the output stream.

Parameters:

pRequest

The request being written.

Exceptions:

SAXException

Writing the request failed.

Definition at line 65 of file XmlRpcWriter.java.

void org.apache.xmlrpc.serializer.XmlRpcWriter.write	(	XmlRpcRequestConfig	pConfig,
		Object	pResult
	)		throws SAXException [inline]

Writes a servers response to the output stream.

Parameters:

pConfig	The request configuration.
pResult	The result object.

Exceptions:

SAXException

Writing the response failed.

Definition at line 96 of file XmlRpcWriter.java.

void org.apache.xmlrpc.serializer.XmlRpcWriter.write	(	XmlRpcRequestConfig	pConfig,
		int	pCode,
		String	pMessage
	)		throws SAXException [inline]

Writes a servers error message to the output stream.

Parameters:

pConfig	The request configuration.
pCode	The error code
pMessage	The error message

Exceptions:

SAXException

Writing the error message failed.

Definition at line 121 of file XmlRpcWriter.java.

void org.apache.xmlrpc.serializer.XmlRpcWriter.write	(	XmlRpcRequestConfig	pConfig,
		int	pCode,
		String	pMessage,
		Throwable	pThrowable
	)		throws SAXException [inline]

Writes a servers error message to the output stream.

Parameters:

pConfig	The request configuration.
pCode	The error code
pMessage	The error message
pThrowable	An exception, which is being sent to the client

Exceptions:

SAXException

Writing the error message failed.

Definition at line 132 of file XmlRpcWriter.java.

void org.apache.xmlrpc.serializer.XmlRpcWriter.writeValue

(

Object

pObject

)

throws SAXException [inline, protected]

Writes the XML representation of a Java object.

Parameters:

pObject

The object being written.

Exceptions:

SAXException

Writing the object failed.

Definition at line 170 of file XmlRpcWriter.java.

---

Member Data Documentation

final XmlRpcStreamConfig org.apache.xmlrpc.serializer.XmlRpcWriter.config [private]

Definition at line 45 of file XmlRpcWriter.java.

final String org.apache.xmlrpc.serializer.XmlRpcWriter.EXTENSIONS_URI = "http://ws.apache.org/xmlrpc/namespaces/extensions" [static]

The namespace URI for proprietary XML-RPC extensions.

Definition at line 43 of file XmlRpcWriter.java.

final ContentHandler org.apache.xmlrpc.serializer.XmlRpcWriter.handler [private]

Definition at line 47 of file XmlRpcWriter.java.

final TypeFactory org.apache.xmlrpc.serializer.XmlRpcWriter.typeFactory [private]

Definition at line 46 of file XmlRpcWriter.java.

final Attributes org.apache.xmlrpc.serializer.XmlRpcWriter.ZERO_ATTRIBUTES = new AttributesImpl() [static, private]

Definition at line 44 of file XmlRpcWriter.java.

---

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

• XmlRpcWriter.java