arlut.csd.ganymede
Interface XMLSession

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

GanymedeXMLSession

public interface XMLSession

extends java.rmi.Remote

Method Summary

void	abort() This method can be called to inform the XMLSession that no more XML will be transmitted.
arlut.csd.ganymede.ReturnVal	xmlEnd() This method is called by the XML client once the end of the XML stream has been transmitted, whereupon the server will attempt to finalize the XML transaction and return an overall success or failure message in the ReturnVal.
arlut.csd.ganymede.ReturnVal	xmlSubmit(byte[] bytes) This method is called repeatedly by the XML client in order to send the next packet of XML data to the server.

Method Detail

xmlSubmit

public arlut.csd.ganymede.ReturnVal xmlSubmit(byte[] bytes)
                                       throws java.rmi.RemoteException

This method is called repeatedly by the XML client in order to send the next packet of XML data to the server. If the server has detected any errors in the already-received XML stream, xmlSubmit() may return a non-null ReturnVal with a description of the failure. Otherwise, the xmlSubmit() method will enqueue the XML data for the server's continued processing and immediately return a null value, indicating success. The xmlSubmit() method will only block if the server has filled up its internal buffers and must wait to digest more of the already submitted XML.

java.rmi.RemoteException

xmlEnd

public arlut.csd.ganymede.ReturnVal xmlEnd()
                                    throws java.rmi.RemoteException

This method is called by the XML client once the end of the XML stream has been transmitted, whereupon the server will attempt to finalize the XML transaction and return an overall success or failure message in the ReturnVal. The xmlEnd() method will block until the server finishes processing all the XML data previously submitted by xmlSubmit().

java.rmi.RemoteException

abort

public void abort()
           throws java.rmi.RemoteException

This method can be called to inform the XMLSession that no more XML will be transmitted.

java.rmi.RemoteException