com.highqsoft.ods.athos

Class ODSWriteTransfer

java.lang.Object

com.highqsoft.ods.athos.ODSWriteTransfer

All Implemented Interfaces:

java.io.Serializable, ODSWriteTransfer, ODSWriteTransferOperations, org.omg.CORBA.Object, org.omg.CORBA.portable.IDLEntity

public class ODSWriteTransfer
extends java.lang.Object
implements ODSWriteTransfer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.HashMap<java.lang.String,ODSWriteTransfer>	activeWrite
protected long	cObjPtr
protected java.io.File	file
protected java.lang.String	filename
protected long	filePos
protected java.io.FileOutputStream	fos
protected ODSFile	odsFile

Constructor Summary

Constructors

Constructor and Description
ODSWriteTransfer()
ODSWriteTransfer(long cObjPtr)
ODSWriteTransfer(java.lang.String filename, ODSFile odsFile)

Method Summary

Methods

Modifier and Type	Method and Description
org.omg.CORBA.Request	_create_request(org.omg.CORBA.Context ctx, java.lang.String operation, org.omg.CORBA.NVList arg_list, org.omg.CORBA.NamedValue result)
org.omg.CORBA.Request	_create_request(org.omg.CORBA.Context ctx, java.lang.String operation, org.omg.CORBA.NVList arg_list, org.omg.CORBA.NamedValue result, org.omg.CORBA.ExceptionList exclist, org.omg.CORBA.ContextList ctxlist)
org.omg.CORBA.Object	_duplicate()
org.omg.CORBA.DomainManager[]	_get_domain_managers()
org.omg.CORBA.Object	_get_interface_def()
org.omg.CORBA.Policy	_get_policy(int policy_type)
int	_hash(int maximum)
boolean	_is_a(java.lang.String repositoryIdentifier)
boolean	_is_equivalent(org.omg.CORBA.Object other)
boolean	_non_existent()
void	_release()
org.omg.CORBA.Request	_request(java.lang.String operation)
org.omg.CORBA.Object	_set_policy_override(org.omg.CORBA.Policy[] policies, org.omg.CORBA.SetOverrideType set_add)
static boolean	checkWrite(java.lang.String filename) Check if the file is open for writing.
void	close() (32000) Close this ODSWriteTransfer interface.
boolean	equals(java.lang.Object obj)
protected void	finalize()
java.lang.String	getFilename() Get the filename of the write transfer.
T_LONGLONG	getPosition() (32002) Retrieve the current position of the write pointer in the file.
void	putOctectSeq(byte[] buffer) (32001) Write a sequence of bytes to the file.

Methods inherited from class java.lang.Object

clone, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

activeWrite

protected static java.util.HashMap<java.lang.String,ODSWriteTransfer> activeWrite

filename

protected java.lang.String filename

file

protected java.io.File file

fos

protected java.io.FileOutputStream fos

filePos

protected long filePos

odsFile

protected ODSFile odsFile

cObjPtr

protected long cObjPtr

Constructor Detail

ODSWriteTransfer

public ODSWriteTransfer()

ODSWriteTransfer

public ODSWriteTransfer(long cObjPtr)

ODSWriteTransfer

public ODSWriteTransfer(java.lang.String filename,
                ODSFile odsFile)

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

checkWrite

public static boolean checkWrite(java.lang.String filename)

Check if the file is open for writing.

Parameters:

filename - the filename

Returns:

true when the file is open for writing.

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

_create_request

public org.omg.CORBA.Request _create_request(org.omg.CORBA.Context ctx,
                                    java.lang.String operation,
                                    org.omg.CORBA.NVList arg_list,
                                    org.omg.CORBA.NamedValue result)

Specified by:

_create_request in interface org.omg.CORBA.Object

_create_request

public org.omg.CORBA.Request _create_request(org.omg.CORBA.Context ctx,
                                    java.lang.String operation,
                                    org.omg.CORBA.NVList arg_list,
                                    org.omg.CORBA.NamedValue result,
                                    org.omg.CORBA.ExceptionList exclist,
                                    org.omg.CORBA.ContextList ctxlist)

Specified by:

_create_request in interface org.omg.CORBA.Object

_duplicate

public org.omg.CORBA.Object _duplicate()

Specified by:

_duplicate in interface org.omg.CORBA.Object

_get_domain_managers

public org.omg.CORBA.DomainManager[] _get_domain_managers()

Specified by:

_get_domain_managers in interface org.omg.CORBA.Object

_get_interface_def

public org.omg.CORBA.Object _get_interface_def()

Specified by:

_get_interface_def in interface org.omg.CORBA.Object

_get_policy

public org.omg.CORBA.Policy _get_policy(int policy_type)

Specified by:

_get_policy in interface org.omg.CORBA.Object

_hash

public int _hash(int maximum)

Specified by:

_hash in interface org.omg.CORBA.Object

_is_a

public boolean _is_a(java.lang.String repositoryIdentifier)

Specified by:

_is_a in interface org.omg.CORBA.Object

_is_equivalent

public boolean _is_equivalent(org.omg.CORBA.Object other)

Specified by:

_is_equivalent in interface org.omg.CORBA.Object

_non_existent

public boolean _non_existent()

Specified by:

_non_existent in interface org.omg.CORBA.Object

_release

public void _release()

Specified by:

_release in interface org.omg.CORBA.Object

_request

public org.omg.CORBA.Request _request(java.lang.String operation)

Specified by:

_request in interface org.omg.CORBA.Object

_set_policy_override

public org.omg.CORBA.Object _set_policy_override(org.omg.CORBA.Policy[] policies,
                                        org.omg.CORBA.SetOverrideType set_add)

Specified by:

_set_policy_override in interface org.omg.CORBA.Object

close

public 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 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 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.

Specified by:

close in interface ODSWriteTransferOperations

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

public 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 at the ODS server represented by this ODSWriteTransfer. 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.

Specified by:

putOctectSeq in interface ODSWriteTransferOperations

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

public T_LONGLONG getPosition()
                       throws AoException

(32002) Retrieve the current position of the 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.

Specified by:

getPosition in interface ODSWriteTransferOperations

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

getFilename

public java.lang.String getFilename()

Get the filename of the write transfer.

Returns:

the filename.