org.springframework.integration.ip.tcp.serializer.ByteArrayCrLfSerializer.java Source code

Introduction

Here is the source code for org.springframework.integration.ip.tcp.serializer.ByteArrayCrLfSerializer.java

Source

/*
 * Copyright 2002-2019 the original author or authors.
 *
 * Licensed 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
 *
 *      https://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.springframework.integration.ip.tcp.serializer;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

/**
 * Reads data in an InputStream to a byte[]; data must be terminated by \r\n
 * (not included in resulting byte[]).
 * Writes a byte[] to an OutputStream and adds \r\n.
 *
 * @author Gary Russell
 * @since 2.0
 */
public class ByteArrayCrLfSerializer extends AbstractPooledBufferByteArraySerializer {

    /**
     * A single reusable instance.
     */
    public static final ByteArrayCrLfSerializer INSTANCE = new ByteArrayCrLfSerializer();

    private static final byte[] CRLF = "\r\n".getBytes();

    /**
     * Reads the data in the inputStream to a byte[]. Data must be terminated
     * by CRLF (\r\n). Throws a {@link SoftEndOfStreamException} if the stream
     * is closed immediately after the \r\n (i.e. no data is in the process of
     * being read).
     */
    @Override
    public byte[] doDeserialize(InputStream inputStream, byte[] buffer) throws IOException {
        int n = this.fillToCrLf(inputStream, buffer);
        return this.copyToSizedArray(buffer, n);
    }

    public int fillToCrLf(InputStream inputStream, byte[] buffer) throws IOException {
        int n = 0;
        int bite;
        if (logger.isDebugEnabled()) {
            logger.debug("Available to read: " + inputStream.available());
        }
        try {
            while (true) {
                bite = inputStream.read();
                if (bite < 0 && n == 0) {
                    throw new SoftEndOfStreamException("Stream closed between payloads");
                }
                checkClosure(bite);
                if (n > 0 && bite == '\n' && buffer[n - 1] == '\r') {
                    break;
                }
                buffer[n++] = (byte) bite;
                if (n >= getMaxMessageSize()) {
                    throw new IOException("CRLF not found before max message length: " + getMaxMessageSize());
                }
            }
            return n - 1; // trim \r
        } catch (SoftEndOfStreamException e) { // NOSONAR catch and throw
            throw e; // it's an IO exception and we don't want an event for this
        } catch (IOException e) {
            publishEvent(e, buffer, n);
            throw e;
        } catch (RuntimeException e) {
            publishEvent(e, buffer, n);
            throw e;
        }
    }

    /**
     * Writes the byte[] to the stream and appends \r\n.
     */
    @Override
    public void serialize(byte[] bytes, OutputStream outputStream) throws IOException {
        outputStream.write(bytes);
        outputStream.write(CRLF);
    }

}