Package org.eclipse.jetty.client.util

Class PathContentProvider

java.lang.Object

org.eclipse.jetty.client.util.AbstractTypedContentProvider

org.eclipse.jetty.client.util.PathContentProvider

All Implemented Interfaces:

java.lang.Iterable<java.nio.ByteBuffer>, ContentProvider, ContentProvider.Typed

public class PathContentProvider
extends AbstractTypedContentProvider

A ContentProvider for files using JDK 7's java.nio.file APIs.

It is possible to specify, at the constructor, a buffer size used to read content from the stream, by default 4096 bytes. If a ByteBufferPool is provided via setByteBufferPool(ByteBufferPool), the buffer will be allocated from that pool, otherwise one buffer will be allocated and used to read the file.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.client.api.ContentProvider

ContentProvider.Typed

Constructor Summary

Constructors

Constructor	Description
PathContentProvider(java.lang.String contentType, java.nio.file.Path filePath)
PathContentProvider(java.lang.String contentType, java.nio.file.Path filePath, int bufferSize)
PathContentProvider(java.nio.file.Path filePath)
PathContentProvider(java.nio.file.Path filePath, int bufferSize)

Method Summary

Modifier and Type	Method	Description
ByteBufferPool	getByteBufferPool()
long	getLength()
boolean	isReproducible()	Whether this ContentProvider can produce exactly the same content more than once.
java.util.Iterator<java.nio.ByteBuffer>	iterator()
void	setByteBufferPool(ByteBufferPool byteBufferPool)

Methods inherited from class org.eclipse.jetty.client.util.AbstractTypedContentProvider

getContentType

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

PathContentProvider

public PathContentProvider(java.nio.file.Path filePath)
                    throws java.io.IOException

Throws:

java.io.IOException

PathContentProvider

public PathContentProvider(java.nio.file.Path filePath,
                           int bufferSize)
                    throws java.io.IOException

Throws:

java.io.IOException

PathContentProvider

public PathContentProvider(java.lang.String contentType,
                           java.nio.file.Path filePath)
                    throws java.io.IOException

Throws:

java.io.IOException

PathContentProvider

public PathContentProvider(java.lang.String contentType,
                           java.nio.file.Path filePath,
                           int bufferSize)
                    throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getLength

public long getLength()

Returns:

the content length, if known, or -1 if the content length is unknown

isReproducible

public boolean isReproducible()

Description copied from interface: ContentProvider

Whether this ContentProvider can produce exactly the same content more than once.

Implementations should return true only if the content can be produced more than once, which means that invocations to Iterable.iterator() must return a new, independent, iterator instance over the content.

The HttpClient implementation may use this method in particular cases where it detects that it is safe to retry a request that failed.

Returns:

whether the content can be produced more than once

getByteBufferPool

public ByteBufferPool getByteBufferPool()

setByteBufferPool

public void setByteBufferPool(ByteBufferPool byteBufferPool)

iterator

public java.util.Iterator<java.nio.ByteBuffer> iterator()