org.asam.ods

Interface ODSWriteTransferOperations

All Known Subinterfaces:

ODSWriteTransfer

All Known Implementing Classes:

_ODSWriteTransferStub, ODSWriteTransfer, ODSWriteTransfer, ODSWriteTransferPOA

public interface ODSWriteTransferOperations

The interface which supports a write transfer (from a client to the ODS server) of the content of a file that is under control of the ODS server.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() (32000) Close this ODSWriteTransfer interface.
T_LONGLONG	getPosition() (32002) Retrieve the current position of the internal write pointer in the file.
void	putOctectSeq(byte[] buffer) (32001) Write a sequence of bytes to the file.

Method Detail

close

void close()
           throws AoException

(32000) Close this ODSWriteTransfer interface. This method closes the file on the ODS server's file system; thereby any data to be written to the file and still residing in the ODS server cache will be flushed to the file. The method finally destroys this ODSWriteTransfer object and also the corresponding CORBA object. Access to such objects after having invoked this close method will lead to a CORBA exception. In case the file creation and/or write operations have been performed within a transaction, this method will not yet save the operations' results permanently at the physical file location but keep them in an intermediate storage until the transaction is committed. The file will be locked for any access through ODSReadTransfer or ODSWriteTransfer within any other session until the end of the transaction. Any subsequent read transfers or write transfers within the same transaction are allowed, and will work on the latest version of the file. In case the transaction is committed without a preceding close operation the ODSWriteTransfer will be closed automatically by the server. In case the file creation and/or write operations have been performed outside a transaction, this method will make all changes permanent.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

putOctectSeq

void putOctectSeq(byte[] buffer)
                  throws AoException

(32001) Write a sequence of bytes to the file. This method writes a sequence of bytes to the file represented by this ODSWriteTransfer on the host computer. The parameter 'buffer' contains the byte sequence that is to be written to the file. The contents of 'buffer' will be appended at the end of the file (which may also be the very start of the file in case the file was newly created), and subsequent method invocations will add their bytes at the then actual end of the file. Note that only a sequential writing is supported by this interface. If previous parts of the file need to be changed, the file must be removed and a new one must be created. In case the current location of the file runs out of memory or any other operating system problem occurs the ODS server will return the exception AO_SYSTEM_PROBLEM. In this case the results of the actual putOctetSeq() invocation will be undone (no byte of 'buffer' is added to the file) and the file may be closed without containing 'buffer' at its end.

Parameters:

buffer - The buffer containing the sequence of bytes that shall be written to the file.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_NO_MEMORY AO_SYSTEM_PROBLEM

getPosition

T_LONGLONG getPosition()
                       throws AoException

(32002) Retrieve the current position of the internal write pointer in the file. This method returns the current byte position of the write pointer. The start of the file corresponds to a position of 0.

Returns:

The current position of the write pointer in the file.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE