|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.candle.roma.kxc.RomaContext | +--com.candle.roma.kxc.RomaBusinessElement
This class allows an application to instantiate a server-side connection to the Roma network as a Roma Business Element.
A Business Element typically receives requests from a Client and issue Responses.
A single application is allowed to instantiate multiple objects of the Business Element class.
The Business Element class be extended by an application to providing a derived class which may override createRequest() for each type of request to be distinguished.
RomaBeRequest
Constructor Summary | |
RomaBusinessElement()
Constructs a RomaBusinessElement object but does not attach the Business Element to the Roma network. |
|
RomaBusinessElement(java.lang.String name)
Constructs and connects the new Business Element to the Roma network. |
|
RomaBusinessElement(java.lang.String name,
int opts)
Constructs and connects a Business Element to the Roma network. |
|
RomaBusinessElement(java.lang.String name,
int opts,
RomaSecurityDef sec)
Constructs and connects a Business Element to the Roma network. |
|
RomaBusinessElement(java.lang.String name,
int opts,
RomaSecurityDef sec,
java.lang.String modelQName)
Constructs and connects a Business Element to the Roma network. |
|
RomaBusinessElement(java.lang.String name,
int opts,
RomaSecurityDef sec,
java.lang.String modelQName,
RomaILSData ilsData)
Constructs and connects a Business Element to the Roma network. |
|
RomaBusinessElement(java.lang.String name,
int opts,
RomaSecurityDef sec,
java.lang.String modelQName,
RomaILSData ilsData,
RomaDirectoryAccess dirAccess)
Constructs and connects a Business Element to the Roma network. |
Method Summary | |
RomaTheme |
buildTheme(RomaTheme theme,
RomaThemeInfo info,
int options,
boolean close)
Creates a new theme from the source theme and the theme details. |
void |
connect(java.lang.String name)
Attaches a named BusinessElement to the Roma network. |
void |
connect(java.lang.String name,
int opts)
Attaches a named BusinessElement to the Roma network. |
void |
connect(java.lang.String name,
int opts,
RomaSecurityDef sec)
Attaches a named BusinessElement to the Roma network. |
void |
connect(java.lang.String name,
int opts,
RomaSecurityDef sec,
java.lang.String modelQName)
Attaches a named BusinessElement to the Roma network. |
void |
connect(java.lang.String name,
int opts,
RomaSecurityDef sec,
java.lang.String modelQName,
RomaILSData ilsData)
Attaches a named BusinessElement to the Roma network. |
void |
connect(java.lang.String name,
int opts,
RomaSecurityDef sec,
java.lang.String modelQName,
RomaILSData ilsData,
RomaDirectoryAccess dirAccess)
Attaches a named BusinessElement to the Roma network. |
protected RomaBeRequest |
createRequest(RomaBeRequest request)
Unmarshal a retrieved request. |
RomaBeRequest |
get()
Gets a client request using default get options, i.e. |
RomaBeRequest |
get(RomaGetOptions opt)
Gets a client request according to the supplied get options. |
RomaBeRequest |
get(RomaGetOptions opt,
byte[] msgBuf,
RomaInteger msgBufSize)
Gets a client request according to the supplied get options. |
RomaBeRequest |
get(RomaGetOptions opt,
byte[] msgBuf,
RomaInteger msgBufSize,
byte[] tagBuf,
RomaInteger tagBufSize)
Gets a client request according to the supplied get options. |
RomaILSData |
getILSData()
Gets any data an inline service has made available to the application on initialization. |
RomaMessageInfo |
interpretMessage(RomaBeRequest msg,
int options)
Returns detailed information on the specified message. |
boolean |
isTermIndicator()
return true if termination indicator was set after put or get operation |
void |
put(RomaBeResponse resp)
Issues a response to a Client request. |
RomaThemeInfo |
queryTheme(RomaTheme theme)
Returns information on the specified theme. |
Methods inherited from class com.candle.roma.kxc.RomaContext |
closeTheme, commitLocal, copyTheme, deleteStorageQueue, disconnect, insertWorkflow, isConnected, mergeEteInfo, putException, putException, replaceWorkflow, reportError, reportError, rollbackLocal, sendAlert, setBusinessFlow, writeLog, writeSysLog |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public RomaBusinessElement()
public RomaBusinessElement(java.lang.String name) throws RomaError
name
- name of the Business ElementRomaError
- is thrown on connection failure.public RomaBusinessElement(java.lang.String name, int opts) throws RomaError
name
- name of the Business Element.opts
- application optionsRomaError
- is thrown on connection failure.RomaContext
public RomaBusinessElement(java.lang.String name, int opts, RomaSecurityDef sec) throws RomaError
name
- name of the Business Element.opts
- application optionssec
- security optionsRomaError
- is thrown on connection failure.RomaContext
public RomaBusinessElement(java.lang.String name, int opts, RomaSecurityDef sec, java.lang.String modelQName) throws RomaError
name
- name of the Business Element.opts
- application options.sec
- security options.modelQName
- model the queue on this when creating.RomaError
- is thrown on connection failure.RomaContext
public RomaBusinessElement(java.lang.String name, int opts, RomaSecurityDef sec, java.lang.String modelQName, RomaILSData ilsData) throws RomaError
name
- name of the Business Element.opts
- application options.sec
- security options.modelQName
- model the queue on this when creating.ilsData
- data to hand off to the ILSRomaError
- is thrown on connection failure.RomaContext
public RomaBusinessElement(java.lang.String name, int opts, RomaSecurityDef sec, java.lang.String modelQName, RomaILSData ilsData, RomaDirectoryAccess dirAccess) throws RomaError
name
- name of the Business Element.opts
- application options.sec
- security options.modelQName
- model the queue on this when creating.ilsData
- data to hand off to the ILSdirAccess
- LDAP authentication informationRomaError
- is thrown on connection failure.RomaContext
Method Detail |
public void connect(java.lang.String name) throws RomaError
name
- name of the Business Element.RomaError
- is thrown on operation failure.public void connect(java.lang.String name, int opts) throws RomaError
name
- name of the Business Elementopts
- application optionsRomaError
- is thrown on operation failure.public void connect(java.lang.String name, int opts, RomaSecurityDef sec) throws RomaError
name
- name of the Business Elementopts
- application optionssec
- security optionsRomaError
- is thrown on operation failure.public void connect(java.lang.String name, int opts, RomaSecurityDef sec, java.lang.String modelQName) throws RomaError
name
- name of the Business Elementopts
- application optionssec
- security optionsmodelQName
- model queue nameRomaError
- is thrown on operation failure.public void connect(java.lang.String name, int opts, RomaSecurityDef sec, java.lang.String modelQName, RomaILSData ilsData) throws RomaError
name
- name of the Business Elementopts
- application optionssec
- security optionsmodelQName
- model queue nameilsData
- data to hand off to the ILSRomaError
- is thrown on operation failure.public void connect(java.lang.String name, int opts, RomaSecurityDef sec, java.lang.String modelQName, RomaILSData ilsData, RomaDirectoryAccess dirAccess) throws RomaError
name
- name of the Business Elementopts
- application optionssec
- security optionsmodelQName
- model queue nameilsData
- data to hand off to the ILSdirAccess
- LDAP authentication informationRomaError
- is thrown on operation failure.public void put(RomaBeResponse resp) throws RomaError
resp
- Business Element responseRomaError
- is thrown on operation failure.RomaBeResponse
public RomaBeRequest get() throws RomaError
RomaError
- is thrown on failure of the get call.public RomaBeRequest get(RomaGetOptions opt) throws RomaError
opt
- get options used to select the request.RomaError
- is thrown on failure of the get call.public RomaBeRequest get(RomaGetOptions opt, byte[] msgBuf, RomaInteger msgBufSize) throws RomaError
opt
- get options used to select the request.msgBuf
- buffer to receive messagemsgBufSize
- size of message buffer.RomaError
- is thrown on failure of the get call.public RomaBeRequest get(RomaGetOptions opt, byte[] msgBuf, RomaInteger msgBufSize, byte[] tagBuf, RomaInteger tagBufSize) throws RomaError
opt
- get options used to select the request.msgBuf
- buffer to receive messagemsgBufSize
- size of message buffer.tagBuf
- buffer to receive tag datatagBufSize
- size of buffer to receive tag dataRomaError
- is thrown on failure of the get call.public boolean isTermIndicator()
public RomaILSData getILSData() throws RomaError
RomaError
- is thrown on operation failurepublic RomaThemeInfo queryTheme(RomaTheme theme) throws RomaError
theme
- Source themeRomaError
- is thrown if the operation failspublic RomaTheme buildTheme(RomaTheme theme, RomaThemeInfo info, int options, boolean close) throws RomaError
theme
- Source themedetails
- Theme detailsoptions
- Options indicating what parts of the theme information to
use for the theme build. It is THEMEINFO_ALL or a combination of
Roma.THEMEINFO_THEMEID
- use theme IDRoma.THEMEINFO_RETRYCOUNT
- use retry countRoma.THEMEINFO_WORKFLOW
- use workflow informationRoma.THEMEINFO_ETEINFO
- use ETE informationRoma.THEMEINFO_TRAILERS
- use persistent trailersRoma.THEMEINFO_CONFIRMFLAGS
- use confirmation flagsclose
- If true, closes the source themeRomaError
- is thrown if the operation failspublic RomaMessageInfo interpretMessage(RomaBeRequest msg, int options) throws RomaError
msg
- Source messageoptions
- Feature options, should be zero or one of
Roma.INTMSG_THEME
- extract the message theme. The application is responsible for the theme closing.RomaError
- is thrown if the operation failsprotected RomaBeRequest createRequest(RomaBeRequest request)
The RomaBusinessElement subclass' createRequest() method can construct the appropriate type of RomaBeRequest using the RomaBeRequest instance data. The createRequest() method is called by the get() method once the response is retrieved.
request
- a retrieved RomaBeRequest.
when constructing the RomaBeRequest object.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |