Equinox Framework: A Happier OSGi R6 Implementation

Transcription

1 Equinox Framework: A Happier OSGi R6 Implementation Tom Watson IBM March 18 th 2014 OSGi Alliance Marketing Page. 1 All Rights Reserved

2 Agenda New to OSGi R6 Core Redesign Core Equinox and Why What Breaks? Page 2

3 OSGi R6 Core Finalizing specification in March 2014 Equinox Luna release will be the RI (June 2014) R6 Noteworthy Additions Service Scopes Data Transfer Objects Native Namespace Extension Bundle Activators WeavingHook Enhancements Page 3

4 OSGi R6 Core Service Scopes Identify the scope of a service object Bundles A B C Service Registry Page 4

5 OSGi R6 Core Service Scopes Identify the scope of a service object Singleton single instance used by all bundles Singleton object that implements the service contract service.scope = singleton Bundles A B C registers S singleton Service Registry Page 5

6 OSGi R6 Core Service Scopes Identify the scope of a service object Singleton single instance used by all bundles Each Bundle can get access to the singleton object via the registry Bundles A B C gets S singleton Service Registry Page 6

7 OSGi R6 Core Service Scopes Identify the scope of a service object Singleton single instance used by all bundles Each Bundle can get access to the singleton object via the registry Bundles A B C gets S singleton Service Registry Page 7

8 OSGi R6 Core Service Scopes Identify the scope of a service object Singleton single instance used by all bundles Bundle Service Factory used to create a service object for each bundle Bundles A B C registers Service Registry Page 8

9 OSGi R6 Core Service Scopes Identify the scope of a service object Singleton single instance used by all bundles ServiceFactory that creates one service instance for each bundle Bundle Service Factory used to create a service object for each bundle service.scope = bundle Bundles A B C registers SF bundle Service Registry Page 9

10 OSGi R6 Core Service Scopes Identify the scope of a service object Singleton single instance used by all bundles Each Bundle can get access to a bundle specific service object via the registry Bundle Service Factory used to create a service object for each bundle Bundles A B C gets SF bundle Service Registry Page 10

11 OSGi R6 Core Service Scopes Identify the scope of a service object B S 1 Singleton single instance used by all bundles Bundle Service Factory used to create a service object for each bundle Bundles A B C gets SF bundle Service Registry Page 11

12 OSGi R6 Core Service Scopes Identify the scope of a service object B S 1 Singleton single instance used by all bundles Bundle Service Factory used to create a service object for each bundle Bundles A B C gets SF bundle Service Registry Page 12

13 OSGi R6 Core Service Scopes Identify the scope of a service object B S 1 Singleton single instance used by all bundles C S 2 Bundle Service Factory used to create a service object for each bundle Bundles A B C gets SF bundle Service Registry Page 13

14 OSGi R6 Core Service Scopes Identify the scope of a service object Singleton single instance used by all bundles Bundle Service Factory used to create a service object for each bundle Prototype (new for R6) Prototype Service Factory used to create a service object for each request for the service Bundles A B C registers Service Registry Page 14

15 OSGi R6 Core Service Scopes Identify the scope of a service object Singleton single instance used by all bundles Bundle Service Factory used to create a service object for each bundle Prototype (new for R6) Prototype Service Factory used to create a service object for each request for the service service.scope = prototype Bundles A B C PrototypeServiceFactory That creates multiple service instances for each bundle registers PSF prototype Service Registry Page 15

16 OSGi R6 Core Service Scopes Identify the scope of a service object Singleton single instance used by all bundles Each Bundle can request a new instance of the service object via the registry Bundle Service Factory used to create a service object for each bundle Prototype (new for R6) Prototype Service Factory used to create a service object for each request for the service ServiceObjects.getService() Bundles A B C gets PSF prototype Service Registry Page 16

17 OSGi R6 Core Service Scopes Identify the scope of a service object B S 1 Singleton single instance used by all bundles Bundle Service Factory used to create a service object for each bundle Prototype (new for R6) Prototype Service Factory used to create a service object for each request for the service Bundles A B C gets PSF prototype Service Registry Page 17

18 OSGi R6 Core Service Scopes Identify the scope of a service object B S 1 Singleton single instance used by all bundles Bundle Service Factory used to create a service object for each bundle Prototype (new for R6) Prototype Service Factory used to create a service object for each request for the service Bundles A B C PSF prototype Service Registry Page 18

