com.adaptris.tibrv

Class CertifiedRendezvousClient

java.lang.Object

com.adaptris.tibrv.RendezvousClientImp

com.adaptris.tibrv.CertifiedRendezvousClient

All Implemented Interfaces:

RendezvousClient

public class CertifiedRendezvousClient
extends RendezvousClientImp

Implementation of RendezvousClient which provides certified message delivery. Persistent messaging requires a ledger file name and request old to be set to true.

In the adapter configuration file this class is aliased as certified-rendezvous-client which is the preferred alternative to the fully qualified classname when building your configuration.

Field Summary

Fields inherited from class com.adaptris.tibrv.RendezvousClientImp

log, queue, transport

Constructor Summary

Constructors

Constructor and Description
CertifiedRendezvousClient() Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	close() Close this instance.
void	createConfirmationListener(com.tibco.tibrv.TibrvMsgCallback callback) Creates a TibrvListener for confirmation messages, which may be useful for debugging / troubleshooting.
void	createMessageListener(com.tibco.tibrv.TibrvMsgCallback callback, java.lang.String sendSubject) Creates a TibrvListener using the passed callback and sendSubject.
java.lang.String	getConfirmationSubject() Returns the optional confirmation subject.
long	getDeliveryTimeLimit() Return the delivery time limit in seconds.
java.lang.String	getLedgerFileName() Returns the name of the file to use as a ledger file.
boolean	getRequestOld() If request old is true, when consumers which use this client start up they will request messages which were delivered while they were not running.
java.lang.String	getUniqueName() Returns the name of the underlying certified transport, which must be unique in the context of all certified transports in the system.
void	init() Initialise this instance.
void	send(com.tibco.tibrv.TibrvMsg tibrvMsg) Sends the passed TibrvMsg.
void	setConfirmationSubject(java.lang.String s) Sets the optional confirmation subject.
void	setDeliveryTimeLimit(long l) Sets the delivery time limit in seconds.
void	setLedgerFileName(java.lang.String s) Sets the name of the file to use as a ledger file.
void	setRequestOld(boolean b) If request old is true, when consumers which use this client start up they will request messages which were delivered while they were not running.
void	setUniqueName(java.lang.String s) Sets the name of the underlying certified transport, which must be unique in the context of all certified transports in the system.
java.lang.String	toString()

Methods inherited from class com.adaptris.tibrv.RendezvousClientImp

getDaemon, getNetwork, getQueueName, getService, setDaemon, setNetwork, setQueueName, setService, start, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CertifiedRendezvousClient

public CertifiedRendezvousClient()

Creates a new instance. Default delivery time limit is 0 (no limit).

Method Detail

createMessageListener

public void createMessageListener(com.tibco.tibrv.TibrvMsgCallback callback,
                                  java.lang.String sendSubject)
                           throws com.tibco.tibrv.TibrvException

Description copied from interface: RendezvousClient

Creates a TibrvListener using the passed callback and sendSubject. Not part of init as only required by client code which consumes messages.

Parameters:

callback - the TibrvMsgCallback (some sort of consumer)

sendSubject - the send subject, conforming to TibcoRendezvous rules

Throws:

com.tibco.tibrv.TibrvException - if any occur

See Also:

(com.tibco.tibrv.TibrvMsgCallback, java.lang.String)

createConfirmationListener

public void createConfirmationListener(com.tibco.tibrv.TibrvMsgCallback callback)
                                throws com.tibco.tibrv.TibrvException

Description copied from interface: RendezvousClient

Creates a TibrvListener for confirmation messages, which may be useful for debugging / troubleshooting.

Parameters:

callback - the TibrvMsgCallback to use

Throws:

com.tibco.tibrv.TibrvException - if any occur

See Also:

#createConfirmationListener(com.tibco.tibrv.TibrvMsgCallback)

send

public void send(com.tibco.tibrv.TibrvMsg tibrvMsg)
          throws com.tibco.tibrv.TibrvException

Description copied from interface: RendezvousClient

Sends the passed TibrvMsg.

Specified by:

send in interface RendezvousClient

Overrides:

send in class RendezvousClientImp

Parameters:

tibrvMsg - the message to send

Throws:

com.tibco.tibrv.TibrvException - if any occur

See Also:

#send(com.tibco.tibrv.TibrvMsg)

init

public void init()
          throws com.tibco.tibrv.TibrvException

Description copied from interface: RendezvousClient

Initialise this instance.

Specified by:

init in interface RendezvousClient

Overrides:

init in class RendezvousClientImp

Throws:

com.tibco.tibrv.TibrvException - if any occur

See Also:

RendezvousClientImp.init()

close

public void close()

Description copied from interface: RendezvousClient

Close this instance.

Specified by:

close in interface RendezvousClient

Overrides:

close in class RendezvousClientImp

See Also:

StandardRendezvousClient.close()

toString

public java.lang.String toString()

Overrides:

toString in class RendezvousClientImp

See Also:

RendezvousClientImp.toString()

getUniqueName

public java.lang.String getUniqueName()

Returns the name of the underlying certified transport, which must be unique in the context of all certified transports in the system.

Returns:

the name of the underlying certified transport

setUniqueName

public void setUniqueName(java.lang.String s)

Sets the name of the underlying certified transport, which must be unique in the context of all certified transports in the system.

Parameters:

s - the name of the underlying certified transport

getRequestOld

public boolean getRequestOld()

If request old is true, when consumers which use this client start up they will request messages which were delivered while they were not running. This is analgous to durable subscriptions in JMS.

Returns:

whether to request old messages or not

setRequestOld

public void setRequestOld(boolean b)

If request old is true, when consumers which use this client start up they will request messages which were delivered while they were not running. This is analgous to durable subscriptions in JMS.

Parameters:

b - whether to request old messages or not

getConfirmationSubject

public java.lang.String getConfirmationSubject()

Returns the optional confirmation subject. This can be used to obtain and log confirmation messages which may be useful for debugging or troubleshooting.

Returns:

the optional confirmation subject

setConfirmationSubject

public void setConfirmationSubject(java.lang.String s)

Sets the optional confirmation subject. This can be used to obtain and log confirmation messages which may be useful for debugging or troubleshooting.

Parameters:

s - the optional confirmation subject

getDeliveryTimeLimit

public long getDeliveryTimeLimit()

Return the delivery time limit in seconds. After the delivery time limit the message will not be delivered. This is analgous to time to live in JMS.

Returns:

the delivery time limit in seconds

setDeliveryTimeLimit

public void setDeliveryTimeLimit(long l)

Sets the delivery time limit in seconds. After the delivery time limit the message will not be delivered. This is analgous to time to live in JMS.

Parameters:

l - delivery time limit in seconds

getLedgerFileName

public java.lang.String getLedgerFileName()

Returns the name of the file to use as a ledger file. If no file name is specified a transient process ledger will be used.

Returns:

the name of the file to use as a ledger file

setLedgerFileName

public void setLedgerFileName(java.lang.String s)

Sets the name of the file to use as a ledger file. If no file name is specified a transient process ledger will be used.

Parameters:

s - the name of the file to use as a ledger file