Resource.java

/*
 * $Header: /cvshome/build/org.osgi.service.obr/src/org/osgi/service/obr/Resource.java,v 1.5 2006/03/16 14:56:17 hargrave Exp $
 *
 * Copyright (c) OSGi Alliance (2006). All Rights Reserved.
 *
 * 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.
 */

// This document is an experimental draft to enable interoperability
// between bundle repositories. There is currently no commitment to 
// turn this draft into an official specification.  
package org.osgi.service.obr;

import java.net.URL;
import java.util.Map;

import org.osgi.framework.Version;

/**
 * A resource is an abstraction of a downloadable thing, like a bundle.
 * 
 * Resources have capabilities and requirements. All a resource's requirements
 * must be satisfied before it can be installed.
 * 
 * @version $Revision: 1.5 $
 */
public interface Resource
{
    final String LICENSE_URL = "license";

    final String DESCRIPTION = "description";

    final String DOCUMENTATION_URL = "documentation";

    final String COPYRIGHT = "copyright";

    final String SOURCE_URL = "source";

    final String SYMBOLIC_NAME = "symbolicname";

    final String PRESENTATION_NAME = "presentationname";

    final String ID = "id";

    final String VERSION = "version";

    final String URL = "url";

    final String SIZE = "size";

    final String CATEGORY = "category";

    final static String[] KEYS = { DESCRIPTION, SIZE, ID, LICENSE_URL,
            DOCUMENTATION_URL, COPYRIGHT, SOURCE_URL, PRESENTATION_NAME,
            SYMBOLIC_NAME, VERSION, URL, CATEGORY };

    // get readable name

    Map getProperties();

    String getSymbolicName();

    String getPresentationName();

    Version getVersion();

    String getId();

    URL getURL();

    Requirement[] getRequirements();

    Capability[] getCapabilities();

    String[] getCategories();

    Repository getRepository();

}