Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/**
* Copyright (C) 2006-2014 phloc systems
* http://www.phloc.com
* office[at]phloc[dot]com
*
* 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 com.phloc.commons.io.resource;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.Reader;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.net.URLConnection;
import java.nio.charset.Charset;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.phloc.commons.ValueEnforcer;
import com.phloc.commons.callback.INonThrowingRunnableWithParameter;
import com.phloc.commons.equals.EqualsUtils;
import com.phloc.commons.hash.HashCodeGenerator;
import com.phloc.commons.io.IReadableResource;
import com.phloc.commons.io.streams.StreamUtils;
import com.phloc.commons.mutable.IWrapper;
import com.phloc.commons.string.ToStringGenerator;
import com.phloc.commons.url.ISimpleURL;
import com.phloc.commons.url.URLUtils;
/**
* Implementation of the {@link IReadableResource} interface for URL objects.
*
* @author Philip Helger
*/
@Immutable
public class URLResource implements IReadableResource
{
/** The protocol for file resources */
public static final String PROTOCOL_FILE = "file";
public static final int DEFAULT_CONNECT_TIMEOUT = -1;
public static final int DEFAULT_READ_TIMEOUT = -1;
@SuppressWarnings ("unused")
private static final Logger s_aLogger = LoggerFactory.getLogger (URLResource.class);
private final URL m_aURL;
public URLResource (@Nonnull final ISimpleURL aURL) throws MalformedURLException
{
this (aURL.getAsString ());
}
public URLResource (@Nonnull final String sURL) throws MalformedURLException
{
this (new URL (sURL));
}
public URLResource (@Nonnull final URI aURI) throws MalformedURLException
{
this (aURI.toURL ());
}
public URLResource (@Nonnull final URL aURL)
{
m_aURL = ValueEnforcer.notNull (aURL, "URL");
}
/**
* Check if the passed resource name is an explicit URL resource.
*
* @param sName
* The name to check. May be null.
* @return true if the passed name is an explicit URL resource.
*/
public static boolean isExplicitURLResource (@Nullable final String sName)
{
return URLUtils.getAsURL (sName) != null;
}
@Nonnull
public String getResourceID ()
{
return getPath ();
}
@Nonnull
public String getPath ()
{
return m_aURL.toExternalForm ();
}
@Nullable
public static InputStream getInputStream (@Nonnull final URL aURL)
{
return URLUtils.getInputStream (aURL,
DEFAULT_CONNECT_TIMEOUT,
DEFAULT_READ_TIMEOUT,
null,
(IWrapper ) null);
}
@Nullable
public InputStream getInputStream ()
{
return getInputStream (DEFAULT_CONNECT_TIMEOUT, DEFAULT_READ_TIMEOUT);
}
@Nullable
public InputStream getInputStream (final int nConnectTimeoutMS, final int nReadTimeoutMS)
{
return getInputStream (nConnectTimeoutMS,
nReadTimeoutMS,
(INonThrowingRunnableWithParameter ) null,
(IWrapper ) null);
}
@Nullable
public InputStream getInputStream (@Nullable final IWrapper aExceptionHolder)
{
return getInputStream (DEFAULT_CONNECT_TIMEOUT, DEFAULT_READ_TIMEOUT, aExceptionHolder);
}
@Nullable
public InputStream getInputStream (final int nConnectTimeoutMS,
final int nReadTimeoutMS,
@Nullable final IWrapper aExceptionHolder)
{
return getInputStream (nConnectTimeoutMS,
nReadTimeoutMS,
(INonThrowingRunnableWithParameter ) null,
aExceptionHolder);
}
@Nullable
public InputStream getInputStream (final int nConnectTimeoutMS,
final int nReadTimeoutMS,
@Nullable final INonThrowingRunnableWithParameter aConnectionModifier,
@Nullable final IWrapper aExceptionHolder)
{
return URLUtils.getInputStream (m_aURL, nConnectTimeoutMS, nReadTimeoutMS, aConnectionModifier, aExceptionHolder);
}
@Nullable
@Deprecated
public Reader getReader (@Nonnull final String sCharset)
{
return StreamUtils.createReader (getInputStream (), sCharset);
}
@Nullable
public Reader getReader (@Nonnull final Charset aCharset)
{
return StreamUtils.createReader (getInputStream (), aCharset);
}
public boolean exists ()
{
// 1. as file
if (PROTOCOL_FILE.equals (m_aURL.getProtocol ()))
return getAsFile ().exists ();
// Not a file URL
InputStream aIS = null;
try
{
// 2. as stream
aIS = getInputStream ();
return aIS != null;
}
catch (final Exception ex)
{
// 3. no
return false;
}
finally
{
StreamUtils.close (aIS);
}
}
@Nonnull
public URL getAsURL ()
{
return m_aURL;
}
@Nullable
public URI getAsURI ()
{
return URLUtils.getAsURI (m_aURL);
}
@Nonnull
public static File getAsFile (@Nonnull final URL aURL)
{
ValueEnforcer.notNull (aURL, "URL");
if (!PROTOCOL_FILE.equals (aURL.getProtocol ()))
throw new IllegalArgumentException ("Not a file URL: " + aURL);
File aFile;
try
{
aFile = new File (aURL.toURI ().getSchemeSpecificPart ());
}
catch (final URISyntaxException ex)
{
// Fallback for URLs that are not valid URIs
aFile = new File (aURL.getPath ());
}
// This file may be non-existing
return aFile;
}
@Nonnull
public File getAsFile ()
{
return getAsFile (m_aURL);
}
@Nonnull
public URLResource getReadableCloneForPath (@Nonnull final URL aURL)
{
return new URLResource (aURL);
}
@Nonnull
public URLResource getReadableCloneForPath (@Nonnull final String sPath)
{
try
{
return new URLResource (sPath);
}
catch (final MalformedURLException ex)
{
throw new IllegalArgumentException ("Cannot convert to an URL: " + sPath, ex);
}
}
@Override
public boolean equals (final Object o)
{
if (o == this)
return true;
if (!(o instanceof URLResource))
return false;
final URLResource rhs = (URLResource) o;
return EqualsUtils.equals (m_aURL, rhs.m_aURL);
}
@Override
public int hashCode ()
{
return new HashCodeGenerator (this).append (m_aURL).getHashCode ();
}
@Override
public String toString ()
{
return new ToStringGenerator (null).append ("url", m_aURL).toString ();
}
}
