net.java.truevfs.driver.http

Class HttpDriver

java.lang.Object

net.java.truecommons.shed.UniqueObject

net.java.truevfs.kernel.spec.FsDriver

net.java.truevfs.driver.http.HttpDriver

All Implemented Interfaces:

FsController.Factory<FsManager>, FsModel.Factory<FsManager>

@Immutable
public class HttpDriver
extends FsDriver

A file system driver for the HTTP(S) schemes.

Subclasses must be thread-safe and should be immutable!

Author:

Christian Schlichtherle

See Also:

newClient()

Constructor Summary

Constructors

Constructor and Description
HttpDriver()

Method Summary

Modifier and Type	Method and Description
protected org.apache.http.HttpResponse	executeGet(HttpNode entry) Executes the GET request method for the given URI.
protected org.apache.http.HttpResponse	executeHead(HttpNode entry) Executes the HEAD request method for the given URI.
protected org.apache.http.client.HttpClient	getClient() Returns the cached http client obtained by calling newClient().
protected org.apache.http.client.HttpClient	newClient() Returns a new http client.
FsController	newController(FsManager manager, FsModel model, FsController parent) Returns a new file system controller for the mount point of the given file system model.

Methods inherited from class net.java.truevfs.kernel.spec.FsDriver

decorate, isArchiveDriver, newModel, toString

Methods inherited from class net.java.truecommons.shed.UniqueObject

equals, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HttpDriver

public HttpDriver()

Method Detail

executeGet

protected org.apache.http.HttpResponse executeGet(HttpNode entry)
                                           throws IOException

Executes the GET request method for the given URI. Equivalent to getClient().execute(entry.newGet()).

Throws:

IOException

executeHead

protected org.apache.http.HttpResponse executeHead(HttpNode entry)
                                            throws IOException

Executes the HEAD request method for the given URI. Equivalent to getClient().execute(entry.newHead()).

Throws:

IOException

getClient

protected final org.apache.http.client.HttpClient getClient()

Returns the cached http client obtained by calling newClient().

Returns:

The cached http client obtained by calling newClient().

newClient

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

Returns a new http client.

The implementation in the class HttpDriver simply returns HttpClientBuilder.create().useSystemProperties().build(). If you need special configuration, e.g. for authentication or caching, then you should override this method.

Returns:

A new http client.

newController

public FsController newController(FsManager manager,
                                  FsModel model,
                                  @CheckForNull
                                  FsController parent)

Description copied from interface: FsController.Factory

Returns a new file system controller for the mount point of the given file system model. This is a pure function without side effects.

When called, you may assert the following precondition:

 assert null == parent
         ? null == model.getParent()
         : parent.getModel().equals(model.getParent())
 

Parameters:

manager - the calling context.

model - the file system model.

parent - the nullable parent file system controller.

Returns:

A new file system controller for the mount point of the given file system model.