Extending SCR Annotations Excerpt: How add new Annotations extending the base Annotations :: Apache Felix
Home
Subprojects
Dependency Manager
Event Admin
File Install
Framework
Gogo Shell
Health Checks
Inventory
Log
Logback
Maven bundle plugin
Maven SCR plugin
Metatype Service
Preferences Service
Remote Shell
Script console plugin
Lightweight shell
Shell TUI
Web Console
Downloads
Documentation
Documentation
Downloads
Getting Started
News
Community
Apache Felix Project Info
Contributing
Projects Using Felix
Development
Coding Standards
DEPENDENCIES file template
Provisional OSGi API Policy
Release Management
Site How To
Using the OSGi Compliance Tests
FAQS
Apache Felix Bundle Plugin Frequently Asked Questions
Apache Felix SCR Plugin Frequently Asked Questions
Subprojects
Apache Felix Dependency Manager
Guides
Apache Felix Dependency Manager - Migrating from earlier versions
Dependency Manager - Annotations
Dependency Manager - Background
Dependency Manager - Bundles and Dependencies
Dependency Manager - Design Patterns
Dependency Manager - Development
Dependency Manager - History
Dependency Manager - JavaDocs
Dependency Manager - Migrating from other solutions.
Dependency Manager - Performance Tuning
Dependency Manager - Resource adapters
Dependency Manager - What’s new in version 4?
Dependency Manager Lambda
What’s New in R15
Reference
Dependency Manager - Adapter
Dependency Manager - Aspect
Dependency Manager - Bundle Adapter
Dependency Manager - Bundle Dependency
Dependency Manager - Components
Dependency Manager - Configuration Dependency
Dependency Manager - Dependencies
Dependency Manager - External Links
Dependency Manager - Factory Configuration Adapter Service
Dependency Manager - Resource Adapter
Dependency Manager - Resource Dependency
Dependency Manager - Service Dependency
Dependency Manager - Service Scopes
Dependency Manager - Singleton Component
Dependency Manager - Thread Model
Dependency Manager Annotations
Tutorials
Dependency Manager - Annotations
Dependency Manager - Getting Started
Dependency Manager - Leveraging the shell
Dependency Manager sample projects
Apache Felix Event Admin
Apache Felix File Install
Apache Felix Framework
Apache Felix Framework Bundle Cache
Apache Felix Framework Configuration Properties
Apache Felix Framework Frequently Asked Questions
Apache Felix Framework Launching and Embedding
Apache Felix Framework Usage Documentation
Apache Felix Framework Security
Apache Felix Gogo
RFC 147 Overview
Apache Felix Health Checks
Apache Felix Inventory Printer
Apache Felix Log
Apache Felix Logback
Apache Felix Maven Bundle Plugin (BND)
Apache Felix Metatype Service
Apache Felix OSGi Bundle Repository (OBR)
Apache Felix Preferences Service
Apache Felix Remote Shell
Apache Felix Shell
Apache Felix Shell TUI
Apache Felix Web Console
Extending the Apache Felix Web Console
Web Console RESTful API
Web Console Security Provider
Extensions
Branding the Web Console
Providing Resources
Providing Web Console Plugins
Web Console Logging
Web Console Output Templating
Tutorials
Apache Felix Application Demonstration
Apache Felix OSGi Tutorial
OSGi Frequently Asked Questions
OSGI Tutorial
Apache Felix Tutorial Example 1 - Service Event Listener Bundle
Apache Felix Tutorial Example 2
Apache Felix Tutorial Example 2b
Apache Felix Tutorial Example 3
Apache Felix Tutorial Example 4
Apache Felix Tutorial Example 5
Example 6 - Spell Checker Service Bundle
Example 7 - Spell Checker Client Bundle
Example 8 - Spell Checker Service using Service Binder
Example 9 - Spell Checker Service using Declarative Services
Apache License 2.0
Site map
Documentation
master
Documentation
master
Documentation
Extending SCR Annotations Excerpt: How add new Annotations extending the base Annotations
Edit this Page
Extending SCR Annotations Excerpt: How add new Annotations extending the base Annotations
The Apache Felix SCR Tooling is not supported anymore. Please use the official OSGi annotations and bnd based tooling instead.
This page documents functionality available with the SCR Generator 1.0.0 release providing the declaration file generation mechanism for the Maven SCR Plugin 1.6.0 (and newer) and the SCR Ant Task 1.0.0 (and newer).
The SCR Annotations library has been updated in version 1.4.0 to comply with the rules described here.
As such this library may be used as basis to learn more about providing pluggbale Java 5 annotations for the Maven SCR Plugin and SCR Ant Task.
The source code for the SCR Annotations library is available from the Apache Felix SVN repository at annotations.
This page outlines the required steps to implement your own extended Java 5 annotations:
Define the Annotations
Define an AnnotationTagProvider
Register the AnnotationsTagProvider
It is interesting to note, that the SCR Annotations 1.4.0 library providing the default and Sling Java 5 tags for the SCR Generator by itself is already implemented according to the rules outlined herein.
This means, that actually the SCR Generator does not have any built-in annotations but only provides the framework to allow for the definition of Java 5 Annotations.
Define the Annotations
To start with you will define Java 5 Annotations to suit your application needs.
The org.apache.felix.scr.annotations.sling package provides three sample annotations:
SlingServlet — used to declare a javax.servlet.Servlet service component with the appropriate service registration properties to configure the service as an Apache Sling Servlet.
SlingFilter — used to declare a javax.servlet.Filter service component with the appropriate service registration properties to configure the service as a Filter used by the Apache Sling Main Servlet.
SlingFilterScope — helper annotation to define the filter.scope service registration property for Filters defined with the SlingFilter annotation.
These annotations will be used to annotate classes for use with Declarative Services.
It is suggested to maintain the annotations in a separate package or even in a separate module that your projects may depend upon.
Define an AnnotationProcessor
The AnnotationProcessor interface defines the interface of a helper class which is used to convert Java 5 Annotation data into internal data structures to be then used as the basis for the generation of the descriptor files.
Implementations of this interface are provided with the ScannedClass instances and are expected to augment the provided ClassDescription.
The SlingAnnotationProcessor class implements the AnnotationProcessorto handle the Sling annotations described above.
Register the AnnotationProcessor
To finally make the AnnotationProcessor implementations available to the SCR Generator (and thus the Maven SCR Plugin and/or SCR Ant Task) the fully qualified class names of these implementations must be listed in an META-INF/services/org.apache.felix.scrplugin.annotations.AnnotationProcessor file in the library providing the annotations.
The classes listed in this file will automatically be picked up by the SCR Generator from the library placed on the build class path and thus enable support for the respective annotations.
Again, refer to the actual implementation in the SCR Annotations library referred to above.
Content licensed under AL2. UI licensed under MPL-2.0 with extensions licensed under AL2