|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.candle.roma.kxc.RomaClientRequest
This class encapsulates requests made by a Roma client to a Roma business service. It allows the application to set the options and the service required when making a client request. This class also provides a framework for associating application specific data with a client request.
The ClientRequest class may be sub-classed to provide for application specific data. Any subclasses must override the marshalRequest() method to stream application data into the message data buffer.
marshalRequest()
Constructor Summary | |
RomaClientRequest(java.lang.String svcName)
Constructs request with default options and with the name of a Roma businesss service specified. |
|
RomaClientRequest(java.lang.String svcName,
byte[] msgBuf,
int msgLen)
Constructs request with default options, with the name of a Roma businesss service specified and user message buffer. |
|
RomaClientRequest(java.lang.String svcName,
byte[] msgBuf,
int msgLen,
byte[] tagBuf,
int tagLen)
Constructs request with default options, with the name of a Roma businesss service specified and user message buffer. |
Method Summary | |
byte[] |
correlId()
Return the message correlation identifier. |
RomaILSData |
getILSData()
Get incoming ILS data |
void |
marshalRequest()
Invoked from the RomaClient.put() method immediately prior to attempting to issue the request to the Roma network. |
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 b)
Specify whether the theme should be closed automatically when the operation completes. |
void |
setCOA(boolean flag)
set or clear confirmation of arrival flag |
void |
setCOD(boolean flag)
set or clear confirmation of delivery flag |
void |
setCodepage(int codepage)
Set a new message codepage value. |
void |
setCorrelId(byte[] correlId)
Set the message correlation identifier. |
void |
setDatagram(boolean b)
Sets the datagram flag. |
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 |
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 |
setNewTheme(boolean b)
Specify whether a new theme should be allocated. |
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 |
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 b)
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 |
setServiceName(java.lang.String svcName)
Sets the name of the Roma Business Service that a put operation will send this request to. |
void |
setSuppressErrorProfile(boolean b)
Specify if error profiling is to be suppressed |
void |
setSyncpointDef(RomaSyncpointDef sync)
Specify sync point definitiion |
boolean |
setTagBuffer(byte[] buffer)
Set buffer containing the tag data for a PUT request. |
boolean |
setTagBuffer(byte[] buffer,
int dataLength)
Set buffer containing the tag data and the length of the tag for a PUT request. |
boolean |
setTagBuffer(java.lang.String buffer)
Set buffer containing the tag data for a PUT request. |
void |
setTermSupported(boolean b)
Specify if termination is supported |
void |
setTheme(RomaTheme theme)
Update the message theme. |
void |
setUseApiProfile(boolean b)
Indicates that flags and options specified in the API profile should be used for the Roma put operation. |
void |
setUseTheme(boolean b)
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 RomaClientRequest(java.lang.String svcName)
svcName
- name of a Roma Business Service.public RomaClientRequest(java.lang.String svcName, byte[] msgBuf, int msgLen)
svcName
- name of a Roma Business Service.msgBuf
- byte array containing the message.msgLen
- length of the message.public RomaClientRequest(java.lang.String svcName, byte[] msgBuf, int msgLen, byte[] tagBuf, int tagLen)
svcName
- name of a Roma Business Service.msgBuf
- byte array containing the message.msgLen
- length of the message.tagBuf
- byte array containing the tag data.tagLen
- length of the tag data.Method Detail |
public void setServiceName(java.lang.String svcName)
svcName
- Roma Business Service name.public void marshalRequest() throws java.io.IOException
If this method fails the put operation will not be carried out.
java.io.IOException
- is thrown on error.RomaClient.put(RomaClientRequest)
public void setSelector(int sel)
sel
- the new value of the put selector.
The 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 b)
b
- true to suppress error profilingpublic void setUseApiProfile(boolean b)
If this option is chosen but the specified profile is not available then default values are used for the put options.
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 setTermSupported(boolean b)
b
- true to indicate termination is supported.public void setNewTheme(boolean b)
b
- if true then a new theme is allocated.public void setRetainTheme(boolean b)
b
- if true then the theme is retained.public void setCloseTheme(boolean b)
b
- if true then the theme will be closed.public void setUseTheme(boolean b)
b
- if true then the existing theme is used.public void setCOD(boolean flag)
public void setCOA(boolean flag)
public void setDatagram(boolean b)
If an API profile is to be used ( selected by invoking the useApiProfile() method and verifiable by querying the isApiProfileUsed() method ) then this setting will be overridden either by the profile or, if not available, the default for this option.
b
- one of :-
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 setTheme(RomaTheme theme)
theme
- RomaTheme object.public RomaTheme theme()
public void setMsgName(java.lang.String messageName)
messageName
- name to be usedpublic int status()
public 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 message data.public boolean setMsgBuffer(java.lang.String buffer)
buffer
- String containing message data.public boolean setTagBuffer(byte[] buffer, int dataLength)
buffer
- byte array containing tag data.dataLength
- length of the tag data.public boolean setTagBuffer(byte[] buffer)
buffer
- byte array containing tag data.public boolean setTagBuffer(java.lang.String buffer)
buffer
- String containing tag data.public void setSecurityDef(RomaSecurityDef secDef)
secDef
- security definition to be sent with messagepublic void setSyncpointDef(RomaSyncpointDef sync)
sync
- definition to be used.public 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 |