19 OSGi R6 Core Service Scopes Identify the scope of a service object B S 1 Singleton single instance used by all bundles Bundle Service Factory used to create a service object for each bundle Prototype (new for R6) Prototype Service Factory used to create a service object for each request for the service ServiceObjects.getService() Bundles A B C gets PSF prototype Service Registry Page 19

20 OSGi R6 Core Service Scopes Identify the scope of a service object B S 1 S 2... Singleton single instance used by all bundles Bundle Service Factory used to create a service object for each bundle Prototype (new for R6) Prototype Service Factory used to create a service object for each request for the service Bundles A B C gets PSF prototype Service Registry Page 20

21 OSGi R6 Core Service Scopes Identify the scope of a service object B S 1 S 2... Singleton single instance used by all bundles Bundle Service Factory used to create a service object for each bundle Prototype (new for R6) Prototype Service Factory used to create a service object for each request for the service ServiceObjects.getService() Bundles A B C gets PSF prototype Service Registry Page 21

22 OSGi R6 Core Service Scopes Identify the scope of a service object B S 1 S 2... Singleton single instance used by all bundles C S 3 Bundle Service Factory used to create a service object for each bundle Prototype (new for R6) Prototype Service Factory used to create a service object for each request for the service Bundles A B C gets PSF prototype Service Registry Page 22

23 OSGi R6 Core Service Scopes Identify the scope of a service object B S 1 S 2... Singleton single instance used by all bundles C S 3 Bundle Service Factory used to create a service object for each bundle Prototype (new for R6) Prototype Service Factory used to create a service object for each request for the service Bundles A B C PSF prototype Service Registry Page 23

24 OSGi R6 Core Service Scopes Identify the scope of a service object B S 1 S 2... Singleton single instance used by all bundles C S 3 Bundle Service Factory used to create a service object for each bundle Prototype (new for R6) Prototype Service Factory used to create a service object for each request for the service ServiceObjects.getService() Bundles A B C gets PSF prototype Service Registry Page 24

25 OSGi R6 Core Service Scopes Identify the scope of a service object B S 1 S 2... Singleton single instance used by all bundles C S 3 S 4... Bundle Service Factory used to create a service object for each bundle Prototype (new for R6) Prototype Service Factory used to create a service object for each request for the service Bundles A B C PSF prototype Service Registry Page 25

26 Data Transfer Objects An object that carries data between processes The motivation for its use has to do with the fact that communication between processes is usually done resorting to remote interfaces (e.g. web services), where each call is an expensive operation. Does not have any behavior except for storage and retrieval of its own data Page 26

27 OSGi R6 Core Data Transfer Objects DTOs represent the state of runtime objects Core Framework supplies a number of DTOs Easily serializable Only has public fields with limited types Must form a tree to simplify serialization Data contained is a snapshot of the state DTOs do not track state changes DTOs are not thread safe Page 27

28 OSGi R6 Core Obtaining Core DTOs Core Framework DTOs obtained via bundle adapt DTOType dto = bundle.adapt(dtotype.class) Page 28

29 OSGi R6 Core Obtaining Core DTOs Core Framework DTOs obtained via bundle adapt BundleDTO for a bundle: state, id, name, version. BundleDTO dto = bundle.adapt(bundledto.class) Page 29

30 OSGi R6 Core Obtaining Core DTOs Core Framework DTOs obtained via bundle adapt BundleDTO for a bundle: state, id, name, version. BundleRevisionDTO for a bundle revision: requirements, capabilities BundleRevisionDTO dto = bundle.adapt(bundlerevisiondto.class) BundleRevisionDTO[] dtos = bundle.adapt(bundlerevisiondto[].class) Page 30

31 OSGi R6 Core Obtaining Core DTOs Core Framework DTOs obtained via bundle adapt BundleDTO for a bundle: state, id, name, version. BundleRevisionDTO for a bundle revision: requirements, capabilities BundleWiringDTO for a bundle wiring: required and provided wires BundleWiringDTO dto = bundle.adapt(bundlewiringdto.class) BundleWiringDTO[] dtos = bundle.adapt(bundlewiringdto[].class) Page 31

32 OSGi R6 Core Obtaining Core DTOs Core Framework DTOs obtained via bundle adapt BundleDTO for a bundle: state, id, name, version. BundleRevisionDTO for a bundle revision: requirements, capabilities BundleWiringDTO for a bundle wiring: required and provided wires ServiceReferenceDTO for a registered service: properties, using bundles ServiceReferenceDTO[] dtos = bundle.adapt(servicereferencedto[].class) Page 32

