com.adaptris.msmq

Interface Queue

public interface Queue

Wraps simple MSMQ operations on a Queue.

This does not expose all the MSMQQueue methods, but is a limited wrapper around the key functionality required to perform MSMQ Integration

Method Summary

Modifier and Type	Method and Description
void	close() Close the queue that was previously opened.
boolean	hasMessages(long timeout) Peek a queue and find out if there are any messages.
void	open(MQOAConstants.AccessMode accessMode) Open the queue for sending or receiving.
void	open(MQOAConstants.AccessMode accessMode, MQOAConstants.ShareMode sharedMode) Open the queue for sending or receiving.
void	purge() Delete all the messages from the queue.
Message	receive(long timeout) Receive a message from the queue with a TransactionMode of MQOAConstants.TransactionMode.MQ_NO_TRANSACTION
Message	receive(long timeout, MQOAConstants.TransactionMode mode) Receive a message.
void	send(Message msg) Send the message to this queue with a TransactionMode of MQOAConstants.TransactionMode.MQ_NO_TRANSACTION
void	send(Message msg, MQOAConstants.TransactionMode mode) Send the message to this queue.

Method Detail

close

void close()
    throws MSMQException

Close the queue that was previously opened.

Throws:

MSMQException - wrapping any underlying exception.

open

void open(MQOAConstants.AccessMode accessMode,
          MQOAConstants.ShareMode sharedMode)
   throws MSMQException

Open the queue for sending or receiving.

Parameters:

accessMode - the mode.

sharedMode - the shared mode.

Throws:

MSMQException - wrapping any underlying exception.

See Also:

MQOAConstants.AccessMode, MQOAConstants.ShareMode

open

void open(MQOAConstants.AccessMode accessMode)
   throws MSMQException

Open the queue for sending or receiving.

This implies a ShareMode of MQOAConstants.ShareMode.MQ_DENY_NONE

Parameters:

accessMode - the mode.

Throws:

MSMQException

See Also:

MQOAConstants.AccessMode

receive

Message receive(long timeout)
         throws MSMQException

Receive a message from the queue with a TransactionMode of MQOAConstants.TransactionMode.MQ_NO_TRANSACTION

Parameters:

timeout - the timeout in milliseconds.

Returns:

The message (or null if the timeout was exceeded)

Throws:

MSMQException - wrapping any underlying exceptions.

receive

Message receive(long timeout,
                MQOAConstants.TransactionMode mode)
         throws MSMQException

Receive a message.

Parameters:

timeout - the timeout in milliseconds.

mode - the transaction mode.

Returns:

The message (or null if the timeout was exceeded)

Throws:

MSMQException - wrapping any underlying exceptions.

See Also:

MQOAConstants.TransactionMode

hasMessages

boolean hasMessages(long timeout)
             throws MSMQException

Peek a queue and find out if there are any messages.

Parameters:

timeout -

Returns:

true if there are messages.

Throws:

MSMQException

send

void send(Message msg,
          MQOAConstants.TransactionMode mode)
   throws MSMQException

Send the message to this queue.

Parameters:

msg - the message to be sent.

mode - the transaction mode

Throws:

MSMQException - wrapping any underlying exceptions.

See Also:

MQOAConstants.TransactionMode

send

void send(Message msg)
   throws MSMQException

Send the message to this queue with a TransactionMode of MQOAConstants.TransactionMode.MQ_NO_TRANSACTION

Parameters:

msg - the message to be sent.

Throws:

MSMQException - wrapping any underlying exceptions.

See Also:

MQOAConstants.TransactionMode

purge

void purge()
    throws MSMQException

Delete all the messages from the queue.

Throws:

MSMQException - wrapping any underlying exceptions.