com.amazon.sqs.javamessaging

Class SQSMessageProducer

java.lang.Object

com.amazon.sqs.javamessaging.SQSMessageProducer

public class SQSMessageProducer
extends java.lang.Object

A client uses a MessageProducer object to send messages to a queue destination. A MessageProducer object is created by passing a Destination object to a message-producer creation method supplied by a session.

A client also has the option of creating a message producer without supplying a queue destination. In this case, a destination must be provided with every send operation.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the message producer.
int	getDeliveryMode() This method is not supported.
Destination	getDestination() Gets the destination associated with this MessageProducer.
boolean	getDisableMessageID() This method is not supported.
boolean	getDisableMessageTimestamp() This method is not supported.
int	getPriority() This method is not supported.
Queue	getQueue()
long	getTimeToLive() This method is not supported.
void	send(Destination destination, Message message) Sends a message to a queue destination.
void	send(Destination destination, Message message, int deliveryMode, int priority, long timeToLive) Sends a message to a queue destination.
void	send(Message message) Sends a message to a destination created during the creation time of this message producer.
void	send(Message message, int deliveryMode, int priority, long timeToLive) Sends a message to a destination created during the creation time of this message producer.
void	send(Queue queue, Message message) Sends a message to a queue.
void	send(Queue queue, Message message, int deliveryMode, int priority, long timeToLive) Sends a message to a queue.
void	setDeliveryMode(int deliveryMode) This method is not supported.
void	setDisableMessageID(boolean value) This method is not supported.
void	setDisableMessageTimestamp(boolean value) This method is not supported.
void	setPriority(int defaultPriority) This method is not supported.
void	setTimeToLive(long timeToLive) This method is not supported.

Methods inherited from class java.lang.Object

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

Method Detail

getQueue

public Queue getQueue()
               throws JMSException

Throws:

JMSException

send

public void send(Queue queue,
        Message message)
          throws JMSException

Sends a message to a queue.

Parameters:

queue - the queue destination to send this message to

message - the message to send

Throws:

InvalidDestinationException - If a client uses this method with a destination other than SQS queue destination.

MessageFormatException - If an invalid message is specified.

java.lang.UnsupportedOperationException - If a client uses this method with a MessageProducer that specified a destination at creation time.

JMSException - If session is closed or internal error.

send

public void send(Queue queue,
        Message message,
        int deliveryMode,
        int priority,
        long timeToLive)
          throws JMSException

Sends a message to a queue.

Send does not support deliveryMode, priority, and timeToLive. It will ignore anything in deliveryMode, priority, and timeToLive.

Parameters:

queue - the queue destination to send this message to

message - the message to send

deliveryMode -

priority -

timeToLive -

Throws:

InvalidDestinationException - If a client uses this method with a destination other than SQS queue destination.

MessageFormatException - If an invalid message is specified.

java.lang.UnsupportedOperationException - If a client uses this method with a MessageProducer that specified a destination at creation time.

JMSException - If session is closed or internal error.

getDestination

public Destination getDestination()
                           throws JMSException

Gets the destination associated with this MessageProducer.

Returns:

this producer's queue destination

Throws:

JMSException

close

public void close()
           throws JMSException

Closes the message producer.

Throws:

JMSException

send

public void send(Message message)
          throws JMSException

Sends a message to a destination created during the creation time of this message producer.

Parameters:

message - the message to send

Throws:

MessageFormatException - If an invalid message is specified.

java.lang.UnsupportedOperationException - If a client uses this method with a MessageProducer that did not specify a destination at creation time.

JMSException - If session is closed or internal error.

send

public void send(Message message,
        int deliveryMode,
        int priority,
        long timeToLive)
          throws JMSException

Sends a message to a destination created during the creation time of this message producer.

Send does not support deliveryMode, priority, and timeToLive. It will ignore anything in deliveryMode, priority, and timeToLive.

Parameters:

message - the message to send

deliveryMode -

priority -

timeToLive -

Throws:

MessageFormatException - If an invalid message is specified.

java.lang.UnsupportedOperationException - If a client uses this method with a MessageProducer that did not specify a destination at creation time.

JMSException - If session is closed or internal error.

send

public void send(Destination destination,
        Message message)
          throws JMSException

Sends a message to a queue destination.

Parameters:

destination - the queue destination to send this message to

message - the message to send

Throws:

InvalidDestinationException - If a client uses this method with a destination other than valid SQS queue destination.

MessageFormatException - If an invalid message is specified.

java.lang.UnsupportedOperationException - If a client uses this method with a MessageProducer that specified a destination at creation time.

JMSException - If session is closed or internal error.

send

public void send(Destination destination,
        Message message,
        int deliveryMode,
        int priority,
        long timeToLive)
          throws JMSException

Sends a message to a queue destination.

Send does not support deliveryMode, priority, and timeToLive. It will ignore anything in deliveryMode, priority, and timeToLive.

Parameters:

destination - the queue destination to send this message to

message - the message to send

deliveryMode -

priority -

timeToLive -

Throws:

InvalidDestinationException - If a client uses this method with a destination other than valid SQS queue destination.

MessageFormatException - If an invalid message is specified.

java.lang.UnsupportedOperationException - If a client uses this method with a MessageProducer that specified a destination at creation time.

JMSException - If session is closed or internal error.

setDisableMessageID

public void setDisableMessageID(boolean value)
                         throws JMSException

This method is not supported.

Throws:

JMSException

getDisableMessageID

public boolean getDisableMessageID()
                            throws JMSException

This method is not supported.

Throws:

JMSException

setDisableMessageTimestamp

public void setDisableMessageTimestamp(boolean value)
                                throws JMSException

This method is not supported.

Throws:

JMSException

getDisableMessageTimestamp

public boolean getDisableMessageTimestamp()
                                   throws JMSException

This method is not supported.

Throws:

JMSException

setDeliveryMode

public void setDeliveryMode(int deliveryMode)
                     throws JMSException

This method is not supported.

Throws:

JMSException

getDeliveryMode

public int getDeliveryMode()
                    throws JMSException

This method is not supported.

Throws:

JMSException

setPriority

public void setPriority(int defaultPriority)
                 throws JMSException

This method is not supported.

Throws:

JMSException

getPriority

public int getPriority()
                throws JMSException

This method is not supported.

Throws:

JMSException

setTimeToLive

public void setTimeToLive(long timeToLive)
                   throws JMSException

This method is not supported.

Throws:

JMSException

getTimeToLive

public long getTimeToLive()
                   throws JMSException

This method is not supported.

Throws:

JMSException