/*
    * 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.http;
  
  import java.util.Arrays;
  import java.util.Collection;
  import java.util.Collections;
  
  import org.apache.commons.httpclient.HttpClient;
  import org.apache.commons.vfs2.Capability;
  import org.apache.commons.vfs2.FileName;
  import org.apache.commons.vfs2.FileSystem;
  import org.apache.commons.vfs2.FileSystemConfigBuilder;
  import org.apache.commons.vfs2.FileSystemException;
  import org.apache.commons.vfs2.FileSystemOptions;
  import org.apache.commons.vfs2.UserAuthenticationData;
  import org.apache.commons.vfs2.provider.AbstractOriginatingFileProvider;
  import org.apache.commons.vfs2.provider.GenericFileName;
  import org.apache.commons.vfs2.util.UserAuthenticatorUtils;
  
  /**
   * An HTTP provider that uses commons-httpclient.
   */
  public class HttpFileProvider extends AbstractOriginatingFileProvider {
  
      /** Authenticator information. */
      public static final UserAuthenticationData.Type[] AUTHENTICATOR_TYPES = new UserAuthenticationData.Type[] {
              UserAuthenticationData.USERNAME, UserAuthenticationData.PASSWORD };
  
      static final Collection<Capability> CAPABILITIES = Collections
              .unmodifiableCollection(Arrays.asList(Capability.GET_TYPE, Capability.READ_CONTENT, Capability.URI, Capability.GET_LAST_MODIFIED,
                      Capability.ATTRIBUTES, Capability.RANDOM_ACCESS_READ, Capability.DIRECTORY_READ_CONTENT));
  
      /**
       * Constructs a new provider.
       */
      public HttpFileProvider() {
          setFileNameParser(HttpFileNameParser.getInstance());
      }
  
      /**
       * Creates a {@link FileSystem}.
       */
      @Override
      protected FileSystem doCreateFileSystem(final FileName name, final FileSystemOptions fileSystemOptions)
              throws FileSystemException {
          // Create the file system
          final GenericFileName/../../org/apache/commons/vfs2/provider/GenericFileName.html#GenericFileName">GenericFileName rootName = (GenericFileName) name;
  
          UserAuthenticationData authData = null;
          HttpClient httpClient;
          try {
              authData = UserAuthenticatorUtils.authenticate(fileSystemOptions, AUTHENTICATOR_TYPES);
  
              final String fileScheme = rootName.getScheme();
              final char lastChar = fileScheme.charAt(fileScheme.length() - 1);
              final String internalScheme = (lastChar == 's' || lastChar == 'S') ? "https" : "http";
  
              httpClient = HttpClientFactory.createConnection(internalScheme, rootName.getHostName(),
                      rootName.getPort(),
                      UserAuthenticatorUtils.toString(UserAuthenticatorUtils.getData(authData,
                              UserAuthenticationData.USERNAME, UserAuthenticatorUtils.toChar(rootName.getUserName()))),
                      UserAuthenticatorUtils.toString(UserAuthenticatorUtils.getData(authData,
                              UserAuthenticationData.PASSWORD, UserAuthenticatorUtils.toChar(rootName.getPassword()))),
                      fileSystemOptions);
          } finally {
              UserAuthenticatorUtils.cleanup(authData);
          }
  
          return new HttpFileSystem(rootName, httpClient, fileSystemOptions);
      }
  
      @Override
      public Collection<Capability> getCapabilities() {
          return CAPABILITIES;
      }
  
      @Override
      public FileSystemConfigBuilder getConfigBuilder() {
          return HttpFileSystemConfigBuilder.getInstance();
      }
  }