org.refcodes.io.impls.BidirectionalStreamConnectionTransceiverImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of refcodes-io Show documentation
Artifact with commonly used I/O functionality and for connection related issues such as receiving or transmitting data in a unified way.
There is a newer version: 3.3.9
Show newest version
// /////////////////////////////////////////////////////////////////////////////
// REFCODES.ORG
// =============================================================================
// This code is copyright (c) by Siegfried Steiner, Munich, Germany and licensed
// under the following (see "http://en.wikipedia.org/wiki/Multi-licensing")
// licenses:
// =============================================================================
// GNU General Public License, v3.0 ("http://www.gnu.org/licenses/gpl-3.0.html")
// together with the GPL linking exception applied; as being applied by the GNU
// Classpath ("http://www.gnu.org/software/classpath/license.html")
// =============================================================================
// Apache License, v2.0 ("http://www.apache.org/licenses/LICENSE-2.0")
// =============================================================================
// Please contact the copyright holding author(s) of the software artifacts in
// question for licensing issues not being covered by the above listed licenses,
// also regarding commercial licensing models or regarding the compatibility
// with other open source licenses.
// /////////////////////////////////////////////////////////////////////////////

package org.refcodes.io.impls;

import java.io.BufferedOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.ObjectOutputStream;
import java.io.OutputStream;
import java.io.PipedInputStream;
import java.io.PipedOutputStream;
import java.io.Serializable;

import org.refcodes.component.CloseException;
import org.refcodes.component.OpenException;
import org.refcodes.exception.ExceptionUtility;
import org.refcodes.io.BidirectionalStreamConnectionTransceiver;

/**
 * @author steiner
 */
public class BidirectionalStreamConnectionTransceiverImpl extends AbstractInputStreamReceiver implements BidirectionalStreamConnectionTransceiver {

	// /////////////////////////////////////////////////////////////////////////
	// CONSTANTS:
	// /////////////////////////////////////////////////////////////////////////

	// /////////////////////////////////////////////////////////////////////////
	// VARIABLES:
	// /////////////////////////////////////////////////////////////////////////

	private ObjectOutputStream _objectOutputStream = null;

	// /////////////////////////////////////////////////////////////////////////
	// CONSTRUCTORS:
	// /////////////////////////////////////////////////////////////////////////

	public BidirectionalStreamConnectionTransceiverImpl() {
		super();
	}

	// /////////////////////////////////////////////////////////////////////////
	// METHODS:
	// /////////////////////////////////////////////////////////////////////////

	@Override
	public boolean isOpenable( InputStream aInputStream, OutputStream aOutputStream ) {
		if ( aOutputStream == null ) {
			return false;
		}
		return isOpenable( aInputStream );
	}

	/**
	 * {@inheritDoc}
	 * -------------------------------------------------------------------------
	 * HINT: For testing purposes you can pass an already flushed
	 * {@link ObjectOutputStream} (via {@link ObjectOutputStream#flush()})
	 * encapsulating a {@link PipedOutputStream} which in turn encapsulates a
	 * {@link PipedInputStream} to this {@link #open(OutputStream)} method. This
	 * enables you a non-blocking test of the
	 * {@link BidirectionalStreamConnectionTransceiverImpl} connected with the
	 * {@link BidirectionalStreamConnectionTransceiverImpl} counterpart which is being
	 * opened with the {@link PipedInputStream}.
	 * -------------------------------------------------------------------------
	 */
	@Override
	public void open( InputStream aInputStream, OutputStream aOutputStream ) throws OpenException {
		open( aOutputStream );
		open( aInputStream );
	}

	/**
	 * {@inheritDoc}
	 * -------------------------------------------------------------------------
	 * ATTENTION: For maintainers, please keep the below code in sync with the
	 * code from {@link OutputStreamConnectionSenderImpl#writeDatagram(Serializable)}.
	 */
	@Override
	public void writeDatagram( DATA aDatagram ) throws OpenException {
		if ( !isOpened() ) {
			throw new OpenException( "Unable to write datagram <" + aDatagram.getClass().getName() + "> as the connection is NOT OPEN; connection status is " + getConnectionStatus() + "." );
		}
		synchronized ( _objectOutputStream ) {
			try {
				_objectOutputStream.writeObject( aDatagram );
				_objectOutputStream.flush();
			}
			catch ( IOException aException ) {
				if ( isClosed() ) {
					return;
				}
				else {
					try {
						close();
					}
					catch ( CloseException e ) {
						throw new OpenException( "Unable to close malfunctioning stream.", e );
					}
				}
				throw new OpenException( aException );
			}
		}
	}

	@Override
	public void flush() throws OpenException {
		try {
			_objectOutputStream.flush();
		}
		catch ( IOException e ) {
			throw new OpenException( "Unable to flush transceiver's output stream <" + _objectOutputStream + ">.", e );
		}
	}

	@Override
	public synchronized void close() throws CloseException {
		super.close();
		try {
			_objectOutputStream.close();
		}
		catch ( IOException aException ) {
			if ( !ExceptionUtility.isThrownAsOfAlreadyClosed( aException ) ) throw new CloseException( "Unable to close stream <" + _objectOutputStream + ">.", aException );
		}
	}

	// /////////////////////////////////////////////////////////////////////////
	// HOOKS:
	// /////////////////////////////////////////////////////////////////////////

	/**
	 * {@inheritDoc}
	 * -------------------------------------------------------------------------
	 * HINT: For testing purposes you can pass an already flushed
	 * {@link ObjectOutputStream} (via {@link ObjectOutputStream#flush()})
	 * encapsulating a {@link PipedOutputStream} which in turn encapsulates a
	 * {@link PipedInputStream} to this {@link #open(OutputStream)} method. This
	 * enables you a non-blocking test of the {@link OutputStreamConnectionSenderImpl}
	 * connected with the {@link InputStreamConnectionReceiverImpl} counterpart which is
	 * being opened with the {@link PipedInputStream}.
	 * -------------------------------------------------------------------------
	 * ATTENTION: For maintainers, please keep the below code in sync with the
	 * code from {@link OutputStreamConnectionSenderImpl#open(java.io.OutputStream)};
	 * except do not set the connection status here, make it protected and do
	 * not @Override anything.
	 */
	protected synchronized void open( OutputStream aOutputStream ) throws OpenException {
		if ( isOpened() ) {
			throw new OpenException( "Unable to open the connection is is is ALREADY OPEN; connection status is " + getConnectionStatus() + "." );
		}
		try {
			if ( aOutputStream instanceof ObjectOutputStream ) {
				// -------------------------------------------------------------
				// Hack to enable single threaded pipe streams:
				// -------------------------------------------------------------
				_objectOutputStream = (ObjectOutputStream) aOutputStream;
			}
			else {
				if ( !(aOutputStream instanceof BufferedOutputStream) ) {
					_objectOutputStream = new ObjectOutputStream( new BufferedOutputStream( aOutputStream ) );
				}
				else {
					_objectOutputStream = new ObjectOutputStream( aOutputStream );
				}
			}
			_objectOutputStream.flush();
		}
		catch ( IOException aException ) {
			throw new OpenException( "Unable to open the I/O stream receiver as of a causing exception.", aException );
		}
		// setConnectionStatus( ConnectionStatus.OPENED );
	}

	// /////////////////////////////////////////////////////////////////////////
	// HELPER:
	// /////////////////////////////////////////////////////////////////////////
}