com.highqsoft.ods.athos

Class ODSReadTransfer

java.lang.Object

com.highqsoft.ods.athos.ODSReadTransfer

All Implemented Interfaces:

java.io.Serializable, ODSReadTransfer, ODSReadTransferOperations, org.omg.CORBA.Object, org.omg.CORBA.portable.IDLEntity

public class ODSReadTransfer
extends java.lang.Object
implements ODSReadTransfer

The ODSReadTransfer implementation. The class which allows a read transfer (from the ODS server to a client) of the content of a file that is under control of the ODS server.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.HashMap<java.lang.String,ODSReadTransfer>	activeRead
protected long	cObjPtr
protected java.io.File	file
protected java.lang.String	filename
protected long	filePos
protected java.io.FileInputStream	fis
protected ODSFile	odsFile

Fields inherited from interface org.asam.ods.ODSReadTransfer

READALL

Constructor Summary

Constructors

Constructor and Description
ODSReadTransfer()
ODSReadTransfer(long cObjPtr)
ODSReadTransfer(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	checkRead(java.lang.String filename) Check if the file is open for reading.
void	close() Close this ODSReadTransfer interface.
boolean	equals(java.lang.Object obj)
protected void	finalize()
java.lang.String	getFilename() Get the filename of the read transfer.
byte[]	getOctetSeq(int maxOctets) Read a sequence of bytes from the file.
T_LONGLONG	getPosition() Retrieve the current position of the read pointer in the file.
T_LONGLONG	skipOctets(T_LONGLONG numOctets) Skip a number of bytes while reading the file.

Methods inherited from class java.lang.Object

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

Field Detail

activeRead

protected static java.util.HashMap<java.lang.String,ODSReadTransfer> activeRead

filename

protected java.lang.String filename

file

protected java.io.File file

fis

protected java.io.FileInputStream fis

filePos

protected long filePos

cObjPtr

protected long cObjPtr

odsFile

protected ODSFile odsFile

Constructor Detail

ODSReadTransfer

public ODSReadTransfer()

ODSReadTransfer

public ODSReadTransfer(long cObjPtr)

ODSReadTransfer

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

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

checkRead

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

Check if the file is open for reading.

Parameters:

filename - the filename

Returns:

true when the file is open for reading.

_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_equivalent

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

Specified by:

_is_equivalent 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

Close this ODSReadTransfer interface. This method closes the file on the ODS server's file system and destroys this ODSReadTransfer object.

Specified by:

close in interface ODSReadTransferOperations

Throws:

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

getPosition

public T_LONGLONG getPosition()
                       throws AoException

Retrieve the current position of the read pointer in the file. This method returns the current byte position of the file pointer. The start of the file corresponds to a position of 0.

Specified by:

getPosition in interface ODSReadTransferOperations

Returns:

The current position of the read 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

getOctetSeq

public byte[] getOctetSeq(int maxOctets)
                   throws AoException

Read a sequence of bytes from the file. This method reads the file at the ODS server referenced by this ODSReadTransfer and returns a sequence of bytes from that file. The parameter 'maxOctets' controls the return behavior of the ODS server. If the file contains more bytes than are given by 'maxOctets', only 'maxOctets' bytes will be returned in the first method invocation. A subsequent method invocation will return the next 'maxOctets' bytes from the file, etc., until the complete file contents has been returned. Further method invocations return an empty sequence. If 'maxOctets' is given with a value less equal 0, there is no restriction on the number of bytes, and the complete file contents will be returned with only one method invocation. Note that only a sequential reading, starting at the first byte of the file, is supported by this interface. If previous parts of the file need to be accessed again, the current ODSReadTransfer object must be closed and a new one must be instantiated.

Specified by:

getOctetSeq in interface ODSReadTransferOperations

Parameters:

maxOctets - The maximum number of bytes to be returned by one method call.

Returns:

The next (at most 'maxOctets') bytes 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 AO_SYSTEM_PROBLEM AO_BAD_PARAMETER

skipOctets

public T_LONGLONG skipOctets(T_LONGLONG numOctets)
                      throws AoException

Skip a number of bytes while reading the file. This method moves the read pointer in the file a number of bytes ahead, starting at its current position; it will not return those bytes. The parameter 'numOctets' specifies the number of bytes to skip. The method returns the true number of bytes that were skipped. This may differ from 'numOctets' e.g. if the end of the file was reached. If the read pointer has reached the end of the file any further method invocations will return a value of 0 for 'numSkipped'. This method may be invoked several times and may be arbitrarily combined with getOctetSeq(). Note that only a sequential reading, starting at the first byte of the file, is supported by this interface. If previous parts of the file need to be accessed again, the current ODSReadTransfer object must be closed and a new one must be instantiated. If 'numOctets' is given with a value less than 0, the method will throw the exception AO_BAD_PARAMETER and will not perform any file access nor change the read pointer.

Specified by:

skipOctets in interface ODSReadTransferOperations

Parameters:

numOctets - The number of bytes to be skipped.

Returns:

the real number of bytes skipped 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 AO_BAD_PARAMETER

getFilename

public java.lang.String getFilename()

Get the filename of the read transfer.

Returns:

the filename.

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

_is_a

public boolean _is_a(java.lang.String repositoryIdentifier)

Specified by:

_is_a in interface org.omg.CORBA.Object

_non_existent

public boolean _non_existent()

Specified by:

_non_existent in interface org.omg.CORBA.Object