Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 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 | */ |
Pierre De Rop | 6f839d1 | 2009-12-04 22:24:01 +0000 | [diff] [blame] | 19 | package org.apache.felix.dm.resources; |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 20 | |
| 21 | import java.io.IOException; |
| 22 | import java.io.InputStream; |
| 23 | |
Marcel Offermans | 2925f17 | 2009-12-02 13:03:39 +0000 | [diff] [blame] | 24 | /** |
Marcel Offermans | 54f86e0 | 2009-12-21 10:18:28 +0000 | [diff] [blame^] | 25 | * Interface that defines a resource. Each resource has a unique ID, which should be |
| 26 | * used for equality tests. Resources also have a repository name, path and name, which |
| 27 | * can all be used to filter on. To access a resource, use the <code>openStream()</code> |
| 28 | * method. |
Marcel Offermans | 2925f17 | 2009-12-02 13:03:39 +0000 | [diff] [blame] | 29 | */ |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 30 | public interface Resource { |
Marcel Offermans | 54f86e0 | 2009-12-21 10:18:28 +0000 | [diff] [blame^] | 31 | public static final String ID = "id"; |
Marcel Offermans | 2925f17 | 2009-12-02 13:03:39 +0000 | [diff] [blame] | 32 | public static final String FILTER = "filter"; |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 33 | public static final String PATH = "path"; |
| 34 | public static final String NAME = "name"; |
| 35 | public static final String REPOSITORY = "repository"; |
| 36 | |
Marcel Offermans | 54f86e0 | 2009-12-21 10:18:28 +0000 | [diff] [blame^] | 37 | /** Returns the unique identification of this resource. */ |
| 38 | public String getID(); |
| 39 | /** Returns the name of this resource. */ |
| 40 | public String getName(); |
| 41 | /** Returns the path of this resource. */ |
| 42 | public String getPath(); |
| 43 | /** Returns the repository of this resource. */ |
| 44 | public String getRepository(); |
| 45 | /** Returns an input stream containing all data behind this resource. */ |
| 46 | public InputStream openStream() throws IOException; |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 47 | } |