org.apache.commons.vfs2.provider.http5

Class Http5FileProvider

java.lang.Object

org.apache.commons.vfs2.provider.AbstractVfsComponent

org.apache.commons.vfs2.provider.AbstractVfsContainer

org.apache.commons.vfs2.provider.AbstractFileProvider

org.apache.commons.vfs2.provider.AbstractOriginatingFileProvider

org.apache.commons.vfs2.provider.http5.Http5FileProvider

All Implemented Interfaces:

Closeable, AutoCloseable, FileProvider, VfsComponent

Direct Known Subclasses:

Http5sFileProvider

public class Http5FileProvider
extends AbstractOriginatingFileProvider

FileProvider implementation using HttpComponents HttpClient v5 library.

Since:

2.5.0

Constructor Summary

Constructors

Constructor and Description
Http5FileProvider() Constructs a new provider.

Method Summary

Modifier and Type	Method and Description
protected org.apache.hc.client5.http.classic.HttpClient	createHttpClient(Http5FileSystemConfigBuilder builder, GenericFileName rootName, FileSystemOptions fileSystemOptions) Create an HttpClient object for an http4 file system.
protected org.apache.hc.client5.http.impl.classic.HttpClientBuilder	createHttpClientBuilder(Http5FileSystemConfigBuilder builder, GenericFileName rootName, FileSystemOptions fileSystemOptions) Create an HttpClientBuilder object.
protected org.apache.hc.client5.http.protocol.HttpClientContext	createHttpClientContext(Http5FileSystemConfigBuilder builder, GenericFileName rootName, FileSystemOptions fileSystemOptions, UserAuthenticationData authData) Create an HttpClientContext object for an http4 file system.
protected SSLContext	createSSLContext(Http5FileSystemConfigBuilder builder, FileSystemOptions fileSystemOptions) Create SSLContext for HttpClient.
protected FileSystem	doCreateFileSystem(FileName name, FileSystemOptions fileSystemOptions) Creates a FileSystem.
Collection<Capability>	getCapabilities() Gets the file system capabilities.
FileSystemConfigBuilder	getConfigBuilder() Returns the FileSystemConfigBuidler.

Methods inherited from class org.apache.commons.vfs2.provider.AbstractOriginatingFileProvider

findFile, findFile, getFileSystem

Methods inherited from class org.apache.commons.vfs2.provider.AbstractFileProvider

addFileSystem, close, closeFileSystem, createFileSystem, findFileSystem, freeUnusedResources, getFileNameParser, parseUri, setFileNameParser

Methods inherited from class org.apache.commons.vfs2.provider.AbstractVfsContainer

addComponent, removeComponent

Methods inherited from class org.apache.commons.vfs2.provider.AbstractVfsComponent

getContext, getLogger, init, setContext, setLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

Http5FileProvider

public Http5FileProvider()

Constructs a new provider.

Method Detail

createHttpClient

protected org.apache.hc.client5.http.classic.HttpClient createHttpClient(Http5FileSystemConfigBuilder builder,
                                                                         GenericFileName rootName,
                                                                         FileSystemOptions fileSystemOptions)
                                                                  throws FileSystemException

Create an HttpClient object for an http4 file system.

Parameters:

builder - Configuration options builder for http4 provider

rootName - The root path

fileSystemOptions - The file system options

Returns:

an HttpClient object

Throws:

FileSystemException - if an error occurs.

createHttpClientBuilder

protected org.apache.hc.client5.http.impl.classic.HttpClientBuilder createHttpClientBuilder(Http5FileSystemConfigBuilder builder,
                                                                                            GenericFileName rootName,
                                                                                            FileSystemOptions fileSystemOptions)
                                                                                     throws FileSystemException

Create an HttpClientBuilder object. Invoked by createHttpClient(Http5FileSystemConfigBuilder, GenericFileName, FileSystemOptions).

Parameters:

builder - Configuration options builder for HTTP4 provider

rootName - The root path

fileSystemOptions - The FileSystem options

Returns:

an HttpClientBuilder object

Throws:

FileSystemException - if an error occurs

createHttpClientContext

protected org.apache.hc.client5.http.protocol.HttpClientContext createHttpClientContext(Http5FileSystemConfigBuilder builder,
                                                                                        GenericFileName rootName,
                                                                                        FileSystemOptions fileSystemOptions,
                                                                                        UserAuthenticationData authData)

Create an HttpClientContext object for an http4 file system.

Parameters:

builder - Configuration options builder for http4 provider

rootName - The root path

fileSystemOptions - The FileSystem options

authData - The UserAuthentiationData object

Returns:

an HttpClientContext object

createSSLContext

protected SSLContext createSSLContext(Http5FileSystemConfigBuilder builder,
                                      FileSystemOptions fileSystemOptions)
                               throws FileSystemException

Create SSLContext for HttpClient. Invoked by createHttpClientBuilder(Http5FileSystemConfigBuilder, GenericFileName, FileSystemOptions).

Parameters:

builder - Configuration options builder for HTTP4 provider

fileSystemOptions - The FileSystem options

Returns:

a SSLContext for HttpClient

Throws:

FileSystemException - if an error occurs

doCreateFileSystem

protected FileSystem doCreateFileSystem(FileName name,
                                        FileSystemOptions fileSystemOptions)
                                 throws FileSystemException

Description copied from class: AbstractOriginatingFileProvider

Creates a FileSystem. If the returned FileSystem implements VfsComponent, it will be initialized.

Specified by:

doCreateFileSystem in class AbstractOriginatingFileProvider

Parameters:

name - The name of the root file of the file system to create.

fileSystemOptions - The FileSystem options.

Returns:

The FileSystem.

Throws:

FileSystemException - if an error occurs.

getCapabilities

public Collection<Capability> getCapabilities()

Description copied from interface: FileProvider

Gets the file system capabilities.

These are the same as on the file system, but available before the first file system was instanciated.

Returns:

a Collection of the file systems Capabilities.

getConfigBuilder

public FileSystemConfigBuilder getConfigBuilder()

Description copied from class: AbstractFileProvider

Returns the FileSystemConfigBuidler.

Specified by:

getConfigBuilder in interface FileProvider

Overrides:

getConfigBuilder in class AbstractFileProvider

Returns:

the FileSystemConfigBuilder.