org.apache.camel.component.mina.MinaHelper 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 org.apache.camel.CamelExchangeException;
import org.apache.camel.Exchange;
import org.apache.camel.NoTypeConversionAvailableException;
import org.apache.camel.StreamCache;
import org.apache.mina.core.future.WriteFuture;
import org.apache.mina.core.session.IoSession;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Helper class used internally by camel-mina using Apache MINA.
 */
public final class MinaHelper {

    private static final Logger LOG = LoggerFactory.getLogger(MinaHelper.class);

    private MinaHelper() {
        //Utility Class
    }

    /**
     * Asynchronously writes the given body to MINA session. Will wait at most for {{ writeTimeout }} milliseconds until
     * the body has been written.
     *
     * @param  session                the MINA session
     * @param  body                   the body to write (send)
     * @param  exchange               the exchange
     * @param  writeTimeout           maximum amount of time we wait for the WriteFuture to complete (in milliseconds)
     * @throws CamelExchangeException is thrown if the body could not be written for some reasons (eg remote connection
     *                                is closed etc.)
     */
    public static void writeBody(IoSession session, Object body, Exchange exchange, long writeTimeout)
            throws CamelExchangeException {

        // if stream cached then mina needs to use byte array instead
        if (body instanceof StreamCache) {
            try {
                body = exchange.getContext().getTypeConverter().mandatoryConvertTo(byte[].class, exchange, body);
            } catch (NoTypeConversionAvailableException e) {
                throw new CamelExchangeException("Error converting body to byte[]", exchange, e);
            }
        }

        // the write operation is asynchronous. Use WriteFuture to wait until the session has been written
        WriteFuture future = session.write(body);
        // must use a timeout as in some very high performance scenarios a write can cause thread hanging forever
        LOG.trace("Waiting for write to complete for body: {} using session: {}", body, session);
        if (!future.awaitUninterruptibly(writeTimeout)) {
            String message = "Cannot write body: " + body.getClass().getCanonicalName() + " using session: " + session;
            if (future.getException() != null) {
                throw new CamelExchangeException(message, exchange, future.getException());
            } else {
                throw new CamelExchangeException(message, exchange);
            }
        }
    }
}