Open Source Repository

Home /spring/spring-core-3.0.5 | Repository Home


org/springframework/core/io/UrlResource.java
/*
 * Copyright 2002-2009 the original author or authors.
 *
 * Licensed 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.springframework.core.io;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URL;
import java.net.URLConnection;

import org.springframework.util.Assert;
import org.springframework.util.StringUtils;

/**
 {@link Resource} implementation for <code>java.net.URL</code> locators.
 * Obviously supports resolution as URL, and also as File in case of
 * the "file:" protocol.
 *
 @author Juergen Hoeller
 @since 28.12.2003
 @see java.net.URL
 */
public class UrlResource extends AbstractFileResolvingResource {

  /**
   * Original URL, used for actual access.
   */
  private final URL url;

  /**
   * Cleaned URL (with normalized path), used for comparisons.
   */
  private final URL cleanedUrl;

  /**
   * Original URI, if available; used for URI and File access.
   */
  private final URI uri;


  /**
   * Create a new UrlResource.
   @param url a URL
   */
  public UrlResource(URL url) {
    Assert.notNull(url, "URL must not be null");
    this.url = url;
    this.cleanedUrl = getCleanedUrl(this.url, url.toString());
    this.uri = null;
  }

  /**
   * Create a new UrlResource.
   @param uri a URI
   @throws MalformedURLException if the given URL path is not valid
   */
  public UrlResource(URI urithrows MalformedURLException {
    Assert.notNull(uri, "URI must not be null");
    this.url = uri.toURL();
    this.cleanedUrl = getCleanedUrl(this.url, uri.toString());
    this.uri = uri;
  }

  /**
   * Create a new UrlResource.
   @param path a URL path
   @throws MalformedURLException if the given URL path is not valid
   */
  public UrlResource(String paththrows MalformedURLException {
    Assert.notNull(path, "Path must not be null");
    this.url = new URL(path);
    this.cleanedUrl = getCleanedUrl(this.url, path);
    this.uri = null;
  }

  /**
   * Determine a cleaned URL for the given original URL.
   @param originalUrl the original URL
   @param originalPath the original URL path
   @return the cleaned URL
   @see org.springframework.util.StringUtils#cleanPath
   */
  private URL getCleanedUrl(URL originalUrl, String originalPath) {
    try {
      return new URL(StringUtils.cleanPath(originalPath));
    }
    catch (MalformedURLException ex) {
      // Cleaned URL path cannot be converted to URL
      // -> take original URL.
      return originalUrl;
    }
  }


  /**
   * This implementation opens an InputStream for the given URL.
   * It sets the "UseCaches" flag to <code>false</code>,
   * mainly to avoid jar file locking on Windows.
   @see java.net.URL#openConnection()
   @see java.net.URLConnection#setUseCaches(boolean)
   @see java.net.URLConnection#getInputStream()
   */
  public InputStream getInputStream() throws IOException {
    URLConnection con = this.url.openConnection();
    con.setUseCaches(false);
    try {
      return con.getInputStream();
    }
    catch (IOException ex) {
      // Close the HTTP connection (if applicable).
      if (con instanceof HttpURLConnection) {
        ((HttpURLConnectioncon).disconnect();
      }
      throw ex;
    }
  }

  /**
   * This implementation returns the underlying URL reference.
   */
  @Override
  public URL getURL() throws IOException {
    return this.url;
  }

  /**
   * This implementation returns the underlying URI directly,
   * if possible.
   */
  @Override
  public URI getURI() throws IOException {
    if (this.uri != null) {
      return this.uri;
    }
    else {
      return super.getURI();
    }
  }

  /**
   * This implementation returns a File reference for the underlying URL/URI,
   * provided that it refers to a file in the file system.
   @see org.springframework.util.ResourceUtils#getFile(java.net.URL, String)
   */
  @Override
  public File getFile() throws IOException {
    if (this.uri != null) {
      return super.getFile(this.uri);
    }
    else {
      return super.getFile();
    }
  }

  /**
   * This implementation creates a UrlResource, applying the given path
   * relative to the path of the underlying URL of this resource descriptor.
   @see java.net.URL#URL(java.net.URL, String)
   */
  @Override
  public Resource createRelative(String relativePaththrows MalformedURLException {
    if (relativePath.startsWith("/")) {
      relativePath = relativePath.substring(1);
    }
    return new UrlResource(new URL(this.url, relativePath));
  }

  /**
   * This implementation returns the name of the file that this URL refers to.
   @see java.net.URL#getFile()
   @see java.io.File#getName()
   */
  @Override
  public String getFilename() {
    return new File(this.url.getFile()).getName();
  }

  /**
   * This implementation returns a description that includes the URL.
   */
  public String getDescription() {
    return "URL [" this.url + "]";
  }


  /**
   * This implementation compares the underlying URL references.
   */
  @Override
  public boolean equals(Object obj) {
    return (obj == this ||
        (obj instanceof UrlResource && this.cleanedUrl.equals(((UrlResourceobj).cleanedUrl)));
  }

  /**
   * This implementation returns the hash code of the underlying URL reference.
   */
  @Override
  public int hashCode() {
    return this.cleanedUrl.hashCode();
  }

}