|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.candle.roma.kxc.RomaStorageQueue
The RomaStorageQueue class enables the storing and retrieval of message from a Roma storage queue.
Constructor Summary | |
RomaStorageQueue(RomaBusinessElement be,
java.lang.String name)
Contruct and open the named storage queue using a given business element. |
|
RomaStorageQueue(RomaBusinessElement be,
java.lang.String name,
int opts)
Contruct and open the named storage queue using a given business element. |
|
RomaStorageQueue(RomaBusinessElement be,
java.lang.String name,
int opts,
java.lang.String modelQName)
Contruct and open the named storage queue using a given business element. |
|
RomaStorageQueue(RomaClient client,
java.lang.String name)
Construct and open the named storage queue using a given client. |
|
RomaStorageQueue(RomaClient client,
java.lang.String name,
int opts)
Construct and open the named storage queue using a given client. |
|
RomaStorageQueue(RomaClient client,
java.lang.String name,
int opts,
java.lang.String modelQName)
Construct and open the named storage queue using a given client. |
Method Summary | |
void |
close()
Close the storage queue. |
protected RomaStorable |
createStorable(RomaStorable msg)
Invoked when a message is successfully retrieved from the storage queue, this method unmarshalls the recovered message. |
boolean |
isOpen()
Check whether the storage queue is open. |
void |
open(RomaBusinessElement be,
java.lang.String name)
Open the named storage queue using a given business element. |
void |
open(RomaBusinessElement be,
java.lang.String name,
int opts)
Open the named storage queue using a given business element. |
void |
open(RomaBusinessElement be,
java.lang.String name,
int opts,
java.lang.String modelQName)
Open the named storage queue using a given business element. |
void |
open(RomaClient client,
java.lang.String name)
Open the named storage queue using a given client. |
void |
open(RomaClient client,
java.lang.String name,
int opts)
Open the named storage queue using a given client. |
void |
open(RomaClient client,
java.lang.String name,
int opts,
java.lang.String modelQName)
Open the named storage queue using a given client. |
RomaStorable |
retrieve()
Retrieves a message from the storage queue according to defaulted options. |
RomaStorable |
retrieve(RomaRetrieveOptions opt)
Retrieves a message from the storage queue according to the supplied options. |
RomaStorable |
retrieve(RomaRetrieveOptions opt,
byte[] buffer,
RomaInteger bufSize)
Retrieves a message from the storage queue according to the supplied options into user defined buffer. |
void |
store(RomaStorable msg)
Store a message on the storage queue according to the defaulted options. |
void |
store(RomaStorable msg,
RomaStoreOptions opts)
Store a message on the storage queue according to the supplied options. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public RomaStorageQueue(RomaClient client, java.lang.String name, int opts, java.lang.String modelQName) throws RomaError
context
- should specify a valid and connected Roma Clientname
- name of the storage queue to openoptions
- open options. Either the constant OPEN_DEFAULT
or a combination of the following flag
constants :-
modelQName
- model queue nameRomaError
- if the queue open fails.public RomaStorageQueue(RomaClient client, java.lang.String name, int opts) throws RomaError
context
- should specify a valid and connected Roma Clientname
- name of the storage queue to openoptions
- open options. Either the constant OPEN_DEFAULT
or a combination of the following flag
constants :-
RomaError
- if the queue open fails.public RomaStorageQueue(RomaClient client, java.lang.String name) throws RomaError
context
- should specify a valid and connected Roma Clientname
- name of the storage queue to openRomaError
- if the queue open fails.public RomaStorageQueue(RomaBusinessElement be, java.lang.String name, int opts, java.lang.String modelQName) throws RomaError
be
- should specify a valid and connected Roma Business Elementname
- name of the storage queue to openoptions
- open options. Either the constant OPEN_DEFAULT
or a combination of the following flag
constants :-
modelQName
- model queue nameRomaError
- if the queue open fails.public RomaStorageQueue(RomaBusinessElement be, java.lang.String name, int opts) throws RomaError
be
- should specify a valid and connected Roma Business Elementname
- name of the storage queue to openoptions
- open options. Either the constant OPEN_DEFAULT
or a combination of the following flag
constants :-
RomaError
- if the queue open fails.public RomaStorageQueue(RomaBusinessElement be, java.lang.String name) throws RomaError
be
- should specify a valid Roma and connected Business Elementname
- name of the storage queue to openRomaError
- if the queue open fails.Method Detail |
public void open(RomaClient client, java.lang.String name, int opts, java.lang.String modelQName) throws RomaError
client
- should specify a valid and connected Roma Clientname
- name of the storage queue to openoptions
- open options. Either the constant OPEN_DEFAULT
or a combination of the following flag
constants :-
modelQName
- model queue nameRomaError
- if the queue open fails.public void open(RomaClient client, java.lang.String name, int opts) throws RomaError
client
- should specify a valid and connected Roma Clientname
- name of the storage queue to openoptions
- open options. Either the constant OPEN_DEFAULT
or a combination of the following flag
constants :-
RomaError
- if the queue open fails.public void open(RomaClient client, java.lang.String name) throws RomaError
client
- should specify a valid and connected Roma Clientname
- name of the storage queue to openRomaError
- if the queue open fails.public void open(RomaBusinessElement be, java.lang.String name, int opts, java.lang.String modelQName) throws RomaError
be
- should specify a valid and connected Roma Business Elementname
- name of the storage queue to openoptions
- open options. Either the constant OPEN_DEFAULT
or a combination of the following flag
constants :-
modelQName
- model queue nameRomaError
- if the queue open fails.public void open(RomaBusinessElement be, java.lang.String name, int opts) throws RomaError
be
- should specify a valid and connected Roma Business Elementname
- name of the storage queue to openoptions
- open options. Either the constant OPEN_DEFAULT
or a combination of the following flag
constants :-
RomaError
- if the queue open fails.public void open(RomaBusinessElement be, java.lang.String name) throws RomaError
be
- should specify a valid and connected Roma Business Elementname
- name of the storage queue to openRomaError
- if the queue open fails.public void close() throws RomaError
RomaError
- if the close queue call fails.public void store(RomaStorable msg) throws RomaError
msg
- message to put on the storage queue.RomaError
- thrown if the store operation
fails.public void store(RomaStorable msg, RomaStoreOptions opts) throws RomaError
msg
- message to put on the storage queue.opt
- options for the store action.RomaError
- thrown if the store operation
fails.public RomaStorable retrieve() throws RomaError
Derived classes may override this method and return other, more application-specific types of RomaStorable objects.
RomaError
- thrown if retrieve operation fails.public RomaStorable retrieve(RomaRetrieveOptions opt) throws RomaError
Derived classes may override this method and return other, more application-specific types of RomaStorable objects.
opt
- retrieve options.RomaError
- thrown if retrieve operation fails.public RomaStorable retrieve(RomaRetrieveOptions opt, byte[] buffer, RomaInteger bufSize) throws RomaError
Derived classes may override this method and return other, more application-specific types of RomaStorable objects.
opt
- retrieve options.buffer
- buffer to receive databufSize
- length of buffer,
actual data length on return.RomaError
- thrown if retrieve operation fails.public boolean isOpen()
protected RomaStorable createStorable(RomaStorable msg)
It is intended that subclasses of RomaStorageQueue override this method so that custom data unmarshalling can be achieved.
This implementation returns a RomaStorable object. containing
msg
- a newly-retrieved RomaStorable object.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |