org.osgi.service.indexer.Resource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of c8tech.tools.maven.library.osgi.repoindex Show documentation

An OSGi bundle library providing a repository indexer service based on the OSGi Alliance BIndex tool.

There is a newer version: 0.9.0

Show newest version

/**
 * ==========================================================================
 * Copyright © 2015-2018 OSGi Alliance, Cristiano Gavião.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 * Cristiano Gavião ([email protected])- initial API and implementation
 * ==========================================================================
 */
package org.osgi.service.indexer;

/*
 * Part of this code was borrowed from BIndex project (https://github.com/osgi/bindex) 
 * and it is released under OSGi Specification License, VERSION 2.0
 */
import java.io.IOException;
import java.io.InputStream;
import java.util.Dictionary;
import java.util.List;
import java.util.jar.Manifest;

import org.osgi.annotation.versioning.ProviderType;

/**
 * A resource that is to be indexed.
 */
@ProviderType
public interface Resource {
    /**
     * @return the value for the location attribute
     */
    String getLocation();

    /**
     * @return the properties
     */
    Dictionary getProperties();

    /**
     * @return the size of the resource
     */
    long getSize();

    /**
     * @return an input stream from which the resource can be read
     * @throws IOException
     *             when an I/O error occurred
     */
    InputStream getStream() throws IOException;

    /**
     * @return the manifest of the resource
     * @throws IOException
     *             when an I/O error occurred
     */
    Manifest getManifest() throws IOException;

    /**
     * @param prefix
     *            the prefix of the children that must be returned (typically
     *            the directory in the JAR)
     * @return a list of children under the specified prefix (typically the
     *         entries in the directory)
     * @throws IOException
     *             when an I/O error occurred
     */
    List listChildren(String prefix) throws IOException;

    /**
     * @param path
     *            the path of the child (typically the path in the JAR)
     * @return the child on the specified path, as a resource
     * @throws IOException
     *             when an I/O error occurred
     */
    Resource getChild(String path) throws IOException;

    /**
     * Close the resource
     */
    void close();
}