|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.candle.roma.kxc.RomaSubscription
This class encapsulates subscription messages put by a Roma client. Almost all of the methods provided are provided the same as the RomaClientRequest class. The class also provides the setOnRequest and setNewPubsOnly methods. setOnRequest means that the subscriber won't get publications until it requests them using RomaClient.RequestUpdates(). setNewPubsOnly means that the subscriber will only receive newly issued publications and not retained publications.
Constructor Summary | |
RomaSubscription(java.lang.String svcName,
RomaSubject subject)
Constructs a subscription with default options and with the name of a Roma business service and subject to subscribe to. |
Method Summary | |
RomaILSData |
getILSData()
Get incoming ILS data |
void |
setApiProfileName(java.lang.String profile)
Associates an API profile with the 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 |
setDatagram(boolean b)
Sets the datagram flag. |
void |
setErrorProfileName(java.lang.String profile)
Associates an error profile with the operation. |
void |
setExpiry(int expiry)
Set a new message expiry time. |
void |
setFeedback(int feedback)
Sets a new message feedback code. |
void |
setILSData(RomaILSData ilsData)
Set outgoing ILS data |
void |
setMsgName(java.lang.String messageName)
Set the name of this message |
void |
setNewPubsOnly(boolean b)
Sets the New Publications Only flag, which means that the subscriber won't receive publications that were published and retained before receipt of the subscription. |
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 subscribe or unsubscribe operation fails. |
void |
setOnRequest(boolean b)
Sets the On Request option, whereby the subscriber has to request updates. |
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 |
setServiceName(java.lang.String svcName)
Sets the name of the Roma Business Service that a publish operation will send this subscription to. |
void |
setSubject(RomaSubject subject)
Set a subject of the subscription |
void |
setSuppressErrorProfile(boolean b)
Specify if error profiling is to be suppressed |
void |
setSyncpointDef(RomaSyncpointDef sync)
Specify sync point definitiion |
void |
setTermSupported(boolean b)
Specify if termination is supported |
void |
setTheme(RomaTheme theme)
Update the message theme. |
void |
setUseTheme(boolean b)
Specify whether an existing theme should be used. |
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 RomaSubscription(java.lang.String svcName, RomaSubject subject)
svcName
- Name of a Roma Business Service.subject
- Subject of the publication.Method Detail |
public void setServiceName(java.lang.String svcName)
svcName
- Roma Business Service name.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 setNoEms(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 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 setTheme(RomaTheme theme)
theme
- RomaTheme object.public RomaTheme theme()
public void setMsgName(java.lang.String messageName)
messageName
- name to be usedpublic 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()
public void setSubject(RomaSubject subject)
subject
- subject of the subscriptionpublic void setNewPubsOnly(boolean b)
b
- one of :-
public void setOnRequest(boolean b)
b
- one of :-
RomaClient.requestUpdates(RomaSubscription)
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |