Package org.apache.hc.core5.http.io

Class EofSensorInputStream

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable
    public class EofSensorInputStream
extends java.io.InputStream
    A stream wrapper that triggers actions on close() and EOF. Primarily used to auto-release an underlying managed connection when the response body is consumed or no longer needed.
    Since:
    4.0
    See Also:
    EofSensorWatcher

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private EofSensorWatcher eofWatcher
      The watcher to be notified, if any.
      private boolean selfClosed
      Indicates whether this stream itself is closed.
      private java.io.InputStream wrappedStream
      The wrapped input stream, while accessible.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void abort()
      Aborts this stream.
      int available()  
      private void checkAbort()
      Detects stream abort and notifies the watcher.
      private void checkClose()
      Detects stream close and notifies the watcher.
      private void checkEOF​(int eof)
      Detects EOF and notifies the watcher.
      void close()  
      (package private) java.io.InputStream getWrappedStream()  
      private boolean isReadAllowed()
      Checks whether the underlying stream can be read from.
      (package private) boolean isSelfClosed()  
      int read()  
      int read​(byte[] b)  
      int read​(byte[] b, int off, int len)  

      • Methods inherited from class java.io.InputStream

        mark, markSupported, reset, skip

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • wrappedStream

        private java.io.InputStream wrappedStream
        The wrapped input stream, while accessible. The value changes to null when the wrapped stream becomes inaccessible.

      • selfClosed

        private boolean selfClosed
        Indicates whether this stream itself is closed. If it isn't, but wrappedStream is null, we're running in EOF mode. All read operations will indicate EOF without accessing the underlying stream. After closing this stream, read operations will trigger an IOException.
        See Also:
        isReadAllowed

      • eofWatcher

        private final EofSensorWatcher eofWatcher
        The watcher to be notified, if any.

    • Constructor Detail

      • EofSensorInputStream

        public EofSensorInputStream​(java.io.InputStream in,
                            EofSensorWatcher watcher)
        Creates a new EOF sensor. If no watcher is passed, the underlying stream will simply be closed when EOF is detected or close is called. Otherwise, the watcher decides whether the underlying stream should be closed before detaching from it.
        Parameters:
        in - the wrapped stream
        watcher - the watcher for events, or null for auto-close behavior without notification

    • Method Detail

      • isSelfClosed

        boolean isSelfClosed()

      • getWrappedStream

        java.io.InputStream getWrappedStream()

      • isReadAllowed

        private boolean isReadAllowed()
                       throws java.io.IOException
        Checks whether the underlying stream can be read from.
        Returns:
        true if the underlying stream is accessible, false if this stream is in EOF mode and detached from the underlying stream
        Throws:
        java.io.IOException - if this stream is already closed

      • read

        public int read()
         throws java.io.IOException
        Specified by:
        read in class java.io.InputStream
        Throws:
        java.io.IOException

      • read

        public int read​(byte[] b,
                int off,
                int len)
         throws java.io.IOException
        Overrides:
        read in class java.io.InputStream
        Throws:
        java.io.IOException

      • read

        public int read​(byte[] b)
         throws java.io.IOException
        Overrides:
        read in class java.io.InputStream
        Throws:
        java.io.IOException

      • available

        public int available()
              throws java.io.IOException
        Overrides:
        available in class java.io.InputStream
        Throws:
        java.io.IOException

      • close

        public void close()
           throws java.io.IOException
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Overrides:
        close in class java.io.InputStream
        Throws:
        java.io.IOException

      • checkEOF

        private void checkEOF​(int eof)
               throws java.io.IOException
        Detects EOF and notifies the watcher. This method should only be called while the underlying stream is still accessible. Use isReadAllowed to check that condition.

        If EOF is detected, the watcher will be notified and this stream is detached from the underlying stream. This prevents multiple notifications from this stream.

        Parameters:
        eof - the result of the calling read operation. A negative value indicates that EOF is reached.
        Throws:
        java.io.IOException - in case of an IO problem on closing the underlying stream

      • checkClose

        private void checkClose()
                 throws java.io.IOException
        Detects stream close and notifies the watcher. There's not much to detect since this is called by close. The watcher will only be notified if this stream is closed for the first time and before EOF has been detected. This stream will be detached from the underlying stream to prevent multiple notifications to the watcher.
        Throws:
        java.io.IOException - in case of an IO problem on closing the underlying stream

      • checkAbort

        private void checkAbort()
                 throws java.io.IOException
        Detects stream abort and notifies the watcher. There's not much to detect since this is called by abort(). The watcher will only be notified if this stream is aborted for the first time and before EOF has been detected or the stream has been closed gracefully. This stream will be detached from the underlying stream to prevent multiple notifications to the watcher.
        Throws:
        java.io.IOException - in case of an IO problem on closing the underlying stream

      • abort

        public void abort()
           throws java.io.IOException
        Aborts this stream. This is a special version of close() which prevents re-use of the underlying connection, if any. Calling this method indicates that there should be no attempt to read until the end of the stream.
        Throws:
        java.io.IOException - in case of an IO problem on closing the underlying stream