|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Transport
A generic transport interface. A Transport creates, sends and receives messages and has callback mechanisms for message listeners. It is used by the MessageParticipant. Message delivery is NOT reliable: messages can be lost and are discarded if nobody is listening for them or waiting in a receive. Note that a transport is also a recoverable resource, since MessageParticipants ask the transport whether they can be recovered or not. Only the transport knows if it can handle the protocol and wire protocol of a given MessageParticipant.
Field Summary | |
---|---|
static int |
FTP
Constant indicating FTP transport protocol. |
static int |
HTTP
Constant indicating a HTTP transport protocol. |
static int |
JMS
Constant indicating a JMS transport protocol. |
static int |
SMTP
Constant indicating SMTP transport protocol. |
static int |
UNKNOWN_PROTOCOL
Constant indicating an unknown transport protocol. |
Method Summary | |
---|---|
CommitMessage |
createCommitMessage(boolean onephase,
String senderURI,
String targetURI,
Object targetAddress)
Create a new commit message. |
ErrorMessage |
createErrorMessage(int code,
String senderURI,
String targetURI,
Object targetAddress)
Create a new error message. |
ForgetMessage |
createForgetMessage(String senderURI,
String targetURI,
Object targetAddress)
Create a new forget message. |
PreparedMessage |
createPreparedMessage(boolean readonly,
String senderURI,
String targetURI,
Object targetAddress)
Create a new prepared message. |
PrepareMessage |
createPrepareMessage(int globalSiblingCount,
CascadeInfo[] cascadeInfo,
String senderURI,
String targetURI,
Object targetAddress)
Create a new prepare message. |
PrepareMessage |
createPrepareMessage(String senderURI,
String targetURI,
Object targetAddress)
Create a new prepare message. |
RegisteredMessage |
createRegisteredMessage(String senderURI,
String targetURI,
Object targetAddress)
Create a new registration confirmation message. |
RegisterMessage |
createRegisterMessage(String senderURI,
String targetURI,
Object targetAddress,
boolean for2PC)
Create a new registration message. |
ReplayMessage |
createReplayMessage(String senderURI,
String targetURI,
Object targetAddress)
Create a new replay message. |
RollbackMessage |
createRollbackMessage(String senderURI,
String targetURI,
Object targetAddress)
Create a new rollback message. |
StateMessage |
createStateMessage(Boolean committed,
String senderURI,
String targetURI,
Object targetAddress)
Create a new state message. |
int |
getCommitProtocol()
The protocol that this transport understands. |
String |
getCoordinatorAddress()
Get the address on which this transport is listening for incoming coordinator messages. |
long |
getDefaultTimeout()
Get a realistic default timeout for the given transport. |
int |
getFormat()
Get the message format that this transport understands. |
String |
getParticipantAddress()
Get the address on which this transport is listening for incoming participant messages. |
int |
getTransportProtocol()
Get the transport protocol that this transport understands. |
void |
registerMessageListener(MessageListener listener)
Register a message listener for unexpected receivals. |
void |
registerMessageListener(MessageListener listener,
int messageType)
Register a message listener for incoming messages of the given type. |
void |
removeMessageListener(MessageListener listener)
Remove a previously registered listener. |
void |
send(TransactionMessage msg)
Send a message. |
TransactionMessage |
sendAndReceive(TransactionMessage msg,
long timeout,
int[] expected)
Send and receive a message for the given target. |
Methods inherited from interface com.atomikos.datasource.RecoverableResource |
---|
close, endRecovery, getName, isClosed, isSameRM, recover, setRecoveryService |
Field Detail |
---|
static final int UNKNOWN_PROTOCOL
static final int HTTP
static final int SMTP
static final int JMS
static final int FTP
Method Detail |
---|
int getCommitProtocol()
int getFormat()
int getTransportProtocol()
String getCoordinatorAddress()
String getParticipantAddress()
long getDefaultTimeout()
TransactionMessage sendAndReceive(TransactionMessage msg, long timeout, int[] expected) throws TransportException, IllegalMessageTypeException
msg
- The message to send.expected
- The types of messages expected. Other messages are ignored.
The values should be of TransactionMessage's predefined types.timeout
- The timeout in milliseconds after which the method will
return, received or not.
IllegalMessageTypeException
- If the message sent is of the wrong type.
TransportException
void send(TransactionMessage msg) throws TransportException, IllegalMessageTypeException
msg
- The message to send.
IllegalMessageTypeException
- If the message sent is of the wrong type.
TransportException
- On failure.void registerMessageListener(MessageListener listener) throws TransportException
listener
- The message listener.
TransportException
- On failure.void registerMessageListener(MessageListener listener, int messageType) throws TransportException
listener
- The listener.messageType
- The type to listen for.
TransportException
- On failure.void removeMessageListener(MessageListener listener) throws TransportException
listener
- The message listener.
TransportException
- On failure.CommitMessage createCommitMessage(boolean onephase, String senderURI, String targetURI, Object targetAddress)
ErrorMessage createErrorMessage(int code, String senderURI, String targetURI, Object targetAddress)
ForgetMessage createForgetMessage(String senderURI, String targetURI, Object targetAddress)
PrepareMessage createPrepareMessage(String senderURI, String targetURI, Object targetAddress)
PrepareMessage createPrepareMessage(int globalSiblingCount, CascadeInfo[] cascadeInfo, String senderURI, String targetURI, Object targetAddress)
PreparedMessage createPreparedMessage(boolean readonly, String senderURI, String targetURI, Object targetAddress)
ReplayMessage createReplayMessage(String senderURI, String targetURI, Object targetAddress)
RollbackMessage createRollbackMessage(String senderURI, String targetURI, Object targetAddress)
StateMessage createStateMessage(Boolean committed, String senderURI, String targetURI, Object targetAddress)
RegisterMessage createRegisterMessage(String senderURI, String targetURI, Object targetAddress, boolean for2PC)
RegisteredMessage createRegisteredMessage(String senderURI, String targetURI, Object targetAddress)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |