/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.commons.vfs2.provider.http4;

import java.io.IOException;
import java.net.URI;
import java.util.Collection;

import org.apache.commons.vfs2.Capability;
import org.apache.commons.vfs2.FileName;
import org.apache.commons.vfs2.FileObject;
import org.apache.commons.vfs2.FileSystemOptions;
import org.apache.commons.vfs2.provider.AbstractFileName;
import org.apache.commons.vfs2.provider.AbstractFileSystem;
import org.apache.http.client.HttpClient;
import org.apache.http.client.protocol.HttpClientContext;
import org.apache.http.impl.client.CloseableHttpClient;

http4 file system.
/** * http4 file system. */
public class Http4FileSystem extends AbstractFileSystem {
Internal base URI of this file system.
/** * Internal base URI of this file system. */
private final URI internalBaseURI;
Internal HttpClient instance of this file system.
/** * Internal <code>HttpClient</code> instance of this file system. */
private final HttpClient httpClient;
Internal HttpClientContext instance of this file system.
/** * Internal <code>HttpClientContext</code> instance of this file system. */
private final HttpClientContext httpClientContext;
Construct Http4FileSystem.
Params:
  • rootName – root base name
  • fileSystemOptions – file system options
  • httpClient – HttpClient instance
  • httpClientContext – HttpClientContext instance
/** * Construct <code>Http4FileSystem</code>. * * @param rootName root base name * @param fileSystemOptions file system options * @param httpClient {@link HttpClient} instance * @param httpClientContext {@link HttpClientContext} instance */
protected Http4FileSystem(final FileName rootName, final FileSystemOptions fileSystemOptions, final HttpClient httpClient, final HttpClientContext httpClientContext) { super(rootName, null, fileSystemOptions); final String rootURI = getRootURI(); final int offset = rootURI.indexOf(':'); final char lastCharOfScheme = (offset > 0) ? rootURI.charAt(offset - 1) : 0; // if scheme is 'http*s' or 'HTTP*S', then the internal base URI should be 'https'. 'http' otherwise. if (lastCharOfScheme == 's' || lastCharOfScheme == 'S') { this.internalBaseURI = URI.create("https" + rootURI.substring(offset)); } else { this.internalBaseURI = URI.create("http" + rootURI.substring(offset)); } this.httpClient = httpClient; this.httpClientContext = httpClientContext; } @Override protected FileObject createFile(final AbstractFileName name) throws Exception { return new Http4FileObject<>(name, this); } @Override protected void addCapabilities(final Collection<Capability> caps) { caps.addAll(Http4FileProvider.capabilities); } @Override protected void doCloseCommunicationLink() { if (httpClient instanceof CloseableHttpClient) { try { ((CloseableHttpClient) httpClient).close(); } catch (final IOException e) { throw new RuntimeException("Error closing HttpClient", e); } } }
Return the internal HttpClient instance.
Returns:the internal HttpClient instance
/** * Return the internal {@link HttpClient} instance. * * @return the internal {@link HttpClient} instance */
protected HttpClient getHttpClient() { return httpClient; }
Return the internal HttpClientContext instance.
Returns:the internal HttpClientContext instance
/** * Return the internal {@link HttpClientContext} instance. * * @return the internal {@link HttpClientContext} instance */
protected HttpClientContext getHttpClientContext() { return httpClientContext; }
Return the internal base URI instance.
Returns:the internal base URI instance
/** * Return the internal base <code>URI</code> instance. * * @return the internal base <code>URI</code> instance */
protected URI getInternalBaseURI() { return internalBaseURI; } }