| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/* <a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a> |
| <span class="sourceLineNo">018</span> */<a name="line.18"></a> |
| <span class="sourceLineNo">019</span>package org.apache.felix.ipojo;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.Dictionary;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span><a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.osgi.framework.BundleContext;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.osgi.framework.InvalidSyntaxException;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.osgi.framework.ServiceListener;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.osgi.framework.ServiceReference;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.osgi.framework.ServiceRegistration;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span><a name="line.28"></a> |
| <span class="sourceLineNo">029</span>/**<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * A service context is the facade of a service registry. <a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * It gives the access to a service broker. All service<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * interactions should use a service context to garanty<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * the service isolation.<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * This class is a subset of {@link BundleContext} methods.<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * (methods implying interactions with the service registry).<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * So, refer to this class for further information.<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * @see BundleContext<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> */<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>public interface ServiceContext extends BundleContext {<a name="line.40"></a> |
| <span class="sourceLineNo">041</span><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> /**<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * Adds a service listener.<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * The listener is added to this service context.<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * So only services from this context will be tracked.<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * @param listener the service listener to add.<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * @param filter the LDAP filter<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * @throws InvalidSyntaxException if the LDAP filter is malformed<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * @see org.osgi.framework.BundleContext#addServiceListener(org.osgi.framework.ServiceListener, java.lang.String)<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> */<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> void addServiceListener(ServiceListener listener, String filter) throws InvalidSyntaxException;<a name="line.51"></a> |
| <span class="sourceLineNo">052</span><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> /**<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * Adds a service listener.<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * The listener is added to this service context.<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * So only services from this context will be tracked.<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * @param listener the service listener to add.<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * @see org.osgi.framework.BundleContext#addServiceListener(org.osgi.framework.ServiceListener)<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> */<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> void addServiceListener(ServiceListener listener);<a name="line.60"></a> |
| <span class="sourceLineNo">061</span><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> /**<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * Gets the service references matching with the given query.<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * The query is executed inside this service context.<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * @param clazz the required interface<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * @param filter a LDAP filter<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * @return the array of available service references or <code>null</code><a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * if no providers are available.<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * @throws InvalidSyntaxException if the LDAP filter is malformed<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * @see org.osgi.framework.BundleContext#getAllServiceReferences(java.lang.String, java.lang.String)<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> */<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> ServiceReference[] getAllServiceReferences(String clazz, String filter) throws InvalidSyntaxException;<a name="line.72"></a> |
| <span class="sourceLineNo">073</span><a name="line.73"></a> |
| <span class="sourceLineNo">074</span> /**<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * Gets a service object.<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * The given service reference must comes from this<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * service context.<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * @param reference the required service reference <a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * @return the service object or null if the service reference is no more valid or if the service object is not accessible<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * @see org.osgi.framework.BundleContext#getService(org.osgi.framework.ServiceReference)<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> */<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> <S> S getService(ServiceReference<S> reference);<a name="line.82"></a> |
| <span class="sourceLineNo">083</span><a name="line.83"></a> |
| <span class="sourceLineNo">084</span> /**<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * Gets a service reference for the given interface.<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * The query is executed inside this service context.<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * @param clazz the required interface name<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * @return a service reference on a available provider or <a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * <code>null</code> if no providers are available<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * @see org.osgi.framework.BundleContext#getServiceReference(java.lang.String)<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> */<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> ServiceReference getServiceReference(String clazz);<a name="line.92"></a> |
| <span class="sourceLineNo">093</span><a name="line.93"></a> |
| <span class="sourceLineNo">094</span> /**<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * Gets service reference list for the given query.<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * The query is executed inside this service context.<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * @param clazz : the name of the required service interface<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * @param filter : LDAP filter to apply on service provider<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * @return : the array of consistent service reference or <code>null</code><a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * if no available providers<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * @throws InvalidSyntaxException if the LDAP filter is malformed<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * @see org.osgi.framework.BundleContext#getServiceReferences(java.lang.String, java.lang.String)<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> */<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> ServiceReference[] getServiceReferences(String clazz, String filter) throws InvalidSyntaxException;<a name="line.104"></a> |
| <span class="sourceLineNo">105</span><a name="line.105"></a> |
| <span class="sourceLineNo">106</span> /**<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * Registers a service inside this service context.<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * This service is then isolated inside this context.<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * @param clazzes the interfaces provided by the service.<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * @param service the service object.<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * @param properties service properties to publish<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * @return the service registration for this service publication.<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * This service registration is attached to the current service context,<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * and does not have any meaning in other contexts.<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * @see org.apache.felix.ipojo.ServiceContext#registerService(java.lang.String[], java.lang.Object, java.util.Dictionary)<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> */<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> ServiceRegistration registerService(String[] clazzes, Object service, Dictionary<String, ?> properties);<a name="line.117"></a> |
| <span class="sourceLineNo">118</span><a name="line.118"></a> |
| <span class="sourceLineNo">119</span> /**<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * Registers a service inside this service context.<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * This service is then isolated inside this context.<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * @param clazz the interface provided by the service.<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> * @param service the service object.<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * @param properties service properties to publish.<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * @return the service registration for this service publication. <a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * This service registration is attached to the current service context,<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> * and does not have any meaning in other contexts.<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * @see org.osgi.framework.BundleContext#registerService(java.lang.String, java.lang.Object, java.util.Dictionary)<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> */<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> ServiceRegistration registerService(String clazz, Object service, Dictionary<String, ?> properties);<a name="line.130"></a> |
| <span class="sourceLineNo">131</span><a name="line.131"></a> |
| <span class="sourceLineNo">132</span> /**<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * Removes a service listener.<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * The listener must be registered inside this service context.<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> * @param listener the listener to remove<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * @see org.osgi.framework.BundleContext#removeServiceListener(org.osgi.framework.ServiceListener)<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> */<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> void removeServiceListener(ServiceListener listener);<a name="line.138"></a> |
| <span class="sourceLineNo">139</span><a name="line.139"></a> |
| <span class="sourceLineNo">140</span> /**<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * Ungets the service reference.<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> * The service reference must comes from this service context.<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> * @param reference the reference to unget<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> * @return <code>true</code> if you are the last user of the reference.<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * @see org.osgi.framework.BundleContext#ungetService(org.osgi.framework.ServiceReference)<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> */<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> boolean ungetService(ServiceReference<?> reference);<a name="line.147"></a> |
| <span class="sourceLineNo">148</span><a name="line.148"></a> |
| <span class="sourceLineNo">149</span>}<a name="line.149"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
