|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.candle.roma.kxc.RomaStorable
This class extends the RomaMessage class to provide the ability to be used on storage queues.
Constructor Summary | |
RomaStorable()
Default constructor. |
|
RomaStorable(byte[] msgBuffer,
int msgLength)
Constructor which takes message data. |
|
RomaStorable(RomaStorable storable)
|
Method Summary | |
int |
backoutCount()
Return the backout count. |
int |
codepage()
Return the message codepage. |
byte[] |
correlId()
Return the message correlation identifier. |
int |
encoding()
Get the message encoding. |
int |
expiry()
Return the message expiry time in seconds. |
int |
feedback()
Get the message feedback code. |
int |
format()
Return the message format. |
java.lang.String |
formatName()
Return the message format name. |
void |
marshalForStorage()
Called before the PUT operation this method may be overriden in a derived class for data marshalling. |
byte[] |
msgBuffer()
Return reference to the message data buffer. |
int |
msgDataLength()
Return length of data in the message buffer. |
byte[] |
msgId()
Return the message identifier in a byte array. |
int |
persistence()
return the message perisitence value. |
int |
priority()
Returns the priority assigned to the message. |
void |
setCodepage(int codepage)
Set a new message codepage value. |
void |
setCorrelId(byte[] correlId)
Set the message correlation identifier. |
void |
setEncoding(int encoding)
Set the message encoding. |
void |
setExpiry(int expiry)
Set a new message expiry time in seconds. |
void |
setFeedback(int feedback)
Sets a new message feedback code. |
void |
setFormat(int format)
Set a new message format value. |
void |
setFormatName(java.lang.String formatName)
Sets the format name. |
boolean |
setMsgBuffer(byte[] buffer)
Set buffer containing the message data for a PUT request. |
boolean |
setMsgBuffer(byte[] buffer,
int dataLength)
Set buffer containing the message data and the length of the message for a PUT request. |
boolean |
setMsgBuffer(java.lang.String buffer)
Set buffer containing the message data for a PUT request. |
void |
setMsgId(byte[] msgId)
Set the message identifier. |
void |
setMsgName(java.lang.String messageName)
Set the name of this message |
void |
setPersistence(int persistence)
Set a new value for the message perisitence. |
void |
setPriority(int priority)
Set the message priority. |
void |
setTheme(RomaTheme theme)
Update the message theme. |
RomaTheme |
theme()
Return the message theme. |
java.util.Date |
timeStamp()
Returns the time stamp which, for get operations, is the time at which the put operation occurred. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public RomaStorable()
public RomaStorable(RomaStorable storable)
public RomaStorable(byte[] msgBuffer, int msgLength)
msgBuffer
- - data buffermsgLength
- - length of data in bufferMethod Detail |
public void marshalForStorage() throws RomaError
RomaError
- thrown if marshalling fails.public void setPriority(int priority)
priority
- this can be one of the following :-
public int priority()
public void setPersistence(int persistence)
persistence
- this can be one of the following :-
public int persistence()
public void setFormat(int format)
format
- identifies the format of message. If the
value FORMAT_PROFILE is used then the message format value
is retrieved from the associated Put API profile. If the
profile is not available or else has no format attribute
value then the message format value FORMAT_BINARY is used.public int format()
public void setFeedback(int feedback)
feedback
- new message feedback value.public int feedback()
public void setExpiry(int expiry)
expiry
- the new expiry time value
in seconds or EXPIRY_NEVER or EXPIRY_PROFILE.
If EXPIRY_PROFILE is specified then
the expiry value is retrieved from the associated Put API
profile. If the profile is not available or else has no expiry
attribute set, the EXPIRY_NEVER constant is used.public int expiry()
public void setCodepage(int codepage)
codepage
- the new codepage value. If CODEPAGE_PROFILE is
specified then the codepage will be retrieved from the
associated Put API profile. If the profile is not available or
else has no codepage attribute set, the default value of
CODEPAGE_USER will be used.public int codepage()
public void setEncoding(int encoding)
encoding
- the new encoding indicator. If this is
ENCODING_PROFILE then the value is retrieved from the
associated Put API profile. If the profile is not available
or else has no encoding attribute set, the default value
ENCODING_DEFAULT is used.public int encoding()
public void setMsgId(byte[] msgId)
msgId
- a byte array containing the new message id value.
The msg id must not exceed kxc.MSG_ID_LENGTH.public byte[] msgId()
public void setCorrelId(byte[] correlId)
correlId
- the new correlation id.public byte[] correlId()
public void setFormatName(java.lang.String formatName)
formatName
- the new format name.public java.lang.String formatName()
public void setTheme(RomaTheme theme)
theme
- RomaTheme object.public RomaTheme theme()
public int backoutCount()
public java.util.Date timeStamp()
public void setMsgName(java.lang.String messageName)
messageName
- name to be usedpublic boolean setMsgBuffer(byte[] buffer, int dataLength)
buffer
- byte array containing the message.dataLength
- length of the message.public boolean setMsgBuffer(byte[] buffer)
buffer
- byte array containing the message.public boolean setMsgBuffer(java.lang.String buffer)
buffer
- String containing the message.public byte[] msgBuffer()
public int msgDataLength()
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |