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 | */ |
Marcel Offermans | 8b93efa | 2010-07-02 18:27:21 +0000 | [diff] [blame] | 19 | package org.apache.felix.dm; |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 20 | |
Marcel Offermans | a8c213f | 2010-07-02 17:27:20 +0000 | [diff] [blame] | 21 | import java.net.URL; |
Marcel Offermans | d26f2bd | 2012-01-02 14:53:17 +0000 | [diff] [blame] | 22 | import java.util.Dictionary; |
Marcel Offermans | a8c213f | 2010-07-02 17:27:20 +0000 | [diff] [blame] | 23 | |
Marcel Offermans | 2925f17 | 2009-12-02 13:03:39 +0000 | [diff] [blame] | 24 | /** |
| 25 | * Service interface for anybody wanting to be notified of changes to resources. |
Marcel Offermans | 5be5f14 | 2011-04-26 10:47:12 +0000 | [diff] [blame] | 26 | * |
| 27 | * @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a> |
Marcel Offermans | 2925f17 | 2009-12-02 13:03:39 +0000 | [diff] [blame] | 28 | */ |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 29 | public interface ResourceHandler { |
Marcel Offermans | a8c213f | 2010-07-02 17:27:20 +0000 | [diff] [blame] | 30 | /** Name of the property that's used to describe the filter condition for a resource. */ |
| 31 | public static final String FILTER = "filter"; |
Marcel Offermans | 3d92121 | 2010-08-09 13:37:02 +0000 | [diff] [blame] | 32 | /** Exact URL that this handler is looking for. Can be used instead of a filter to be very explicit about the resource you're looking for. */ |
| 33 | public static final String URL = "url"; |
Marcel Offermans | a8c213f | 2010-07-02 17:27:20 +0000 | [diff] [blame] | 34 | /** The host part of the URL. */ |
| 35 | public static final String HOST = "host"; |
| 36 | /** The path part of the URL. */ |
| 37 | public static final String PATH = "path"; |
| 38 | /** The protocol part of the URL. */ |
| 39 | public static final String PROTOCOL = "protocol"; |
| 40 | /** The port part of the URL. */ |
| 41 | public static final String PORT = "port"; |
| 42 | |
Marcel Offermans | d26f2bd | 2012-01-02 14:53:17 +0000 | [diff] [blame] | 43 | /** |
| 44 | * @deprecated Please use {@link #added(URL, Dictionary)} instead. When both are specified, |
| 45 | * the new method takes precedence and the deprecated one is not invoked. |
| 46 | */ |
Marcel Offermans | a8c213f | 2010-07-02 17:27:20 +0000 | [diff] [blame] | 47 | public void added(URL resource); |
Marcel Offermans | d26f2bd | 2012-01-02 14:53:17 +0000 | [diff] [blame] | 48 | |
| 49 | /** |
| 50 | * Invoked whenever a new resource is added. |
| 51 | */ |
| 52 | public void added(URL resource, Dictionary resourceProperties); |
| 53 | |
| 54 | /** |
| 55 | * @deprecated Please use {@link #changed(URL, Dictionary)} instead. When both are specified, |
| 56 | * the new method takes precedence and the deprecated one is not invoked. |
| 57 | */ |
Marcel Offermans | a8c213f | 2010-07-02 17:27:20 +0000 | [diff] [blame] | 58 | public void changed(URL resource); |
Marcel Offermans | d26f2bd | 2012-01-02 14:53:17 +0000 | [diff] [blame] | 59 | |
| 60 | /** |
| 61 | * Invoked whenever an existing resource changes. |
| 62 | */ |
| 63 | public void changed(URL resource, Dictionary resourceProperties); |
| 64 | |
| 65 | /** |
| 66 | * @deprecated Please use {@link #removed(URL, Dictionary)} instead. When both are specified, |
| 67 | * the new method takes precedence and the deprecated one is not invoked. |
| 68 | */ |
Marcel Offermans | a8c213f | 2010-07-02 17:27:20 +0000 | [diff] [blame] | 69 | public void removed(URL resource); |
Marcel Offermans | d26f2bd | 2012-01-02 14:53:17 +0000 | [diff] [blame] | 70 | |
| 71 | /** |
| 72 | * Invoked whenever an existing resource is removed. |
| 73 | */ |
| 74 | public void removed(URL resource, Dictionary resourceProperties); |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 75 | } |