33 OSGi R6 Core Obtaining Core DTOs Core Framework DTOs obtained via bundle adapt BundleDTO for a bundle: state, id, name, version. BundleRevisionDTO for a bundle revision: requirements, capabilities BundleWiringDTO for a bundle wiring: required and provided wires ServiceReferenceDTO for a registered service: properties, using bundles FrameworkDTO for the framework: list installed bundles, services, launch props FrameworkDTO dto = systembundle.adapt(frameworkdto.class) Page 33

34 OSGi R6 Core Obtaining Core DTOs Core Framework DTOs obtained via bundle adapt BundleDTO for a bundle: state, id, name, version. BundleRevisionDTO for a bundle revision: requirements, capabilities BundleWiringDTO for a bundle wiring: required and provided wires ServiceReferenceDTO for a registered service: properties, using bundles FrameworkDTO for the framework: list installed bundles, services, launch props BundleStartLevelDTO for a bundle start-level and start options BundleStartLevelDTO dto = bundle.adapt(bundlestartleveldto.class) Page 34

35 OSGi R6 Core Obtaining Core DTOs Core Framework DTOs obtained via bundle adapt BundleDTO for a bundle: state, id, name, version. BundleRevisionDTO for a bundle revision: requirements, capabilities BundleWiringDTO for a bundle wiring: required and provided wires ServiceReferenceDTO for a registered service: properties, using bundles FrameworkDTO for the framework: list installed bundles, services, launch props BundleStartLevelDTO for a bundle start-level and start options FrameworkStartLevelDTO for the framework start-level and initial bundle start-level FrameworkStartLevelDTO dto = systembundle.adapt(frameworkstartleveldto.class) Page 35

36 OSGi R6 Core Native Namespace Describes the native environment the framework is running Framework provides a capability in the osgi.native namespace Bundle-NativeCode headers are converted in to requirements in the osgi.native namespace Last requirement type in OSGi to be transformed into the generic requirements/capabilities model Page 36

37 OSGi R6 Core Extension Bundle Activators Allows system.bundle fragments to hook into the initialization and shutdown process of the framework Usecase involves scenarios that require hooks to be in place before any other bundles are resolved Equinox regions uses this to ensure the regions are established before any bundle resolution operations occur Page 37

38 OSGi R6 Core Weaving Hook Enhancements New WovenClassListener Listen to class weaving process to detect new dynamic imports Needed by isolation engines, such as subsystems, to provide access to imports added by WeavingHook implementations Package import permissions are auto-granted to Woven bundles for package imports added by a WeavingHook With security enabled a woven bundle may be prevented from wiring to a package required by a dynamic import added by a WeavingHook Page 38

39 Equinox Moving Forward Equinox Framework in need of a redesign One unhappy implementation Dependencies are modelled differently from the generic dependency model of the OSGi specification Requires adapting Equinox resolver types to OSGi wiring types Needed to call out to resolver and weaving hooks Hard to reason about locking strategy OSGi Resolver and Weaving Hooks introduced more callouts to user code Too many abstraction layers! Hard to prototype core OSGi changes for the reference implementation Dependency Resolution (e.g. Native Namespace) Creating DTO snapshots adaptor hooks Hook impls base adaptor resolver OSGI wiring Equinox Page 39

40 Equinox Redesign the Core Implement a core module container Container Page 40

41 Equinox Redesign the Core Implement a core module container Responsible for managing resources Container Page 41

42 Equinox Redesign the Core Implement a core module container Responsible for managing resources Lifecycle Container Page 42

43 Equinox Redesign the Core Implement a core module container Responsible for managing resources Lifecycle Metadata Capabilities and Requirements Container Page 43

44 Equinox Redesign the Core Implement a core module container Responsible for managing resources Lifecycle Metadata Capabilities and Requirements Resolution Container Page 44

45 Equinox Redesign the Core Implement a core module container Container Responsible for managing resources Lifecycle Metadata Capabilities and Requirements Resolution Persistent settings Database Page 45

46 Equinox Redesign the Core Implement a core module container Container Responsible for managing resources Lifecycle Metadata Capabilities and Requirements Resolution Persistent settings Uses an OSGi R5 Resolver service Currently Apache Felix Resolver Database Page 46

