Package org.apache.commons.vfs2.provider.http4

Class Http4FileSystem

java.lang.Object

org.apache.commons.vfs2.provider.AbstractVfsComponent

org.apache.commons.vfs2.provider.AbstractFileSystem

org.apache.commons.vfs2.provider.http4.Http4FileSystem

All Implemented Interfaces:

Closeable, AutoCloseable, FileSystem, VfsComponent

public class Http4FileSystem
extends AbstractFileSystem

http4 file system.

Since:

2.3

Field Summary

Fields

Modifier and Type	Field	Description
private final org.apache.http.client.HttpClient	httpClient	Internal HttpClient instance of this file system.
private final org.apache.http.client.protocol.HttpClientContext	httpClientContext	Internal HttpClientContext instance of this file system.
private final URI	internalBaseURI	Internal base URI of this file system.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Http4FileSystem(FileName rootName, FileSystemOptions fileSystemOptions, org.apache.http.client.HttpClient httpClient, org.apache.http.client.protocol.HttpClientContext httpClientContext)	Construct Http4FileSystem.

Method Summary

Modifier and Type	Method	Description
protected void	addCapabilities(Collection<Capability> caps)	Adds the capabilities of this file system.
protected FileObject	createFile(AbstractFileName name)	Creates a file object.
protected void	doCloseCommunicationLink()	Closes the underlying link used to access the files.
protected org.apache.http.client.HttpClient	getHttpClient()	Return the internal HttpClient instance.
protected org.apache.http.client.protocol.HttpClientContext	getHttpClientContext()	Return the internal HttpClientContext instance.
protected URI	getInternalBaseURI()	Return the internal base URI instance.

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

addJunction, addListener, close, closeCommunicationLink, decorateFileObject, doReplicateFile, fireFileChanged, fireFileCreated, fireFileDeleted, getAttribute, getFileFromCache, getFileSystemManager, getFileSystemOptions, getLastModTimeAccuracy, getParentLayer, getRoot, getRootName, getRootURI, hasCapability, init, isOpen, isReleaseable, notifyAllStreamsClosed, putFileToCache, removeFileFromCache, removeJunction, removeListener, replicateFile, resolveFile, resolveFile, setAttribute

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

getContext, getLogger, setContext, setLogger

Methods inherited from class java.lang.Object

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

Field Details

internalBaseURI

private final URI internalBaseURI

Internal base URI of this file system.

httpClient

private final org.apache.http.client.HttpClient httpClient

Internal HttpClient instance of this file system.

httpClientContext

private final org.apache.http.client.protocol.HttpClientContext httpClientContext

Internal HttpClientContext instance of this file system.

Constructor Details

Http4FileSystem

protected Http4FileSystem(FileName rootName,
 FileSystemOptions fileSystemOptions,
 org.apache.http.client.HttpClient httpClient,
 org.apache.http.client.protocol.HttpClientContext httpClientContext)

Construct Http4FileSystem.

Parameters:

rootName - root base name

fileSystemOptions - file system options

httpClient - HttpClient instance

httpClientContext - HttpClientContext instance

Method Details

addCapabilities

protected void addCapabilities(Collection<Capability> caps)

Description copied from class: AbstractFileSystem

Adds the capabilities of this file system.

Specified by:

addCapabilities in class AbstractFileSystem

Parameters:

caps - collections of Capabilities, can be immutable.

createFile

protected FileObject createFile(AbstractFileName name)
                         throws Exception

Description copied from class: AbstractFileSystem

Creates a file object.

This method is called only if the requested file is not cached.

Specified by:

createFile in class AbstractFileSystem

Parameters:

name - name referencing the new file.

Returns:

new created FileObject.

Throws:

Exception - might throw an Exception, which is then wrapped in FileSystemException.

doCloseCommunicationLink

protected void doCloseCommunicationLink()

Description copied from class: AbstractFileSystem

Closes the underlying link used to access the files.

Overrides:

doCloseCommunicationLink in class AbstractFileSystem

getHttpClient

protected org.apache.http.client.HttpClient getHttpClient()

Return the internal HttpClient instance.

Returns:

the internal HttpClient instance

getHttpClientContext

protected org.apache.http.client.protocol.HttpClientContext getHttpClientContext()

Return the internal HttpClientContext instance.

Returns:

the internal HttpClientContext instance

getInternalBaseURI

protected URI getInternalBaseURI()

Return the internal base URI instance.

Returns:

the internal base URI instance