blob: 2414027a2c9a609254ab8583da3606230ef7201e [file] [log] [blame]
Marcel Offermanse14b3422009-11-25 23:04:32 +00001/*
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 Offermans8b93efa2010-07-02 18:27:21 +000019package org.apache.felix.dm;
Marcel Offermanse14b3422009-11-25 23:04:32 +000020
Marcel Offermansa8c213f2010-07-02 17:27:20 +000021import java.net.URL;
Marcel Offermansd26f2bd2012-01-02 14:53:17 +000022import java.util.Dictionary;
Marcel Offermansa8c213f2010-07-02 17:27:20 +000023
Marcel Offermans2925f172009-12-02 13:03:39 +000024/**
25 * Service interface for anybody wanting to be notified of changes to resources.
Marcel Offermans5be5f142011-04-26 10:47:12 +000026 *
27 * @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a>
Marcel Offermans2925f172009-12-02 13:03:39 +000028 */
Marcel Offermanse14b3422009-11-25 23:04:32 +000029public interface ResourceHandler {
Marcel Offermansa8c213f2010-07-02 17:27:20 +000030 /** Name of the property that's used to describe the filter condition for a resource. */
31 public static final String FILTER = "filter";
Marcel Offermans3d921212010-08-09 13:37:02 +000032 /** 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 Offermansa8c213f2010-07-02 17:27:20 +000034 /** 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 Offermansd26f2bd2012-01-02 14:53:17 +000043 /**
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 Offermansa8c213f2010-07-02 17:27:20 +000047 public void added(URL resource);
Marcel Offermansd26f2bd2012-01-02 14:53:17 +000048
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 Offermansa8c213f2010-07-02 17:27:20 +000058 public void changed(URL resource);
Marcel Offermansd26f2bd2012-01-02 14:53:17 +000059
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 Offermansa8c213f2010-07-02 17:27:20 +000069 public void removed(URL resource);
Marcel Offermansd26f2bd2012-01-02 14:53:17 +000070
71 /**
72 * Invoked whenever an existing resource is removed.
73 */
74 public void removed(URL resource, Dictionary resourceProperties);
Marcel Offermanse14b3422009-11-25 23:04:32 +000075}