|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.candle.roma.kxc.RomaExceptionMessage
This class is used to report erroneous messages to an Exception Messgage Queue by encapsulating the message that resulted in the error plus information about the error.
Constructor Summary | |
RomaExceptionMessage()
Constructs a new exception message with no information. |
|
RomaExceptionMessage(byte[] buffer,
int bufLen)
Constructs a new message exception object using an existing message buffer. |
|
RomaExceptionMessage(RomaBeRequest message)
Constructs a new message exception object using an existing RomaBeRequest. |
|
RomaExceptionMessage(RomaBeResponse message)
Constructs a new message exception object using an existing RomaBeResponse. |
|
RomaExceptionMessage(RomaClientRequest message)
Constructs a new message exception object using an existing RomaClientRequest. |
|
RomaExceptionMessage(RomaClientResponse message)
Constructs a new message exception object using an existing RomaClientResponse. |
|
RomaExceptionMessage(RomaStorable message)
Constructs a new message exception object using an existing RomaStorable. |
Method Summary | |
byte[] |
correlId()
Return the message correlation identifier. |
byte[] |
msgId()
Return the message identifier in a byte array. |
void |
setAdditionalInfo(int errorSubclass,
java.lang.String location)
Sets additional information. |
void |
setCallType(int type)
set call type |
void |
setCodepage(int codepage)
Set a new message codepage value. |
void |
setCompCode(int errorSubclass,
int code)
set completion code |
void |
setCorrelId(byte[] correlId)
Set the message correlation identifier. |
void |
setElements(int elements)
Sets which element should be present in the exception message. |
void |
setEncoding(int encoding)
Set the message encoding. |
void |
setErrorType(int errorSubclass,
int type)
Sets error type. |
void |
setExpiry(int expiry)
Set a new message expiry time. |
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. |
void |
setMsgBuffer(byte[] data)
Sets message data. |
boolean |
setMsgBuffer(byte[] buffer,
int dataLength)
Set buffer containing the message data and the length of the message for a PUT request. |
void |
setMsgBuffer(java.lang.String data)
Sets message data. |
void |
setMsgId(byte[] msgId)
Set the message identifier. |
void |
setMsgName(java.lang.String messageName)
Set the name of this message |
void |
setOperationType(int errorSubclass,
int opType)
Sets the operation type value. |
void |
setPersistence(int persistence)
Set a new value for the message perisitence. |
void |
setPosition(int errorSubclass,
int position)
Sets error position. |
void |
setPriority(int priority)
Set the message priority. |
void |
setReason(int errorSubclass,
int reason)
Sets the reason code. |
void |
setReturnCode(int errorSubclass,
int code)
set return code |
void |
setStatus(int status)
Sets the error status. |
void |
setTagBuffer(byte[] data)
Sets tag data. |
boolean |
setTagBuffer(byte[] buffer,
int dataLength)
Set buffer containing the tag data and the length of the tag for a PUT request. |
void |
setTagBuffer(java.lang.String data)
Sets tag data. |
void |
setUserBuffer(byte[] data)
Sets user data. |
boolean |
setUserBuffer(byte[] buffer,
int length)
Sets user data buffer. |
void |
setUserBuffer(java.lang.String data)
Sets user data. |
RomaTheme |
theme()
Return the message theme. |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Constructor Detail |
public RomaExceptionMessage()
public RomaExceptionMessage(RomaClientRequest message)
message
- a RomaClientRequest object.public RomaExceptionMessage(RomaClientResponse message)
message
- a RomaClientResponse object.public RomaExceptionMessage(RomaBeRequest message)
message
- a RomaBeRequest object.public RomaExceptionMessage(RomaBeResponse message)
message
- a RomaBeResponse object.public RomaExceptionMessage(RomaStorable message)
message
- a RomaStorable object.public RomaExceptionMessage(byte[] buffer, int bufLen)
buffer
- contains messagebufLen
- length of messageMethod Detail |
public void setPriority(int priority)
priority
- this can be one of the following :-
public void setPersistence(int persistence)
persistence
- this can be one of the following :-
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 void setFeedback(int feedback)
feedback
- new message feedback value.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 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 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 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 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 void setMsgBuffer(byte[] data)
data
- Message datapublic void setMsgBuffer(java.lang.String data)
data
- Message datapublic boolean setTagBuffer(byte[] buffer, int dataLength)
buffer
- byte array containing the message.dataLength
- length of the message.public void setTagBuffer(byte[] data)
data
- Tag datapublic void setTagBuffer(java.lang.String data)
data
- Tag datapublic void setElements(int elements)
Or else one of the following constant values :-
public void setCallType(int type)
type
- integer value representing the type of API
call being made when the error occurred.public void setStatus(int status)
status
- new error status.public void setCompCode(int errorSubclass, int code)
errorSubclass
- PRIMARY_INFO - set primary info.
SECONDARY_INFO - set secondary info.code
- completion codepublic void setReturnCode(int errorSubclass, int code)
errorSubclass
- PRIMARY_INFO - set primary info.
SECONDARY_INFO - set secondary info.code
- return codepublic void setReason(int errorSubclass, int reason)
errorSubclass
- PRIMARY_INFO - set primary info.
SECONDARY_INFO - set secondary info.reason
- the new reason code value.public void setOperationType(int errorSubclass, int opType)
errorSubclass
- PRIMARY_INFO - set primary info.
SECONDARY_INFO - set secondary info.opType
- the new operation type identifier.public void setPosition(int errorSubclass, int position)
errorSubclass
- PRIMARY_INFO - set primary info.
SECONDARY_INFO - set secondary info.position
- the error positionpublic void setErrorType(int errorSubclass, int type)
errorSubclass
- PRIMARY_INFO - set primary info.
SECONDARY_INFO - set secondary info.type
- the error typepublic void setAdditionalInfo(int errorSubclass, java.lang.String location)
errorSubclass
- PRIMARY_INFO - set primary info.
SECONDARY_INFO - set secondary info.location
- additional error location information.public boolean setUserBuffer(byte[] buffer, int length)
buffer
- user data buffer.length
- user data buffer lengthpublic void setUserBuffer(byte[] data)
data
- User datapublic void setUserBuffer(java.lang.String data)
data
- User datapublic RomaTheme theme()
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |