| <!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.extender;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.felix.ipojo.extender.builder.FactoryBuilder;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.felix.ipojo.metadata.Element;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span><a name="line.24"></a> |
| <span class="sourceLineNo">025</span>/**<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * This service provides a way for users to manage declarations through code.<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> *<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * Notice that produced declarations are immutable once build. But it is possible to re-use a<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * builder to share some configuration through instances.<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> *<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * <pre><a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * // Obtain the service through the service registry<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * DeclarationBuilderService service = ...<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> *<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * // Get a fresh instance builder<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * DeclarationBuilder builder = service.newInstance("the.full.name.of.the.component.to.instantiate");<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> *<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * DeclarationHandle handle = builder.name("a-unique-name") // Make sure name is unique for the expected type<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * .configure()<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * .property("a-property", "a-value")<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * .property("another-property", "another-value")<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * .build();<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> *<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * // Push the InstanceDeclaration service in the registry<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * handle.publish();<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * </pre><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> *<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * Except the {@link InstanceBuilder#build()} call, all methods are optional:<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * <ul><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * <li>{@link InstanceBuilder#name(String)}: if no name is provided,<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * a default one will be generated by iPOJO.</li><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * <li>{@link InstanceBuilder#version(String)}: if no version is provided,<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * the first un-versioned type will be used.</li><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * <li>{@link InstanceBuilder#configure()}: if no configuration is required, can be omitted.</li><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * <li>{@link InstanceBuilder#type(String)}: can be used to change the <bold>required</bold> component type.</li><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * <li>{@link InstanceBuilder#context(org.osgi.framework.BundleContext)}: by default, the bundle context<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * used to register the created {@link org.apache.felix.ipojo.extender.Declaration} is the one of the<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * caller. It can be changed though this method.</li><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * </ul><a name="line.59"></a> |
| <span class="sourceLineNo">060</span> *<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * Once an instance handle has been created, its configuration (name, type, version and properties) is immutable. It can<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * only be {@linkplain DeclarationHandle#publish() published} (so that the framework will try to instantiate the<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * instance) or {@linkplain DeclarationHandle#retract() retracted} (framework will remove the instance).<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> *<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * Notice that all created instances will appear as "coming from" the bundle that requires the<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * {@link DeclarationBuilderService} service. Just like having a {@literal metadata.xml} file in your<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * bundle that declares your instances. It is possible to override this default behavior using<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * {@link InstanceBuilder#context(org.osgi.framework.BundleContext)}.<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> *<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * @see org.apache.felix.ipojo.extender.InstanceDeclaration<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * @see org.apache.felix.ipojo.extender.TypeDeclaration<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * @see org.apache.felix.ipojo.extender.ExtensionDeclaration<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * @see org.apache.felix.ipojo.extender.InstanceBuilder<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * @see org.apache.felix.ipojo.extender.ConfigurationBuilder<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * @see org.apache.felix.ipojo.extender.DeclarationHandle<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> *<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * @since 1.11.2<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> */<a name="line.78"></a> |
| <span class="sourceLineNo">079</span>public interface DeclarationBuilderService {<a name="line.79"></a> |
| <span class="sourceLineNo">080</span><a name="line.80"></a> |
| <span class="sourceLineNo">081</span> /**<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * Declares a new anonymous instance of a given type.<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * Invoking this method is equivalent to invoking <code>{@linkplain #newInstance(String, String) newInstance(type, null)}</code>.<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * @param type name of the component to be instantiated (cannot be null).<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * @return a handle usable to publish / retract the declaration.<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * @see org.apache.felix.ipojo.extender.InstanceDeclaration<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> */<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> InstanceBuilder newInstance(String type);<a name="line.88"></a> |
| <span class="sourceLineNo">089</span><a name="line.89"></a> |
| <span class="sourceLineNo">090</span> /**<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * Declares a new instance of a given type.<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * Invoking this method is equivalent to invoking <code>{@linkplain #newInstance(String, String, String) newInstance(type, name, null)}</code>.<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * @param type name of the component to be instantiated.<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * @param name name of the new instance (can be null)<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * @return a handle usable to publish / retract the declaration.<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * @see org.apache.felix.ipojo.extender.InstanceDeclaration<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> */<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> InstanceBuilder newInstance(String type, String name);<a name="line.98"></a> |
| <span class="sourceLineNo">099</span><a name="line.99"></a> |
| <span class="sourceLineNo">100</span> /**<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * Declares a new instance of a given type.<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * @param type name of the component to be instantiated.<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * @param name name of the new instance (can be null)<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * @param version version of the expected type (can be null)<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * @return a handle usable to publish / retract the declaration.<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * @see org.apache.felix.ipojo.extender.InstanceDeclaration<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> */<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> InstanceBuilder newInstance(String type, String name, String version);<a name="line.108"></a> |
| <span class="sourceLineNo">109</span><a name="line.109"></a> |
| <span class="sourceLineNo">110</span> /**<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * Declares a new extension (supports new types like {@literal component}, {@literal composite}, {@literal handler}).<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * @param name name of the type to support (no namespace to be provided)<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * @param builder associated factory builder<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * @return a handle usable to publish / retract the declaration.<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * @see org.apache.felix.ipojo.IPojoFactory<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * @see org.apache.felix.ipojo.extender.ExtensionDeclaration<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> */<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> DeclarationHandle newExtension(String name, FactoryBuilder builder);<a name="line.118"></a> |
| <span class="sourceLineNo">119</span><a name="line.119"></a> |
| <span class="sourceLineNo">120</span> /**<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * Declares a new type using the given element description.<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * @param description description of the component type<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> * @return a handle usable to publish / retract the declaration.<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * @see org.apache.felix.ipojo.extender.TypeDeclaration<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> */<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> DeclarationHandle newType(Element description);<a name="line.126"></a> |
| <span class="sourceLineNo">127</span>}<a name="line.127"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
