|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.candle.roma.kxc.RomaBeResponse
This class encapsulates responses made by a Roma Business Element following a Roma Client request. It enables the application to set the options required when responding to a Roma Client request.
This class provides a framework for associating application specific data with a BusinessElement response.
It is intended that RomaBeResponse subclasses provide an implementation for the marshalling of application-specific data. The marshalResponse() method may be overridden to stream application data into a message buffer.
RomaBusinessElement
Constructor Summary | |
RomaBeResponse(RomaBeRequest br)
Constructs a new RomaBeResponse object and initialises it with message id, correlation id and theme from supplied RomaBeRequest. |
|
RomaBeResponse(RomaTheme theme)
Constructs a new RomaBeResponse object and associates it with the specified theme |
|
RomaBeResponse(RomaTheme theme,
byte[] msgBuf,
int msgLen)
Constructs a new RomaBeResponse object, associates it with the specified theme and sets user message buffer. |
|
RomaBeResponse(RomaTheme theme,
byte[] msgBuf,
int msgLen,
byte[] tagBuf,
int tagLen)
Constructs a new RomaBeResponse object, associates it with the specified theme and sets user message buffer. |
Method Summary | |
byte[] |
correlId()
Return the message correlation identifier. |
RomaILSData |
getILSData()
Get incoming ILS data |
void |
marshalResponse()
Marshalls response data immediately prior the reponse being sent. |
byte[] |
msgId()
Return the message identifier in a byte array. |
void |
setApiProfileName(java.lang.String profile)
Associates an API profile with the put operation. |
void |
setCloseTheme(boolean flag)
Specify whether the theme should be closed automatically when the operation completes. |
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 |
setErrorProfileName(java.lang.String profile)
Associates an error profile with the put operation. |
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 |
setILSData(RomaILSData ilsData)
Set outgoing ILS data |
void |
setIncrementRetryCount(boolean select)
Enables or disables the option to reset the retry count when sending the message. |
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 |
setNoEms(boolean select)
Enables or disables the option to send the message to an exception message service if the put operation fails. |
void |
setNoNotification(boolean select)
Enables or disables the option to send a notification message back to the sender if the message get operation fails. |
void |
setNoSyncAllowed(boolean flag)
Controls whether an MSMQ message can be placed outside syncpoint control. |
void |
setNotification(boolean flag)
Set or clear notification flag |
void |
setNoTransformation(boolean select)
Enables or disables the option to send the message to a message transformation service if the next component in the workflow cannot accept the message format. |
void |
setPersistence(int persistence)
Set a new value for the message perisitence. |
void |
setPriority(int priority)
Set the message priority. |
void |
setRetainTheme(boolean flag)
Specify whether the theme should be retained for future operations. |
void |
setSecurityDef(RomaSecurityDef secDef)
Set security definition |
void |
setSelector(int sel)
Sets the put selector. |
void |
setSuppressErrorProfile(boolean flag)
Specify if error profiling is to be suppressed |
void |
setSyncpointDef(RomaSyncpointDef sync)
Specify sync point definitiion |
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 |
setTermSupported(boolean flag)
Specify if termination is supported |
void |
setTheme(RomaTheme theme)
Update the message theme. |
void |
setUseApiProfile(boolean flag)
Indicates that flags and options specified in the API profile should be used for the Roma put operation. |
void |
setUseTheme(boolean flag)
Specify whether an existing theme should be used. |
int |
status()
Return message status |
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 RomaBeResponse(RomaTheme theme)
theme
- the theme of the request that this response
is intended for.setTheme(com.candle.roma.kxc.RomaTheme)
public RomaBeResponse(RomaTheme theme, byte[] msgBuf, int msgLen)
theme
- the theme of the request that this response
is intended for.msgBuf
- byte array containing the message.msgLen
- length of the message.public RomaBeResponse(RomaTheme theme, byte[] msgBuf, int msgLen, byte[] tagBuf, int tagLen)
theme
- the theme of the request that this response
is intended for.msgBuf
- byte array containing the message.msgLen
- length of the message.tagBuf
- byte array containing the tag data.tagLen
- length of the tag data.public RomaBeResponse(RomaBeRequest br)
br
- a RomaBeRequestMethod Detail |
public void marshalResponse() throws java.io.IOException
RomaBusinessElement.put( RomaBeResponse )
public void setSelector(int sel)
sel
- the new value of the put selector.
The expected return value will be one of the following fields :-
public void setNoSyncAllowed(boolean flag)
flag
- one of :-
public void setApiProfileName(java.lang.String profile)
profile
- the name of the API profile.public void setErrorProfileName(java.lang.String profile)
profile
- the name of the error profile.public void setSuppressErrorProfile(boolean flag)
flag
- true to suppress error profilingpublic void setUseApiProfile(boolean flag)
If this option is chosen but the specified profile is not available then default values are used for the put options.
flag
- true to suppress error profilingpublic void setIncrementRetryCount(boolean select)
select
- one of :-
public void setNoEms(boolean select)
select
- one of :-
public void setNoNotification(boolean select)
select
- one of :-
public void setNoTransformation(boolean select)
select
- one of :-
public void setUseTheme(boolean flag)
flag
- if true then the existing theme is used.public void setRetainTheme(boolean flag)
flag
- if true then the theme is retained.public void setCloseTheme(boolean flag)
flag
- if true then the theme will be closed.public void setNotification(boolean flag)
flag
- if true then Roma sends response immediately
back to client, ignoring any further business componentspublic void setTermSupported(boolean flag)
flag
- true to indicate termination is supported.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.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 setTheme(RomaTheme theme)
theme
- RomaTheme object.public RomaTheme theme()
public void setMsgName(java.lang.String messageName)
messageName
- name to be usedpublic int status()
public void setSecurityDef(RomaSecurityDef secDef)
secDef
- security definition to be sent with messagepublic void setSyncpointDef(RomaSyncpointDef sync)
sync
- definition to be used.public 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 setILSData(RomaILSData ilsData)
ilsData
- The ILS data to be sent with messagepublic RomaILSData getILSData()
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |