View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   * 
19   * Author: Siamak Haschemi
20   * Contact: haschemi@informatik.hu-berlin.de
21   */
22  package net.sourceforge.osgi.deployment.maven;
23  
24  /**
25   * <p>
26   * From the Deployment Admin Specification:
27   * </p>
28   * <p>
29   * A Deployment Package consists of installable <i>resources</i>. Resources are described in the <i>Name sections</i> of the Manifest. They are stored in the
30   * JAR file under a path. This path is called the <i>resource id</i>. Subsets of these resources are the bundles. Bundles are treated differently from the
31   * other resources by the Deployment Admin service. Non-bundle resources are called <i>processed resources</i>.
32   * </p>
33   * 
34   * @author Siamak Haschemi, haschemi@informatik.hu-berlin.de
35   */
36  public interface IResource {
37    /**
38     * The resourceId of the resource specifies the path and the name of the resource. Implementations can directly return the resourceId or compute it.
39     * 
40     * @return the path of the resource
41     */
42    String getResourceId();
43  }