RMIInputStreamWrapper

public class RMIInputStreamWrapper implements RMIWrapper

saker.util.rmi.wrap.RMIInputStreamWrapper

java.lang.Object

saker.rmi.io.wrap.RMIWrapper

RMIWrapper implementation that transfers an InputStream by writing a ByteSource as a remote object instead, and converts it back to an InputStream during reading.

The input stream will be wrapped into a ByteSource, and that will be written as a remote object to the other endpoint.
The remote ByteSource will be read, and converted back to an InputStream.

Writing the resulting InputStream back to the original endpoint will not return the original InputStream instance to it, but a stream that is forwarded through the remote endpoint. This will probably heavily degrade the performance, so if this scenario is possible to happen, users should choose a different transferring mechanism.

ByteSource.valueOf(InputStream)

ByteSource.toInputStream(ByteSource)

Constructors

public	RMIInputStreamWrapper() Creates a new instance.
public	RMIInputStreamWrapper(InputStream is) Creates a new instance for the given input stream.

Methods

public Object	getWrappedObject() Gets the wrapped object which should be serialized during RMI transfer.
public void	readWrapped(RMIObjectInput in) Reads the wrapped object from the RMI object input stream.
public Object	resolveWrapped() Resolves the wrapped object during deserialization.
public void	writeWrapped(RMIObjectOutput out) Writes the wrapped object to the RMI object output stream.

Inherited methods
From: Object clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

public RMIInputStreamWrapper()

Creates a new instance.

Users shouldn't instantiate this class manually, but leave that to the RMI runtime.

public RMIInputStreamWrapper(InputStream is) throws NullPointerException

Creates a new instance for the given input stream.

Users shouldn't instantiate this class manually, but leave that to the RMI runtime.

isThe input stream.

NullPointerExceptionIf the stream is null.

public Object getWrappedObject()

Overridden from: RMIWrapper

Gets the wrapped object which should be serialized during RMI transfer.

If RMIWrapper.resolveWrapped() returned this then this method will be called when the wrapper instance is serialized to an other endpoint. It is preferred to return a remote proxy to the previously wrapped object to pass back to the original endpoint when reverse request is made. Returning this from this method will result in the serialization of this wrapper through RMI.

If RMIWrapper.resolveWrapped() did not return this then this method can freely return null or throw exceptions (e.g. UnsupportedOperationException) because it will never be called.

The object to serialize instead of this.

public void readWrapped(RMIObjectInput in) throws IOException, ClassNotFoundException

Overridden from: RMIWrapper

Reads the wrapped object from the RMI object input stream.

inThe input stream to read from.

IOExceptionIn case of I/O error.

ClassNotFoundExceptionIf a class for a serialized object cannot be found.

public Object resolveWrapped()

Overridden from: RMIWrapper

Resolves the wrapped object during deserialization.

The result of this method will be returned to the caller, or used during the RMI request.

The result of the object transfer.

public void writeWrapped(RMIObjectOutput out) throws IOException

Overridden from: RMIWrapper

Writes the wrapped object to the RMI object output stream.

Important aspect of writing objects using wrappers is that in this method if any of the object writing method is called, then the non customizable aspects of the serializable will not be applied to the object that is being wrapped.

E.g. If an RMIWrapper is defined for an object type T, then calling RMIObjectOutput.writeRemoteObject(Object) will not cause the subject object with the type T to be written using an RMIWrapper again, but it will be actually written as a remote object.

outThe output stream to write to.

IOExceptionIn case of I/O error.