Package org.apache.hc.core5.http.nio.entity

Class PathEntityProducer

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private static int BUFFER_SIZE  
      private java.nio.ByteBuffer byteBuffer  
      private java.util.concurrent.atomic.AtomicReference<java.nio.channels.SeekableByteChannel> channelRef  
      private boolean chunked  
      private ContentType contentType  
      private boolean eof  
      private java.util.concurrent.atomic.AtomicReference<java.lang.Exception> exception  
      private java.nio.file.Path file  
      private long length  
      private java.nio.file.OpenOption[] openOptions  

    • Constructor Summary

      Constructors 
      Constructor Description
      PathEntityProducer​(java.nio.file.Path file, int bufferSize, ContentType contentType, boolean chunked, java.nio.file.OpenOption... openOptions)  
      PathEntityProducer​(java.nio.file.Path file, java.nio.file.OpenOption... openOptions)  
      PathEntityProducer​(java.nio.file.Path file, ContentType contentType, boolean chunked, java.nio.file.OpenOption... openOptions)  
      PathEntityProducer​(java.nio.file.Path file, ContentType contentType, java.nio.file.OpenOption... openOptions)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int available()
      Returns the number of bytes immediately available for output.
      void failed​(java.lang.Exception cause)
      Triggered to signal a failure in data generation.
      java.lang.String getContentEncoding()
      Returns content encoding of the entity, if known.
      long getContentLength()
      Returns length of the entity, if known.
      java.lang.String getContentType()
      Returns content type of the entity, if known.
      java.lang.Exception getException()  
      java.util.Set<java.lang.String> getTrailerNames()
      Preliminary declaration of trailing headers.
      boolean isChunked()
      Returns chunked transfer hint for this entity.
      boolean isRepeatable()
      Determines whether the producer can consistently produce the same content after invocation of ResourceHolder.releaseResources().
      void produce​(DataStreamChannel dataStreamChannel)
      Triggered to signal the ability of the underlying data channel to accept more data.
      void releaseResources()  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • file

        private final java.nio.file.Path file

      • openOptions

        private final java.nio.file.OpenOption[] openOptions

      • byteBuffer

        private final java.nio.ByteBuffer byteBuffer

      • length

        private final long length

      • chunked

        private final boolean chunked

      • exception

        private final java.util.concurrent.atomic.AtomicReference<java.lang.Exception> exception

      • channelRef

        private final java.util.concurrent.atomic.AtomicReference<java.nio.channels.SeekableByteChannel> channelRef

      • eof

        private boolean eof

    • Constructor Detail

      • PathEntityProducer

        public PathEntityProducer​(java.nio.file.Path file,
                          ContentType contentType,
                          boolean chunked,
                          java.nio.file.OpenOption... openOptions)
                   throws java.io.IOException
        Throws:
        java.io.IOException

      • PathEntityProducer

        public PathEntityProducer​(java.nio.file.Path file,
                          ContentType contentType,
                          java.nio.file.OpenOption... openOptions)
                   throws java.io.IOException
        Throws:
        java.io.IOException

      • PathEntityProducer

        public PathEntityProducer​(java.nio.file.Path file,
                          int bufferSize,
                          ContentType contentType,
                          boolean chunked,
                          java.nio.file.OpenOption... openOptions)
                   throws java.io.IOException
        Throws:
        java.io.IOException

      • PathEntityProducer

        public PathEntityProducer​(java.nio.file.Path file,
                          java.nio.file.OpenOption... openOptions)
                   throws java.io.IOException
        Throws:
        java.io.IOException

    • Method Detail

      • available

        public int available()
        Description copied from interface: AsyncDataProducer
        Returns the number of bytes immediately available for output. This method can be used as a hint to control output events of the underlying I/O session.
        Specified by:
        available in interface AsyncDataProducer
        Returns:
        the number of bytes immediately available for output

      • failed

        public void failed​(java.lang.Exception cause)
        Description copied from interface: AsyncEntityProducer
        Triggered to signal a failure in data generation.
        Specified by:
        failed in interface AsyncEntityProducer
        Parameters:
        cause - the cause of the failure.

      • getContentEncoding

        public java.lang.String getContentEncoding()
        Description copied from interface: EntityDetails
        Returns content encoding of the entity, if known.
        Specified by:
        getContentEncoding in interface EntityDetails

      • getContentType

        public java.lang.String getContentType()
        Description copied from interface: EntityDetails
        Returns content type of the entity, if known.
        Specified by:
        getContentType in interface EntityDetails

      • getException

        public java.lang.Exception getException()

      • getTrailerNames

        public java.util.Set<java.lang.String> getTrailerNames()
        Description copied from interface: EntityDetails
        Preliminary declaration of trailing headers.
        Specified by:
        getTrailerNames in interface EntityDetails

      • isChunked

        public boolean isChunked()
        Description copied from interface: EntityDetails
        Returns chunked transfer hint for this entity.

        The behavior of wrapping entities is implementation dependent, but should respect the primary purpose.

        Specified by:
        isChunked in interface EntityDetails

      • produce

        public void produce​(DataStreamChannel dataStreamChannel)
             throws java.io.IOException
        Description copied from interface: AsyncDataProducer
        Triggered to signal the ability of the underlying data channel to accept more data. The data producer can choose to write data immediately inside the call or asynchronously at some later point.
        Specified by:
        produce in interface AsyncDataProducer
        Parameters:
        dataStreamChannel - the data channel capable to accepting more data.
        Throws:
        java.io.IOException