com.amazon.sqs.javamessaging.message.SQSTextMessage Maven / Gradle / Ivy
Show all versions of amazon-sqs-java-messaging-lib Show documentation
/*
* Copyright 2010-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazon.sqs.javamessaging.message;
import javax.jms.JMSException;
import javax.jms.TextMessage;
import com.amazon.sqs.javamessaging.acknowledge.Acknowledger;
import com.amazonaws.services.sqs.model.Message;
/**
* A TextMessage object is used to send a message body containing a
* java.lang.String. It inherits from the Message interface and adds a text
* message body. SQS does not accept empty or null message body
*
* When a client receives a TextMessage, it is in read-only mode. If a client
* attempts to write to the message at this point, a
* MessageNotWriteableException is thrown. If clearBody is called, the message
* can now be both read from and written to.
*/
public class SQSTextMessage extends SQSMessage implements TextMessage {
/**
* Text of the message. Assume this is safe from SQS invalid characters.
*/
private String text;
/**
* Convert received SQSMessage into TextMessage.
*/
public SQSTextMessage(Acknowledger acknowledger, String queueUrl, Message sqsMessage) throws JMSException{
super(acknowledger, queueUrl, sqsMessage);
this.text = sqsMessage.getBody();
}
/**
* Create new empty TextMessage to send.
*/
public SQSTextMessage() throws JMSException {
super();
}
/**
* Create new TextMessage with payload to send.
*/
public SQSTextMessage(String payload) throws JMSException {
super();
this.text = payload;
}
/**
* Sets the text containing this message's body.
*
* @param string
* The String containing the message's body
* @throws MessageNotWriteableException
* If the message is in read-only mode.
*/
@Override
public void setText(String string) throws JMSException {
checkBodyWritePermissions();
this.text = string;
}
/**
* Gets the text containing this message's body.
*
* @return The String containing the message's body
*/
@Override
public String getText() throws JMSException {
return text;
}
/**
* Sets the message body to write mode, and sets the text to null
*/
@Override
public void clearBody() throws JMSException {
text = null;
setBodyWritePermissions(true);
}
}