blob: abf88044fd5c9642c2f3a048aa8333e3efaa6d5d [file] [log] [blame]
<!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><a name="line.19"></a>
<span class="sourceLineNo">020</span>package org.apache.felix.ipojo.handlers.providedservice.strategy;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.lang.reflect.InvocationHandler;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.lang.reflect.Method;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.felix.ipojo.ComponentInstance;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.felix.ipojo.IPOJOServiceFactory;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>/**<a name="line.28"></a>
<span class="sourceLineNo">029</span> * This proxy class is here to wrap an iPOJO ServiceFactory.<a name="line.29"></a>
<span class="sourceLineNo">030</span> * If the consumer of this service do not call the getService or ungetService<a name="line.30"></a>
<span class="sourceLineNo">031</span> * methods, it will get an Exception with an explicit error message telling<a name="line.31"></a>
<span class="sourceLineNo">032</span> * him that this service is only usable through iPOJO.<a name="line.32"></a>
<span class="sourceLineNo">033</span> * @author &lt;a href="mailto:dev@felix.apache.org"&gt;Felix Project Team&lt;/a&gt;<a name="line.33"></a>
<span class="sourceLineNo">034</span> */<a name="line.34"></a>
<span class="sourceLineNo">035</span>public class ErrorPrintingServiceFactoryProxy implements InvocationHandler {<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span> /**<a name="line.37"></a>
<span class="sourceLineNo">038</span> * getService(ComponentInstance) method.<a name="line.38"></a>
<span class="sourceLineNo">039</span> */<a name="line.39"></a>
<span class="sourceLineNo">040</span> private static Method GET_METHOD;<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> * ungetService(ComponentInstance, Object) method.<a name="line.43"></a>
<span class="sourceLineNo">044</span> */<a name="line.44"></a>
<span class="sourceLineNo">045</span> private static Method UNGET_METHOD;<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span> /**<a name="line.47"></a>
<span class="sourceLineNo">048</span> * Wrapped factory.<a name="line.48"></a>
<span class="sourceLineNo">049</span> */<a name="line.49"></a>
<span class="sourceLineNo">050</span> private final IPOJOServiceFactory m_factory;<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> static {<a name="line.52"></a>
<span class="sourceLineNo">053</span> // Static initialization of theses constants.<a name="line.53"></a>
<span class="sourceLineNo">054</span> try {<a name="line.54"></a>
<span class="sourceLineNo">055</span> GET_METHOD = IPOJOServiceFactory.class.getMethod("getService",<a name="line.55"></a>
<span class="sourceLineNo">056</span> new Class[]{ComponentInstance.class});<a name="line.56"></a>
<span class="sourceLineNo">057</span> UNGET_METHOD = IPOJOServiceFactory.class.getMethod("ungetService",<a name="line.57"></a>
<span class="sourceLineNo">058</span> new Class[]{ComponentInstance.class, Object.class});<a name="line.58"></a>
<span class="sourceLineNo">059</span> } catch (Exception e) {<a name="line.59"></a>
<span class="sourceLineNo">060</span> // Should never happen<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><a name="line.63"></a>
<span class="sourceLineNo">064</span> /**<a name="line.64"></a>
<span class="sourceLineNo">065</span> * Wraps a ServiceFactory in an InvocationHandler that will delegate only<a name="line.65"></a>
<span class="sourceLineNo">066</span> * get/ungetService methods to the factory. All other methods will be<a name="line.66"></a>
<span class="sourceLineNo">067</span> * rejected with a meaningful error message.<a name="line.67"></a>
<span class="sourceLineNo">068</span> *<a name="line.68"></a>
<span class="sourceLineNo">069</span> * @param factory delegating iPOJO ServiceFactory<a name="line.69"></a>
<span class="sourceLineNo">070</span> */<a name="line.70"></a>
<span class="sourceLineNo">071</span> public ErrorPrintingServiceFactoryProxy(final IPOJOServiceFactory factory) {<a name="line.71"></a>
<span class="sourceLineNo">072</span> this.m_factory = factory;<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> /**<a name="line.75"></a>
<span class="sourceLineNo">076</span> * 'Invoke' methods called when a method is called on the proxy.<a name="line.76"></a>
<span class="sourceLineNo">077</span> * @param proxy the proxy<a name="line.77"></a>
<span class="sourceLineNo">078</span> * @param method the method<a name="line.78"></a>
<span class="sourceLineNo">079</span> * @param args the arguments<a name="line.79"></a>
<span class="sourceLineNo">080</span> * @return the result<a name="line.80"></a>
<span class="sourceLineNo">081</span> * @throws Exception if something wrong happens<a name="line.81"></a>
<span class="sourceLineNo">082</span> * @see java.lang.reflect.InvocationHandler#invoke(java.lang.Object, java.lang.reflect.Method, java.lang.Object[])<a name="line.82"></a>
<span class="sourceLineNo">083</span> */<a name="line.83"></a>
<span class="sourceLineNo">084</span> public Object invoke(final Object proxy,<a name="line.84"></a>
<span class="sourceLineNo">085</span> final Method method,<a name="line.85"></a>
<span class="sourceLineNo">086</span> final Object[] args) throws Exception {<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span> // Handle get/unget operations<a name="line.88"></a>
<span class="sourceLineNo">089</span> if (GET_METHOD.equals(method)) {<a name="line.89"></a>
<span class="sourceLineNo">090</span> return m_factory.getService((ComponentInstance) args[0]);<a name="line.90"></a>
<span class="sourceLineNo">091</span> }<a name="line.91"></a>
<span class="sourceLineNo">092</span> if (UNGET_METHOD.equals(method)) {<a name="line.92"></a>
<span class="sourceLineNo">093</span> m_factory.ungetService((ComponentInstance) args[0], args[1]);<a name="line.93"></a>
<span class="sourceLineNo">094</span> return null;<a name="line.94"></a>
<span class="sourceLineNo">095</span> }<a name="line.95"></a>
<span class="sourceLineNo">096</span><a name="line.96"></a>
<span class="sourceLineNo">097</span> // KF is calling hashCode, we return the proxy hashCode.<a name="line.97"></a>
<span class="sourceLineNo">098</span> if (method.getName().equals("hashCode")) {<a name="line.98"></a>
<span class="sourceLineNo">099</span> return this.hashCode();<a name="line.99"></a>
<span class="sourceLineNo">100</span> }<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span> // All other methods are rejected<a name="line.102"></a>
<span class="sourceLineNo">103</span> throw new UnsupportedOperationException("This service requires an advanced creation policy. "<a name="line.103"></a>
<span class="sourceLineNo">104</span> + "Before calling the service, call the IPOJOServiceFactory.getService(ComponentInstance) "<a name="line.104"></a>
<span class="sourceLineNo">105</span> + "method to get the service object. ");<a name="line.105"></a>
<span class="sourceLineNo">106</span><a name="line.106"></a>
<span class="sourceLineNo">107</span> }<a name="line.107"></a>
<span class="sourceLineNo">108</span><a name="line.108"></a>
<span class="sourceLineNo">109</span>}<a name="line.109"></a>
</pre>
</div>
</body>
</html>