1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
|
/*
* Copyright (c) OSGi Alliance (2008, 2012). 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.
*/
package org.osgi.framework.hooks.service;
import java.util.Collection;
import org.osgi.framework.BundleContext;
import org.osgi.framework.ServiceReference;
/**
* OSGi Framework Service Find Hook Service.
*
* <p>
* Bundles registering this service will be called during framework service find
* (get service references) operations.
*
* @ThreadSafe
* @version $Id: 45612d6a10a25ca0b40ba695eb8dba21c2c78c24 $
*/
public interface FindHook {
/**
* Find hook method. This method is called during the service find operation
* (for example, {@link BundleContext#getServiceReferences(String, String)}
* ). This method can filter the result of the find operation.
*
* @param context The bundle context of the bundle performing the find
* operation.
* @param name The class name of the services to find or {@code null} to
* find all services.
* @param filter The filter criteria of the services to find or {@code null}
* for no filter criteria.
* @param allServices {@code true} if the find operation is the result of a
* call to
* {@link BundleContext#getAllServiceReferences(String, String)}
* @param references A collection of Service References to be returned as a
* result of the find operation. The implementation of this method
* may remove service references from the collection to prevent the
* references from being returned to the bundle performing the find
* operation. The collection supports all the optional
* {@code Collection} operations except {@code add} and
* {@code addAll}. Attempting to add to the collection will result in
* an {@code UnsupportedOperationException}. The collection is not
* synchronized.
*/
void find(BundleContext context, String name, String filter, boolean allServices, Collection<ServiceReference<?>> references);
}
|
