org.apache.activemq.command.ActiveMQObjectMessage Maven / Gradle / Ivy
Show all versions of activemq-osgi Show documentation
/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License 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 org.apache.activemq.command;
import java.io.DataInputStream;
import java.io.DataOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.ObjectOutputStream;
import java.io.OutputStream;
import java.io.Serializable;
import java.util.Arrays;
import java.util.List;
import java.util.zip.DeflaterOutputStream;
import java.util.zip.InflaterInputStream;
import jakarta.jms.JMSException;
import jakarta.jms.ObjectMessage;
import org.apache.activemq.ActiveMQConnection;
import org.apache.activemq.util.ByteArrayInputStream;
import org.apache.activemq.util.ByteArrayOutputStream;
import org.apache.activemq.util.ByteSequence;
import org.apache.activemq.util.ClassLoadingAwareObjectInputStream;
import org.apache.activemq.util.JMSExceptionSupport;
import org.apache.activemq.wireformat.WireFormat;
/**
* An ObjectMessage object is used to send a message that
* contains a serializable object in the Java programming language ("Java
* object"). It inherits from the Message interface and adds a
* body containing a single reference to an object. Only
* Serializable Java objects can be used.
*
* If a collection of Java objects must be sent, one of the
* Collection classes provided since JDK 1.2 can be used.
*
* When a client receives an ObjectMessage, 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.
*
* @openwire:marshaller code="26"
* @see jakarta.jms.Session#createObjectMessage()
* @see jakarta.jms.Session#createObjectMessage(Serializable)
* @see jakarta.jms.BytesMessage
* @see jakarta.jms.MapMessage
* @see jakarta.jms.Message
* @see jakarta.jms.StreamMessage
* @see jakarta.jms.TextMessage
*/
public class ActiveMQObjectMessage extends ActiveMQMessage implements ObjectMessage, TransientInitializer {
public static final byte DATA_STRUCTURE_TYPE = CommandTypes.ACTIVEMQ_OBJECT_MESSAGE;
private transient List trustedPackages = Arrays.asList(ClassLoadingAwareObjectInputStream.serializablePackages);
private transient boolean trustAllPackages = false;
protected transient Serializable object;
@Override
public Message copy() {
ActiveMQObjectMessage copy = new ActiveMQObjectMessage();
copy(copy);
copy.setTrustAllPackages(trustAllPackages);
copy.setTrustedPackages(trustedPackages);
return copy;
}
private void copy(ActiveMQObjectMessage copy) {
ActiveMQConnection connection = getConnection();
if (connection == null || !connection.isObjectMessageSerializationDefered()) {
storeContent();
copy.object = null;
} else {
copy.object = object;
}
super.copy(copy);
}
@Override
public void storeContentAndClear() {
storeContent();
object = null;
}
@Override
public void storeContent() {
ByteSequence bodyAsBytes = getContent();
if (bodyAsBytes == null && object != null) {
try {
ByteArrayOutputStream bytesOut = new ByteArrayOutputStream();
OutputStream os = bytesOut;
ActiveMQConnection connection = getConnection();
if (connection != null && connection.isUseCompression()) {
compressed = true;
os = new DeflaterOutputStream(os);
}
DataOutputStream dataOut = new DataOutputStream(os);
ObjectOutputStream objOut = new ObjectOutputStream(dataOut);
objOut.writeObject(object);
objOut.flush();
objOut.reset();
objOut.close();
setContent(bytesOut.toByteSequence());
} catch (IOException ioe) {
throw new RuntimeException(ioe.getMessage(), ioe);
}
}
}
@Override
public boolean isContentMarshalled() {
return content != null || object == null;
}
@Override
public byte getDataStructureType() {
return DATA_STRUCTURE_TYPE;
}
@Override
public String getJMSXMimeType() {
return "jms/object-message";
}
/**
* Clears out the message body. Clearing a message's body does not clear its
* header values or property entries.
*
* If this message body was read-only, calling this method leaves the
* message body in the same state as an empty body in a newly created
* message.
*
* @throws JMSException if the JMS provider fails to clear the message body
* due to some internal error.
*/
@Override
public void clearBody() throws JMSException {
super.clearBody();
this.object = null;
}
/**
* Sets the serializable object containing this message's data. It is
* important to note that an ObjectMessage contains a
* snapshot of the object at the time setObject() is called;
* subsequent modifications of the object will have no effect on the
* ObjectMessage body.
*
* @param newObject the message's data
* @throws JMSException if the JMS provider fails to set the object due to
* some internal error.
* @throws jakarta.jms.MessageFormatException if object serialization fails.
* @throws jakarta.jms.MessageNotWriteableException if the message is in
* read-only mode.
*/
@Override
public void setObject(Serializable newObject) throws JMSException {
checkReadOnlyBody();
this.object = newObject;
setContent(null);
ActiveMQConnection connection = getConnection();
if (connection == null || !connection.isObjectMessageSerializationDefered()) {
storeContent();
}
}
/**
* Gets the serializable object containing this message's data. The default
* value is null.
*
* @return the serializable object containing this message's data
* @throws JMSException
*/
@Override
public Serializable getObject() throws JMSException {
final ByteSequence content = getContent();
if (object == null && content != null) {
this.object = deserialize(content);
}
return this.object;
}
private Serializable deserialize(ByteSequence content) throws JMSException {
Serializable object = null;
if (content != null) {
try {
InputStream is = new ByteArrayInputStream(content);
if (isCompressed()) {
is = new InflaterInputStream(is);
}
DataInputStream dataIn = new DataInputStream(is);
ClassLoadingAwareObjectInputStream objIn = new ClassLoadingAwareObjectInputStream(dataIn);
objIn.setTrustedPackages(trustedPackages);
objIn.setTrustAllPackages(trustAllPackages);
try {
object = (Serializable)objIn.readObject();
} catch (ClassNotFoundException ce) {
throw JMSExceptionSupport.create("Failed to build body from content. Serializable class not available to broker. Reason: " + ce, ce);
} finally {
dataIn.close();
}
} catch (IOException e) {
throw JMSExceptionSupport.create("Failed to build body from bytes. Reason: " + e, e);
}
}
return object;
}
@Override
public void beforeMarshall(WireFormat wireFormat) throws IOException {
super.beforeMarshall(wireFormat);
// may have initiated on vm transport with deferred marshalling
storeContent();
}
@Override
public void clearUnMarshalledState() throws JMSException {
super.clearUnMarshalledState();
this.object = null;
}
@Override
public void onMessageRolledBack() {
super.onMessageRolledBack();
// lets force the object to be deserialized again - as we could have
// changed the object
object = null;
}
@Override
public void compress() throws IOException {
storeContent();
super.compress();
}
@Override
public String toString() {
try {
getObject();
} catch (JMSException e) {
}
return super.toString();
}
public List getTrustedPackages() {
return trustedPackages;
}
public void setTrustedPackages(List trustedPackages) {
this.trustedPackages = trustedPackages;
}
public boolean isTrustAllPackages() {
return trustAllPackages;
}
public void setTrustAllPackages(boolean trustAllPackages) {
this.trustAllPackages = trustAllPackages;
}
@Override
public void initTransients() {
trustedPackages = Arrays.asList(ClassLoadingAwareObjectInputStream.serializablePackages);
trustAllPackages = false;
}
@Override
public boolean isBodyAssignableTo(Class c) throws JMSException {
final Serializable object = getObject();
if (object == null) {
return true;
}
return Serializable.class == c || Object.class == c || c.isInstance(object);
}
@SuppressWarnings("unchecked")
protected T doGetBody(Class asType) throws JMSException {
storeContent();
final ByteSequence content = getContent();
return content != null ? (T) deserialize(content) : null;
}
}