com.sun.messaging.jmq.jmsclient.TextMessageImpl Maven / Gradle / Ivy
/*
* Copyright (c) 2000, 2020 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2020 Payara Services Ltd.
* Copyright (c) 2021 Contributors to the Eclipse Foundation
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package com.sun.messaging.jmq.jmsclient;
import java.io.*;
import jakarta.jms.*;
import com.sun.messaging.AdministeredObject;
import com.sun.messaging.jmq.io.PacketType;
/**
* A TextMessage is used to send a message containing a java.lang.String. It inherits from
* Message and adds a text message body.
*
*
* The inclusion of this message type is based on our presumption that XML will likely become a popular mechanism for
* representing content of all kinds including the content of JMS messages.
*
*
* 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.
*
* @see jakarta.jms.Session#createTextMessage()
* @see jakarta.jms.Session#createTextMessage(String)
* @see jakarta.jms.BytesMessage
* @see jakarta.jms.MapMessage
* @see jakarta.jms.Message
* @see jakarta.jms.ObjectMessage
* @see jakarta.jms.StreamMessage
* @see java.lang.String
*/
public class TextMessageImpl extends MessageImpl implements TextMessage {
private String text = null;
// serialize message body
// This is called when producing messages.
@Override
protected void setMessageBodyToPacket() throws JMSException {
// ObjectOutputStream oos;
if (text == null) {
return;
}
try {
setMessageBody(text.getBytes(UTF8));
} catch (Exception e) {
ExceptionHandler.handleException(e, AdministeredObject.cr.X_MESSAGE_SERIALIZE);
}
}
// deserialize message body
// This is called after message is received
@Override
protected void getMessageBodyFromPacket() throws JMSException {
// InputStream is = getMessageBodyStream();
// ObjectInputStream ois = new ObjectInputStream (is);
// text = (String) ois.readObject();
try {
byte[] body = getMessageBody();
if (body != null) {
text = new String(body, UTF8);
}
} catch (Exception e) {
ExceptionHandler.handleException(e, AdministeredObject.cr.X_MESSAGE_DESERIALIZE);
}
}
/**
* Constructor.
*/
protected TextMessageImpl() throws JMSException {
setPacketType(PacketType.TEXT_MESSAGE);
}
/**
* clear body
*/
@Override
public void clearBody() throws JMSException {
text = null;
setMessageReadMode(false);
}
/**
* Set the string containing this message's data.
*
* @param string the String containing the message's data
*
* @exception JMSException if JMS fails to set text due to some internal JMS error.
* @exception MessageNotWriteableException if message in read-only mode.
*/
@Override
public void setText(String string) throws JMSException {
checkMessageAccess();
text = string;
}
/**
* Get the string containing this message's data. The default value is null.
*
* @return the String containing the message's data
*
* @exception JMSException if JMS fails to get text due to some internal JMS error.
*/
@Override
public String getText() throws JMSException {
return text;
}
@Override
public String toString() {
return new StringBuilder().append("\nText:\t").append(text).append(super.toString()).toString();
}
@Override
public void dump(PrintStream ps) {
ps.println("------ TextMessageImpl dump ------");
super.dump(ps);
}
}