blob: 57de9c7c9d443f05593a75b1f862ea43e53472b3 (
plain)
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
/*
* Copyright (c) OSGi Alliance (2008, 2009). 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.service.discovery;
import java.util.Collection;
/**
* Interface for notification on discovered services.
* <p>
* <code>DiscoveredServiceNotification</code> objects are immutable.
*
* @Immutable
*/
public interface DiscoveredServiceNotification {
/**
* Notification indicating that a service matching the listening criteria
* has been discovered.
* <p>
* The value of <code>AVAILABLE</code> is 0x00000001.
*/
public final static int AVAILABLE = 0x00000001;
/**
* Notification indicating that the properties of a previously discovered
* service have changed.
* <p>
* The value of <code>MODIFIED</code> is 0x00000002.
*/
public final static int MODIFIED = 0x00000002;
/**
* Notification indicating that a previously discovered service is no longer
* known to <code>Discovery</code>.
* <p>
* The value of <code>UNAVAILABLE</code> is 0x00000004.
*/
public final static int UNAVAILABLE = 0x00000004;
/**
* Notification indicating that the properties of a previously discovered
* service have changed and the new properties no longer match the
* listener's filter.
* <p>
* The value of <code>MODIFIED_ENDMATCH</code> is 0x00000008.
*/
public final static int MODIFIED_ENDMATCH = 0x00000008;
/**
* Returns information currently known to <code>Discovery</code> regarding
* the service endpoint.
*
* @return metadata of the service <code>Discovery</code> notifies about. Is
* never <code>null</code>.
*/
ServiceEndpointDescription getServiceEndpointDescription();
/**
* Returns the type of notification. The type values are:
* <ul>
* <li>{@link #AVAILABLE}</li>
* <li>{@link #MODIFIED}</li>
* <li>{@link #MODIFIED_ENDMATCH}</li>
* <li>{@link #UNAVAILABLE}</li>
* </ul>
*
* @return Type of notification regarding known service metadata.
*/
int getType();
/**
* Returns interface name criteria of the {@link DiscoveredServiceTracker}
* object matching with the interfaces of the
* <code>ServiceEndpointDescription</code> and thus caused the notification.
*
* @return <code>Collection (<? extends String>)</code> of matching interface name criteria of the
* <code>DiscoveredServiceTracker</code> object being notified, or
* an empty collection if notification hasn't been caused by a
* matching interface name criteria.
*/
Collection/* <? extends String> */getInterfaces();
/**
* Returns filters of the <code>DiscoveredServiceTracker</code> object
* matching with the properties of the
* <code>ServiceEndpointDescription</code> and thus caused the notification.
*
* @return <code>Collection (<? extends String>)</code> of matching filters of the <code>DiscoveredServiceTracker</code>
* object being notified, or an empty collection if notification
* hasn't been caused by a matching filter criteria.
*/
Collection/* <? extends String> */getFilters();
}
|
