org.asam.ods

Interface BlobOperations

All Known Subinterfaces:

Blob

All Known Implementing Classes:

_BlobStub, Blob, Blob, BlobPOA

public interface BlobOperations

The ASAM ODS blob interface.

Method Summary

Methods

Modifier and Type	Method and Description
void	append(byte[] value) (12001) Append a byte sequence to the binary large object.
boolean	compare(Blob aBlob) (12002) Compares the content of the binary large object.
void	destroy() (12008) Destroy the object on the server.
byte[]	get(int offset, int length) (12003) Get a part of the binary large object.
java.lang.String	getHeader() (12004) Get the header of the binary large object.
int	getLength() (12005) Get the length of the binary large object without loading it.
void	set(byte[] value) (12006) Clear the binary large object and set the new data.
void	setHeader(java.lang.String header) (12007) Set the header of a binary large object.

Method Detail

append

void append(byte[] value)
            throws AoException

(12001) Append a byte sequence to the binary large object. It is allowed to modify the binary large object outside a transaction but it is recommended to activate a transaction.

Parameters:

value - The byte sequence.

Throws:

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

compare

boolean compare(Blob aBlob)
                throws AoException

(12002) Compares the content of the binary large object. The headers are not compared.

Parameters:

aBlob - The blob to compare.

Returns:

A flag whether or not the compared blobs are equal.

Throws:

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

get

byte[] get(int offset,
         int length)
           throws AoException

(12003) Get a part of the binary large object.

Parameters:

offset - The starting position of the data in the blob.

length - The number of bytes requested from the blob.

Returns:

The requested part of the blob data.

Throws:

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

getHeader

java.lang.String getHeader()
                           throws AoException

(12004) Get the header of the binary large object.

Returns:

The blob header.

Throws:

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

getLength

int getLength()
              throws AoException

(12005) Get the length of the binary large object without loading it.

Returns:

The blob length.

Throws:

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

set

void set(byte[] value)
         throws AoException

(12006) Clear the binary large object and set the new data. It is allowed to modify the binary large object outside a transaction but it is recommended to activate a transaction.

Parameters:

value - The new blob data.

Throws:

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

setHeader

void setHeader(java.lang.String header)
               throws AoException

(12007) Set the header of a binary large object. It is allowed to modify the binary large object outside a transaction but it is recommended to activate a transaction.

Parameters:

header - The blob header.

Throws:

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

destroy

void destroy()
             throws AoException

(12008) Destroy the object on the server. This method is used to tell the server that the blob object is not used any more by the client. Access to this object after the invokation of the destroy method will lead to an exception.

Throws:

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