src/java/org/apache/ivy/plugins/repository/Resource.java

/*
 *  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
 *
 *      https://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.ivy.plugins.repository;

import java.io.IOException;
import java.io.InputStream;

/**
 * Represents a resource in an Ivy {@link Repository}. The resource interface allows one to obtain
 * the following information about a resource:
 * <ul>
 * <li>resource name/identifier in repository syntax</li>
 * <li>date the resource was last modified.</li>
 * <li>size of the resource in bytes.</li>
 * <li>if the resource is available.</li>
 * </ul>
 * <h3>Implementation Notes</h3>
 * In implementing the interface you need to ensure the following behaviors:
 * <ul>
 * <li>All of the methods specified in the interface fail by returning an empty value
 * (<code>false</code>, <code>0</code>, <code>""</code>). In other words, the specified interface
 * methods should not throw RuntimeExceptions.</li>
 * <li>Failure conditions should be logged using the {@link org.apache.ivy.util.Message#verbose}
 * method.</li>
 * <li>Failure of one of the interface's specified methods results in all other interface specified
 * methods returning an empty value (<code>false</code>, <code>0</code>, <code>""</code>).</li>
 * </ul>
 */

public interface Resource {
    /**
     * Get the name of the resource.
     *
     * @return the repository's assigned resource name/identifier.
     */
    String getName();

    /**
     * Get the date the resource was last modified
     *
     * @return A <code>long</code> value representing the time the file was last modified, measured
     *         in milliseconds since the epoch (00:00:00 GMT, January 1, 1970), or <code>0L</code>
     *         if the file does not exist or if an I/O error occurs.
     */
    long getLastModified();

    /**
     * Get the resource size
     *
     * @return a <code>long</code> value representing the size of the resource in bytes.
     */
    long getContentLength();

    /**
     * Determine if the resource is available. Note that this method only checks for
     * availability, not for actual existence.
     *
     * @return <code>boolean</code> value indicating if the resource is available.
     */
    boolean exists();

    /**
     * Is this resource local to this host, i.e. is it on the file system?
     *
     * @return <code>boolean</code> value indicating if the resource is local.
     */
    boolean isLocal();

    /**
     * Clones this resource with a new resource with a different name
     *
     * @param cloneName
     *            the name of the clone
     * @return the cloned resource
     */
    Resource clone(String cloneName);

    /**
     * Opens a stream on this resource
     *
     * @return the opened input stream
     * @throws IOException if something goes wrong
     */
    InputStream openStream() throws IOException;
}