Class Http4FileProvider

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.http4.Http4FileProvider

All Implemented Interfaces:

Closeable, AutoCloseable, FileProvider, VfsComponent

Direct Known Subclasses:

Http4sFileProvider

public class Http4FileProvider
extends AbstractOriginatingFileProvider

FileProvider implementation using HttpComponents HttpClient library.

Since:

2.3

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final UserAuthenticationData.Type[]	AUTHENTICATOR_TYPES	Authenticator information.
(package private) static final Collection<Capability>	CAPABILITIES	FileProvider capabilities

Constructor Summary

Constructors

Constructor	Description
Http4FileProvider()	Constructs a new provider.

Method Summary

Modifier and Type	Method	Description
private org.apache.http.conn.HttpClientConnectionManager	createConnectionManager(Http4FileSystemConfigBuilder builder, FileSystemOptions fileSystemOptions, SSLContext sslContext, HostnameVerifier verifier)
private org.apache.http.client.CookieStore	createDefaultCookieStore(Http4FileSystemConfigBuilder builder, FileSystemOptions fileSystemOptions)
private org.apache.http.client.config.RequestConfig	createDefaultRequestConfig(Http4FileSystemConfigBuilder builder, FileSystemOptions fileSystemOptions)
private HostnameVerifier	createHostnameVerifier(Http4FileSystemConfigBuilder builder, FileSystemOptions fileSystemOptions)
protected org.apache.http.client.HttpClient	createHttpClient(Http4FileSystemConfigBuilder builder, GenericFileName rootName, FileSystemOptions fileSystemOptions)	Create an HttpClient object for an http4 file system.
protected org.apache.http.impl.client.HttpClientBuilder	createHttpClientBuilder(Http4FileSystemConfigBuilder builder, GenericFileName rootName, FileSystemOptions fileSystemOptions)	Create an HttpClientBuilder object.
protected org.apache.http.client.protocol.HttpClientContext	createHttpClientContext(Http4FileSystemConfigBuilder builder, GenericFileName rootName, FileSystemOptions fileSystemOptions, UserAuthenticationData authData)	Create an HttpClientContext object for an http4 file system.
private org.apache.http.conn.routing.HttpRoutePlanner	createHttpRoutePlanner(Http4FileSystemConfigBuilder builder, FileSystemOptions fileSystemOptions)
protected SSLContext	createSSLContext(Http4FileSystemConfigBuilder 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.
private org.apache.http.HttpHost	getProxyHttpHost(Http4FileSystemConfigBuilder builder, FileSystemOptions fileSystemOptions)

Methods inherited from class AbstractOriginatingFileProvider

findFile, findFile, getFileSystem

Methods inherited from class AbstractFileProvider

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

Methods inherited from class AbstractVfsContainer

addComponent, removeComponent

Methods inherited from class AbstractVfsComponent

getContext, getLogger, init, setContext, setLogger

Methods inherited from class Object

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

Field Details

AUTHENTICATOR_TYPES

static final UserAuthenticationData.Type[] AUTHENTICATOR_TYPES

Authenticator information.

CAPABILITIES

static final Collection<Capability> CAPABILITIES

FileProvider capabilities

Constructor Details

Http4FileProvider

public Http4FileProvider()

Constructs a new provider.

Method Details

createConnectionManager

private org.apache.http.conn.HttpClientConnectionManager createConnectionManager(Http4FileSystemConfigBuilder builder,
 FileSystemOptions fileSystemOptions,
 SSLContext sslContext,
 HostnameVerifier verifier)

createDefaultCookieStore

private org.apache.http.client.CookieStore createDefaultCookieStore(Http4FileSystemConfigBuilder builder,
 FileSystemOptions fileSystemOptions)

createDefaultRequestConfig

private org.apache.http.client.config.RequestConfig createDefaultRequestConfig(Http4FileSystemConfigBuilder builder,
 FileSystemOptions fileSystemOptions)

createHostnameVerifier

private HostnameVerifier createHostnameVerifier(Http4FileSystemConfigBuilder builder,
 FileSystemOptions fileSystemOptions)

createHttpClient

protected org.apache.http.client.HttpClient createHttpClient(Http4FileSystemConfigBuilder 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.http.impl.client.HttpClientBuilder createHttpClientBuilder(Http4FileSystemConfigBuilder builder,
 GenericFileName rootName,
 FileSystemOptions fileSystemOptions)
                                                                         throws FileSystemException

Create an HttpClientBuilder object. Invoked by createHttpClient(Http4FileSystemConfigBuilder, 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.http.client.protocol.HttpClientContext createHttpClientContext(Http4FileSystemConfigBuilder 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

createHttpRoutePlanner

private org.apache.http.conn.routing.HttpRoutePlanner createHttpRoutePlanner(Http4FileSystemConfigBuilder builder,
 FileSystemOptions fileSystemOptions)

createSSLContext

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

Create SSLContext for HttpClient. Invoked by createHttpClientBuilder(Http4FileSystemConfigBuilder, 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.

getProxyHttpHost

private org.apache.http.HttpHost getProxyHttpHost(Http4FileSystemConfigBuilder builder,
 FileSystemOptions fileSystemOptions)