47 Equinox Redesign the Core Implement a core module container Container Responsible for managing resources Lifecycle Metadata Capabilities and Requirements Resolution Persistent settings Uses an OSGi R5 Resolver service Currently Apache Felix Concurrency in mind from the start Properly handle call outs (hooks) while holding no locks Tools may use it for modelling OSGi wiring (PDE) Resolver Database Page 47

48 Equinox Redesign the Core Implement a core module container Responsible for managing resources Lifecycle Metadata Capabilities and Requirements Resolution Persistent settings Uses an OSGi R5 Resolver service Currently Apache Felix Concurrency in mind from the start Properly handle call outs (hooks) while holding no locks Tools may use it for modeling OSGi wiring (PDE) Does not deal with bundle content, class loading, service registry, event listeners, security Happy Container bundle content class loading service registry event listeners security Page 48

49 Equinox Redesign the Framework Happy Container bundle content class loading service registry event listeners security I care about that big X Unhappy Equinox Page 49

50 Equinox Redesign the Framework Uses the container as the core Keeps complicated concurrency concerns in one place Uses reentrant read/write lock for the module 'database' For long running operations optimistic locking is used. For example, resolution. Container Page 50

51 Equinox Redesign the Framework Uses the container as the core Keeps complicated concurrency concerns in one place Uses reentrant read/write lock for the module 'database' For long running operations optimistic locking is used. For example, resolution. Implements Framework bits outside of the container Bundle content Class loading Service registry Event listeners Security bundle content class loading service registry event listeners Container security Happy Equinox Page 51

52 Equinox Configuration Don't access config statically Get rid of static class FrameworkProperties Instead make available an instance of EquinoxConfiguration Greatly simplifies and optimizes embedding and starting multiple Framework instances A special class loader was needed to isolate static config data for each framework instance bundle content class loading service registry event listeners Container security configuration config.ini Happy Equinox Page 52

53 Equinox Hooks Equinox Hooks are still supported Much of the internal details changed requiring an overhaul of the Equinox Hooks SPI ALL existing Equinox Hook implementers are broken and will need migration Unhappy Equinox had too many Hooks Three class loading hooks now one, but no ability to override bundle class loader implementation Bundle File hook removed, use wrapper hook instead Adaptor hook removed, no more adaptor Bundle Watcher removed, was a glorified bundle listener Added ability to specify a bundle activator that is called during framework start/stop Improved Storage Hook to handle hooks being added/removed better bundle content class loading service registry event listeners Container security configuration Hook impls config.ini Happy Equinox Page 53

54 Equinox Old State/Resolver Equinox Container has no implementation of old Equinox resolver API Still exports the Equinox resolver API Happy Equinox No longer registers the PlatformAdmin service Container Page 54

55 Equinox Old State/Resolver Equinox Container has no implementation of old Equinox resolver API Still exports the Equinox resolver API Happy Equinox No longer registers the PlatformAdmin service Equinox Compatibility fragment Hooks into Equinox to register a PlatformAdmin implementation Attempts to mirror the Equinox wiring state in the PlatformAdmin implementation Has some limitations modeling the running state Useful for offline modeling, for example: PDE Container PlatformAdmin Disgruntled Fragment Page 55

56 Equinox Plugin Converter Equinox Container has no implementation of the Plugin Converter Support for Eclipse 2.0 style plugins Happy Equinox Still exports the plugin converter API No longer registers the PluginConverter service Container Page 56

57 Equinox Old State/Resolver Equinox Container has no implementation of the Plugin Converter Support for Eclipse 2.0 style plugins Happy Equinox Still exports the plugin converter API No longer registers the PluginConverter service Equinox Compatibility fragment Hooks into Equinox to register a PluginConverter implementation Converts Eclipse 2.0 style plugins into proper bundles Container PluginConverter Disgruntled Fragment Page 57

58 Equinox What Breaks? All Equinox Framework Hook implementations must be migrated Happy Equinox Some limitations for the compatibility resolver Disconnected from the running wiring state Cannot be used to diagnose resolution errors Cannot be used to disable bundles at runtime Container PlatformAdmin Disgruntled Fragment Page 58

59 Equinox Current Status Work is being done in the git master branch Implementation has been in Luna since M1 Fully compliant with the current suite of compliance tests for OSGi R6 Will be the reference implementation of the Core Framework for R6 Successful if nobody notices Except for the poor Equinox Adaptor Hook implementors Page 59

60 Evaluate This Session 1 Sign-in: 2 Select session from schedule 3 Evaluate:

61 Trademarks IBM and WebSphere are trademarks or registered trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at Copyright and trademark information at Page 61