This document explains how developers can use iPOJO extensibility mechanism to extend the (primitive) component instance container. Such extensibility mechanism does not require to modify the iPOJO core.
- iPOJO Concepts
- Handler development basis
- Declaring your handler
- Handler lifecycle
- Reading handler and instance configurations
- Interacting with the POJO
- Using your handler
- Log Handler example
- Handler metadata
- Handler implementation
- Handler packaging
- Handler usage
- Properties Handler example
- Handler implementation
- Handler packaging
- Handler usage
- Advanced topics
- Handler's annotations
- Handler's XSD
First, iPOJO concepts are briefly explained. The second section explains the steps to create a handler. The two last sections describes the implementation and the usage of two small example handlers : a Log Handler, logging messages inside the OSGi log service, and a Property Handler, injecting properties values inside fields.
iPOJO is a service oriented component model aiming to simplify OSGi applications development. iPOJO is based on the POJO concepts. A POJO is a simple Java class without any dependency on its runtime environment. In iPOJO, POJO are encapsulated in a container managing the relation between the POJO and the external world. This container keeps separated the POJO from the external "wild" world. Moreover, this container can be extended, using handlers.
Basically, iPOJO contains two main concepts: component type and component instance. A component type is a type of component. A component type defines its implementation class, its creation policy, and its container. A component instance is a configured instance of a component type. This instance is created with the component type factory. A component instance inherits of all component type characteristics but has a unique name and its own configuration (set of <key, value>).
Above these concepts, iPOJO runtime will manage component type factories and component instances. Each component instance is managed separately (but the factory can delete them).
A component type declares its container configuration. Each component instance owns its container conform to the component type container configuration. An iPOJO container is composed by an InstanceManager, encapsulating the POJO, on which are plugged handlers. A handler manages one non functional concern. Handlers participate to the component instance lifecycle; can interact with the POJO; can manage relations with external entity like database, or other POJOs... For example, a persistence handler may interact with a database to store and inject POJO state, while an administration handler may use JMX to allow remote configuration of instance properties.
iPOJO is an extensible model allowing developer to manage other non functional concerns. Indeed, handlers can be developed singly, without modifying the iPOJO core. At runtime, iPOJO looks for each handler needed by a component instance and plugs an instance of each (required) handler on the container. So iPOJO containers are flexible, light and adaptable to each component. When a needed handler cannot be found, the component instance cannot be created.
An external handler is identified by a namespace. This namespace will be used by developers to refer to the external handler (when he configures its component type) and by iPOJO to instantiate the handler object.
Note : iPOJO core contains 6 "core" handlers managing service providing, service dependencies, lifecycle callbacks, lifecycle controller, instance dynamic configuration, and component instance architecture. Theses handlers follow the same rules than external handlers, except that they use the iPOJO default namespace (i.e. org.apache.felix.ipojo).
As explain above, the handler interacts with the POJO, with the component's container and with the external world (e.g. : other components, services, bundles, the OSGi framework, ...). The skeleton of such an agent is defined in iPOJO is defined by the PrimitiveHandler (abstract) class that can be found in the org.apache.felix.ipojo package.
You need to implement the three basic lifecycle methods of this class, but you can extends this model by redefining some other methods (e.g. : to intercept POJO method calls, field accesses, ...).
You first need to declare your handler, so iPOJO will be able to initialize, configure and use it when needed. First, you must give a name and an XML namespace to your handler. By doing that, iPOJO can recognize that a certain component uses your handler, so it can initialize it. You need to declare, in the metadata.xml of the bundle containing your handler, the class name of your handler and its name and XML namespace. You can, of course, declare several handlers, and even declare components using these handlers, in the same bundle.
Then, you must know that a handler is a component (almost) like standard iPOJO components : it can use other handlers (like core handlers : service requirements, provided services, ...). You can consequently describe your handler's required services, provided services, etc. in its metadata.xml, as for classic iPOJO components.
Note : In order to use iPOJO annotations processing, the namespace must be a valid package name and the name must be a valid annotation name (without the '@'). Refer to the annotations section.
Hint : It is a good idea to provide a documented XML schema description (XSD) with your handler to help users to configure your handler and to validate their configurations. Refer to the xsd section.
A handler lifecycle is composed of four different states.
- First, when iPOJO parses the metadata.xml of a bundle, it detects that a certain component type use your handler (using XML qualified names, see the following ìUsing your handlerî section). When it finds such a reference, it initializes the handler by calling the initializeComponentFactory() method. This method should be static but actually can't be so for some technical reasons. Consequently, a ìmockî instance of the handler is created, the initializeComponentFactory() method is called, and this instance is destroyed. This method aims to check the validity of the component type description, avoiding starting invalid factories.If you override this method, you should here set up the component description (e.g. : common properties, exported services, ...) and check the handler configuration. The parameters passed to this method are the ComponentTypeDescription and the component's Metadata (i.e. : the structure of the component type declaration).
- Once your handler has been initialized, iPOJO configures it for each created instance of the using components. The ComponentTypeDescription and the instance specific properties are passed to the configure() method of your handler.This method is mandatory so you have to implement it. Here you should check the handler configuration (if not already done in the initializeComponentFactory() method) and configure the handler with given instance specific properties.
- Then, iPOJO starts the handler, following the component instance lifecycle, by calling the start() method. You have to put in this method the activation code of your handler. A freshly started handler is by default in an active state (if all its used handlers, like required services, are in an active state).
- Once started, the handler state can be either in a valid or in an invalid state, depending on its used handlers (a handler is an iPOJO component, so it can depend on other handlers, like service dependencies, provided services, ... See the ìHandler extends Componentî section). The validity of your handler depends on used handlers status, but it also can be changed in your handler code by using the setValidity() method.
- Finally, when the component instance is stopped (generally just before being destroyed), the stop method of the handler is called. Place here the inactivation code of your handler.
Note : Keep in mind that the stop() method of your handler is called when the component instance is stopped (not necessarily destroyed). This instance can be restarted later, so the same instance of your handler must have to ability to restart too.
Your handler need to read how it is configured in the using component type description. The configuration is written in the metadata.xml of the using bundle, but is passed to the initializeComponentFactory() and configure() methods as an Element object.
The Element type (placed in the org.apache.felix.ipojo.metadata package), coupled with the Attribute type, is used to retrieve the structure and the content of the component configuration. The Element parameter, passed to the initialization and configuration methods, represents the root of the component type description (i.e. the root of the tree is the component XML tag).
Several methods allows to browse the entire configuration from the root Element :
- The getElement() methods let you access the content of an Element (i.e. the children elements)
- The getAttribute() methods allows you to access the attributes of an Element.
- The containsElement() and containsAttribute() methods test the presence of a child-element or an attribute in an Element.
Note : As described in the description section, a name and a namespace are associated to each handler. To safely retrieve the configuration of this handler from the component metadata, you can take inspiration from the following snippet (the componentMetadata variable is the component root Element passed to the initializeComponentFactory() and configure() methods) :
You will also need to read specific instance configuration (properties defined in the instance XML tag). The instance properties are directly passed, as a Dictionary, to the configure() method. With these properties, you can easily allow instances to override some component fixed configuration.
One of the most interesting features of an handler is the ability to interact with the component's POJO. Indeed, you can intercept method calls and returns, inject values in the POJO's fields...
The getPojoMetadata() method of the PrimitiveHandler class lets you access the structure of the POJO (represented by the PojoMetadata type) without having to use (slow) reflection. It allows you to list all fields and methods of the POJO, and get informations about implemented interfaces and the super-class. The PojoMetadata class implements the following operations :
- The getInterfaces() method returns the list of implemented interfaces, while the isInterfaceImplemented() methods test if a given interface is implemented by the POJO.
- The getSuperClass() method returns the name of the class extended by the POJO (or null instead of java.lang.Object).
- The getField() methods lets you access the fields of the POJO. The returned object is a FieldMetadata that provides informations about a particular field inside the POJO.
- The getMethod() methods lets you access the methods of the POJO. The returned object is a MethodMetadata that provides informations about a particular method in the POJO.
Once you've retrieved informations about the POJO structure, you can interact with it, via the InstanceManager, accessible in your handler by the getInstanceManager() method. It allows you to register interceptors, that are called before and after POJO method calls or field accesses.
Note : The InstanceManager manages the component instance attached to your handler instance. Thus, it can't be available in the initializeComponentFactory() because this method is run before the creation of any component instance.
You need to implement some of the following methods to intercept fields accesses :
- The void onSet(Object pojo, String fieldName, Object value) method: This method is called each time a field of the POJO is assigned. The first parameter is the instance of the concerned POJO, the second is the name of the accessed field and the third is the value assigned to the POJO's field. If the field type is a primitive type, this method receives the boxed object.
- The Object onGet(Object pojo, String fieldName, Object value) method : This method is called each time a field of the POJO is read. The first parameter is the instance of the concerned POJO, the second is the name of the accessed field and the third is the actual value of the POJO's field. If the field type is a primitive type, this method receives the boxed object. The returned object is the value the intercepted read process will return. It's the standard way to inject a value in the field : returning a specific object whatever the field really contains.
You need to implements some of the following methods to intercept methods accesses. When these methods are called, the first parameter is the POJO's instance on which the intercepted method is called and the second parameter contains the descriptor of the called method.
- The void onEntry(Object pojo, Method method, Object args) method: This method is called before the execution of an intercepted method. The third parameter is the list of parameters with which the method have been called. The method is executed just after the execution of the onEntry() callback.
- The void onExit(Object pojo, Method method, Object returnedObj) method: This method is called right after the successful execution of an intercepted method. The third parameter is the value returned by the method (or null if the method return type is void). This value must not be modified.
- The void onError(Object pojo, Method method, Throwable throwable) method: This method is called right after the unexpected return of an intercepted method (i.e. when an uncaught exception occurred). The third parameter is the thrown object that caused the method termination.
- The void onFinally(Object pojo, Method method) method: This method is called after the termination of an intercepted method (expected or not), after the call of the onExit() or onError() callback.
Warning : The InstanceManager has to know your handler wants to intercept fields or methods access, otherwise the implemented callbacks won't be called. Thus you need to register each field and method you want to intercept, so the InstanceManager will call the appropriated callbacks when the specified field or method is accessed :
Note : The PrimitiveHandler abstract class implements the FieldInterceptor and MethodInterceptor interfaces, which declares the methods described just above. You can create your own interceptor class (implementing one or both of these interfaces) and give it to the InstanceManager register method instead of the handler object itself.
Once your handler has been declared, you can use it in iPOJO components. To do so, you first have to be bound to your handler's namespace (using standard XML namespace declaration). Then you can configure the handler in your components type description. An example of bundle's metadata.xml declaring components using the handler is shown hereafter :
The remainder of this document describes two examples of handlers:
- A log handler logging messages in the OSGi Log Service
- A properties handler reading a property files to configure POJO field
This section describes how to create a simple handler. This handler logs a message in the OSGi Log Service (if present) when the component instance state changes. The code source of this handler is downloadable here.
The handler namespace is "org.apache.felix.ipojo.log.handler.LogHandler". It is also the name of the handler implementation class. You can note that the handler has an optional dependency on a OSGi log service. If no log services are found, a default implementation is used instead.
The handler needs to override following methods:
- configure : to parse the metadata and load the properties file
- stateChanged : to log messages when the instance state changes.
The handler is implemented inside the LogHandler class in the org.apache.felix.ipojo.handler.log package. This class extends the org.apache.felix.ipojo.PrimitiveHandler class.
The handler needs to be notified when component instances becomes valid or invalid, thus it implements the InstanceStateListener interface.
This method parses and checks the component type metadata. The handler needs a log element from its namespace. According to the result, the configure method can throw an exception or parse the level attribute (to get the logging level).
This method reads the component description and configures the handler. Then, the handler registers itself to the instance manager to be informed of the component's validity changes.
This method is called by the instance manager to notify that the component instance state changes. The handler needs to log a message containing the new state.
This handler needs to be packaged inside an iPOJO bundle. The bundle will import the org.apache.felix.ipojo, org.osgi.framework and org.osgi.service.log packages.
To use this handler, a component needs to declare an org.apache.felix.ipojo.log.handler.LogHandler:log XML element, with a level attribute. This level attribute's value can be "error", "warning" or "info". Here is an usage example:
The LogHandler is available here. The archive file contains the handler implementation and a simple component using this handler.
This section presents a second handler. This handler loads a property file containing field name and initial value. Then it injects and maintains these values inside POJO fields. In this example, only String values are managed.
You can find the sources of this example handler in the example/handler/property directory of the iPOJO sources.
This handler is always valid, so do not participate to the component instance lifecycle. Moreover, the handler does not need to be notified when the component instance state changed. But, it need to be notified when POJO fields need a value or change their value.
The handler needs to override following methods:
- configure : to parse the metadata and load the properties file
- stop : to store the properties
- onGet : to inject a values inside a field
- onSet : to obtain the new field value
The handler is implemented by the PropertiesHandler class present in the org.apache.felix.ipojo.properties.handler package. The class has several fields:
- The properties to maintain (m_properties)
- The properties file name (m_file)
Note: the file name is the absolute path on the local machine of the file.
This method begins by parsing the component type metadata. The handler needs a properties element from its namespace. According to the result, the configure method can return immediately or parse the file attribute (to get the properties file path). Then, it builds a field list (String array) to register to field notification. By registering with a field array, the handler will be a part of the component instance container and will be notified of field access.
The start method does nothing, but needs to be implemented.
The stop method stores properties inside the properties file.
The onGet method is called when the POJO need a field value. When called, the method needs to return the stored value.The onSet method is called when the POJO modifies a field value. If the new value if null, the handler will remove this properties from the property list.
This handler needs to be inside a bundle importing the org.apache.felix.ipojo packages and exporting the org.apache.felix.ipojo.properties.handler package.
To use this handler, a component need to declare an Properties XML element in the org.apache.felix.ipojo.properties.handler namespace, with a file attribute indicating the absolute file path of the properties file.
Note : you need to escape '\' (anti-slash characters) in the file path name.
The PropertiesHandler is available here. The archive file contains the handler implementation and a simple component using this handler.
iPOJO has the ability to reconfigure component instances while they are running. When instances are reconfigured, their used handler need to update their configuration (if they support such an operation).
To do so, reconfigurable handlers must override the reconfigure() method, which notify the concerned handlers of the new instance configuration (represented as a Dictionary).
Handlers have the possibility to describe their state, overriding the getDescription() method and the HandlerDescription class.
By default, only the handler's name and validity are displayed in component instance's description (informations displayed by the (arch -instance an.instance.name command). The standard way to add description to your handler is shown hereafter :
Your handle can also provide annotations. Annotations will allows users to configure the Handler from the source code (avoiding XML edition). iPOJO supports annotation of external handlers. Indeed, it detects annotations and re-creates the Element-Attribute structure.
So, first, external Handler annotations MUST follow some principles:
- The annotation package must be the Handler namespace
- The annotation name must be the Handler name
- The package must contain either the 'ipojo' or the 'handler' word.
So, when iPOJO detects the annotation, an Element is created with the annotation package as the Element namespace and the annotation name as the Element name.
Then, 'scalar' annotation attributes are mapped to Attribute. Sub-annotations (annotation attribute) are mapped to sub-elements. For example, the annotation for the property handler is:
This annotations is put on the class element, and allows setting the property file:
However, your handler can also provide several annotations to represent Element and sub-elements. Your annotations can also be placed on different code elements (Type, Field, Method). In this case, to recreate the Element/Sub-Element hierarchy, iPOJO processes as following:
- The first annotation of a package P is processed by creating the root Element (component sub-element).
- All others annotations of the package P are processed as sub-element of the previously created Element.
For example, the following code:
will be translated to:
Note: To customize this hierarchy, you can also use the id/parent annotation attributse. The id attribute is used to refer to an Element. An annotation with a parent (targeting an id) attribute will be processed as a sub-element of the Element identified by the given id.
In this document, we present how-to develop handler for your components. We describe two small examples : a log handler and a properties handler. These handlers are plugged on (primitive) instance. However, it is possible to extends CompositeHandler too to customize the composition model.
If you develop handler and you want to share it, feel free to contact us by sending a mail on the Felix mailing list.