org.apache.camel.component.mina.MinaPayloadHolder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of camel-mina Show documentation
Camel MINA support
There is a newer version: 4.8.1
/**
 * 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.camel.component.mina;

import java.io.Serializable;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Set;

import org.apache.camel.Exchange;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * Holder object for sending an exchange over the wire using the MINA ObjectSerializationCodecFactory codec.
 * This is configured using the transferExchange=true option for the TCP protocol.
 * 
 * As opposed to normal usage of camel-mina where only the body part of the exchange is transfered, this holder
 * object serializes the following fields over the wire:
 * 

 *     in body
 *     out body
 *     in headers
 *     out headers
 *     fault body 
 *     fault headers
 *     exchange properties
 *     exception
 * 
 *
 * @version $Revision: 691586 $
 */
public class MinaPayloadHolder implements Serializable {
    private static final long serialVersionUID = 1L;
    private static final transient Log LOG = LogFactory.getLog(MinaPayloadHolder.class);

    private Object inBody;
    private Object outBody;
    private Object faultBody;
    private Map inHeaders = new LinkedHashMap();
    private Map outHeaders = new LinkedHashMap();
    private Map properties = new LinkedHashMap();
    private Map faultHeaders = new LinkedHashMap();
    private Throwable exception;

    /**
     * Creates a payload object with the information from the given exchange.
     * Only marshal the Serializable object
     *
     * @param exchange     the exchange
     * @return the holder object with information copied form the exchange
     */
    public static MinaPayloadHolder marshal(Exchange exchange) {
        MinaPayloadHolder payload = new MinaPayloadHolder();

        payload.inBody = checkSerializableObject(exchange.getIn().getBody());
        if (exchange.getOut(false) != null) {
            payload.outBody = checkSerializableObject(exchange.getOut().getBody());
        }
        payload.inHeaders.putAll(checkMapSerializableObjects(exchange.getIn().getHeaders()));
        payload.outHeaders.putAll(checkMapSerializableObjects(exchange.getOut().getHeaders()));
        payload.properties.putAll(checkMapSerializableObjects(exchange.getProperties()));
        payload.exception = exchange.getException();
        if (exchange.getFault(false) != null) {
            payload.faultBody = exchange.getFault().getBody();
            payload.faultHeaders.putAll(checkMapSerializableObjects(exchange.getFault().getHeaders()));
        }

        return payload;
    }

    /**
     * Transfers the information from the payload to the exchange.
     *
     * @param exchange   the exchange to set values from the payload
     * @param payload    the payload with the values
     */
    public static void unmarshal(Exchange exchange, MinaPayloadHolder payload) {
        exchange.getIn().setBody(payload.inBody);
        exchange.getOut().setBody(payload.outBody);
        exchange.getIn().setHeaders(payload.inHeaders);
        exchange.getOut().setHeaders(payload.outHeaders);
        if (payload.faultBody != null) {
            exchange.getFault().setBody(payload.faultBody);
            exchange.getFault().setHeaders(payload.faultHeaders);
        }
        for (String key : payload.properties.keySet()) {
            exchange.setProperty(key, payload.properties.get(key));
        }
        exchange.setException(payload.exception);
    }

    public String toString() {
        return "MinaPayloadHolder{" + "inBody=" + inBody + ", outBody=" + outBody + ", inHeaders="
               + inHeaders + ", outHeaders=" + outHeaders + ", faultBody=" + faultBody + " , faultHeaders="
               + faultHeaders + ", properties=" + properties + ", exception=" + exception + '}';
    }

    private static Object checkSerializableObject(Object object) {
        if (object instanceof Serializable) {
            return object;
        } else {
            LOG.warn("Object " + object + " can't be serialized, it will be excluded by the MinaPayloadHolder");
            return null;
        }
    }

    private static Map checkMapSerializableObjects(Map map) {
        if (map == null) {
            return null;
        }

        Map result = new LinkedHashMap();
        for (Map.Entry entry : map.entrySet()) {

            if (entry.getValue() instanceof Serializable) {
                result.put(entry.getKey(), entry.getValue());
            } else {
                LOG.warn("Object " + entry.getValue() + " of key " + entry.getKey()
                         + " can't be serialized, it will be excluded by the MinaPayloadHolder");
            }
        }
        return result;

    }


}