Extending the liberty profile

Transcription

1 Extending the liberty profile Dr Alex Mulholland, Senior Technical Staff Member IBM IBM Corporation

2 Content Overview of product extensions what, where, why? Features What they are Creating a simple feature WABs Advanced features Rich configuration Composing with services Including native code Liberty SPI Development tools Packaging choices IBM Corporation

3 What is a liberty product extension? A set of directories and files with similar layout to liberty product. but installed in a separate location Can contain same artifacts as liberty product features for runtime capability scripts for CLI server templates API and SPI jars for dev build Allows complete integration of third-party function into the liberty runtime and tools Made known to liberty by a properties file (id, location) in wlp/etc/extensions Built-in user extension supported for development convenience IBM Corporation

4 Install options for product extensions supergui/bin supergui/readme.txt supergui/wlp-ext /lib/features supergui feature wlp/etc/extensions supergui.properties Supergui install appservices.properties wlp/usr/extension /lib/features user feature 1 user feature 2 Liberty Profile install app-ext-services/libertyext /lib/features appservice1 feature appservice2 feature appservice3 feature App Services install IBM Corporation

5 Why create product extensions? Features can. be installed and managed separately from applications be extremely lightweight with no application container dependencies receive user-specified configuration from the server.xml file expose configuration settings in liberty development tools easily expose classes and services to features and applications provide plugins to the runtime (eg. CUR, TAI) access liberty SPI allowing deeper integration with the runtime augment existing programming models package native libraries for multiple platforms IBM Corporation

6 Features overview features are the key concept for server composability A server with no features is the liberty kernel <server/> Kernel is reusable for different types of process small agents any managed process eg WXS Users specify features to add useful function to kernel <server> <featuremanager> <servlet-3.0> </featuremanager> </server> IBM Corporation

7 Feature internals From the liberty kernel perspective, a feature consists of: a feature definition (manifest) <name>.mf in /lib/features one or more osgi bundles (jars) as specified by feature manifest Subsystem-SymbolicName: example-1.0;visibility:=public Subsystem-Content: com.example.bundle1;version="1.0.0 Qualify with product extension id in server.xml <feature>usr:example-1.0</feature> <feature>bpm:sca-1.2</feature> IBM Corporation

8 Features are self-contained Subsystem-Content can include: bundles to load at runtime Ø com.ibm.ws.session; version="[1, ) other features to load at runtime Ø com.ibm.websphere.appserver.httptransport-1.0; type="osgi.subsystem.feature" any other files to install (on disk) as part of the feature Ø scripts Ø API jars and javadoc Ø server templates Automatic features aid composability User configures feature1 & feature2, feature3 is automatically loaded IBM-Provision-Capability: osgi.identity; filter:="(&(type=osgi.subsystem.feature)(osgi.identity=feature1))", osgi.identity; filter:="(&(type=osgi.subsystem.feature)(osgi.identity=feature2))" IBM Corporation

9 Feature visibility Feature manifest header: Subsystem-SymbolicName: example-1.0; visibility:=public public feature can be listed in server.xml appears in generated featurelist (thus in development tools etc) can be included in any other feature protected can be included in any other feature private (default) can be included in other features in the same product extension only IBM Corporation

10 API Packages Feature manifest header: IBM-API-Package: com.example.publicapi;type="api Visible to all applications subject to api type: api, spec, ibm-api packages are visible to applications by default third-party made visible through application classloader config in server.xml: <classloader apitypevisibility= api,third-party"/> Visible to all features (NOT subject to api type) Put API jars/bundles into /dev directory of product extension convenience for application developers to compile automatically added to app classpath in dev tools IBM Corporation

11 SPI Packages Feature manifest header: IBM-SPI-Package: com.example.spi.utils, com.example.spi.spiservices Not visible to applications Visible to all features Put SPI jars/bundles into /dev directory of product extension convenience for feature developers to compile automatically added to liberty feature classpath in dev tools IBM Corporation

12 A simple feature Simple lifecycle: implement BundleActivator Bundle manifest header: Ø Bundle-Activator: org.mystuff.myactivatorclass Activator class: Ø org.osgi.framework.bundleactivator.start() and stop() Ø invoked by OSGi framework Configuration injection: implement ManagedService Register your class in start() method Ø context.registerservice(managedservice.class, this, properties) Ø properties include unique identifier eg myservice Put configuration properties in server.xml Ø <myservice mykey= myvalue1 /> ManagedService class: Ø org.osgi.service.cm.managedservice.updated() method is invoked when configuration is updated Ø passed a Dictionary of properties mykey=myvalue IBM Corporation

13 Using a Web Application Bundle (WAB) to provide an endpoint Users access as a web application WAR with an OSGi manifest header Web-ContextPath: /cachemonitor Still feature code, not an application Access to SPI Separately configurable security include feature: Ø com.ibm.wsspi.appserver.webbundlesecurity-1.0 bundle manifest header: Ø IBM-Authorization-Roles: cachemonitor.roles Server.xml entry: <authorization-roles id= cachemonitor.roles"> <security-role name="testrole"> <group name="bob" access-id="group:samplerealm/group1" /> </security-role> </authorization-roles> IBM Corporation

14 Advanced configuration Put OSGi Metatype definition in your bundle XML file that described your configuration attributes Provide a useful set of default values Ø so user configuration remains minimal sparse Will include your config in generated schema used by dev tools, UIs etc Can provide translated strings for names, labels, descriptions Use Liberty extensions to Metatype Allow simple nesting of elements Provide information to tools, GUIs for enhanced display Ø group, location Enhanced runtime handling of special attributes Ø password (not traced) IBM Corporation

15 Compose advanced features using services Service registration and lifecycle management service reference available to resolve dependencies implementation classes not loaded until service reference is used Dependency injection service activation is ordered based on dependencies Configuration updates services can be reactivated when properties change Declare through XML in bundle Put XML file name in bundle manifest header Service-Component: OSGI-INF/HelloService.xml <component name="helloservice"> <implementation class="com.example.bundle.hellocomponent"/> <service> <provide interface="com.example.helloservice"/> </service> </component> IBM Corporation

16 Packaging native code in an OSGi bundle Package native libraries for all platforms inside your bundle Use the Bundle-NativeCode header in the bundle manifest Bundle-NativeCode: lib/win32/x86/name.dll; osname=win32; processor=x86, lib/macosx/libname.dylib; osname=macosx; processor=x86; processor=x86_64, Call System.loadLibrary( name ) in your java code OSGi will load the correct native library for the runtime being used Some limitations: Native library can only be loaded by one OSGi bundle (one java classloader) Dependencies between native libraries are not handled IBM Corporation

17 What s in the Liberty SPI? Plug-points you can implement as features Custom User Registry Trust Association Interceptor Cache Provider Webcontainer Extension Services you can use File Monitor Application container services Classloaders Publish information to Atlas repository Metatype helpers for processing advanced configuration Location service to access local resources Tr and FFDC Supported instrumentation Entry & exit trace Timed operations IBM Corporation

18 Development tools support feature development Liberty Feature new project type include OSGi Bundle projects design view for feature manifest install to liberty runtime export as.esa IBM Corporation

19 Packaging your features or embedded product Subsystem Archive (.esa) package containing a feature manifest and content output by WDT Liberty Feature project install to liberty using featuremanager command featuremanager install my_feature.esa --to=my_extension Embedded server server package command creates an archive containing: Ø liberty runtime Ø server configuration Ø applications, resources new minify option packages only the features used by the server server package myserver --archive="small.zip" --include=minify example: servlet support in 17MB IBM Corporation

20 Summary Install into your own extension location supergui/bin supergui/readme.txt supergui/wlp-ext /lib/features supergui feature wlp/etc/extensions supergui.properties Supergui install appservices.properties wlp/usr/extension /lib/features user feature 1 user feature 2 Liberty Profile install app-ext-services/libertyext /lib/features appservice1 feature appservice2 feature appservice3 feature App Services install IBM Corporation

21 Summary Install into your own extension location <server> <featuremanager> <feature>acme:userconsole</feature> </featuremanager> </server> Manage as runtime feature, not application IBM Corporation

22 Summary Install into your own extension location <server> <featuremanager> <feature>acme:userconsole</feature> </featuremanager> <acme:consolecolor> <text= blue /> <logo= green /> </acme:consolecolor> </server> Manage as runtime feature, not application Integrate with server configuration IBM Corporation

23 Summary Install into your own extension location Manage as runtime feature, not application Integrate with server configuration Expose API, services and http endpoints IBM Corporation

24 Summary implements BundleActivator, ManagedService start() stop() updated() Service1 activate() modified() deactivate() Service 2 activate() modified() deactivate() Service 3 activate() modified() deactivate() Install into your own extension location Manage as runtime feature, not application Integrate with server configuration Start simple, evolve into rich solution Expose API, services and http endpoints IBM Corporation

25 Summary Install into your own extension location Bundle-NativeCode: lib/win32/x86/name.dll; osname=win32; processor=x86, lib/macosx/libname.dylib; osname=macosx; processor=x86; processor=x86_64, Manage as runtime feature, not application OSGi management of native libraries Integrate with server configuration Start simple, evolve into rich solution Expose API, services and http endpoints IBM Corporation

26 Summary implements FileMonitor onchange(){ // react to file changes } /usr/acmefiles Install into your own extension location Access to powerful product SPI Manage as runtime feature, not application OSGi management of native libraries Integrate with server configuration Start simple, evolve into rich solution Expose API, services and http endpoints IBM Corporation

27 Summary Tools support for feature development Install into your own extension location Access to powerful product SPI Manage as runtime feature, not application OSGi management of native libraries Integrate with server configuration Start simple, evolve into rich solution Expose API, services and http endpoints IBM Corporation

28 Summary Package as feature or embedded server Tools support for feature development Acme.esa Install into your own extension location Access to powerful product SPI Manage as runtime feature, not application OSGi management of native libraries Acme.zip Integrate with server configuration Start simple, evolve into rich solution Expose API, services and http endpoints IBM Corporation

29 Summary Package as feature or embedded server Tools support for feature development Install into your own extension location Access to powerful product SPI Liberty Product Extension Manage as runtime feature, not application OSGi management of native libraries Integrate with server configuration Start simple, evolve into rich solution Expose API, services and http endpoints IBM Corporation

30 IBM Corporation

31 Legal Disclaimer IBM Corporation All Rights Reserved. The information contained in this publication is provided for informational purposes only. While efforts were made to verify the completeness and accuracy of the information contained in this publication, it is provided AS IS without warranty of any kind, express or implied. In addition, this information is based on IBM s current product plans and strategy, which are subject to change by IBM without notice. IBM shall not be responsible for any damages arising out of the use of, or otherwise related to, this publication or any other materials. Nothing contained in this publication is intended to, nor shall have the effect of, creating any warranties or representations from IBM or its suppliers or licensors, or altering the terms and conditions of the applicable license agreement governing the use of IBM software. References in this presentation to IBM products, programs, or services do not imply that they will be available in all countries in which IBM operates. Product release dates and/or capabilities referenced in this presentation may change at any time at IBM s sole discretion based on market opportunities or other factors, and are not intended to be a commitment to future product or feature availability in any way. Nothing contained in these materials is intended to, nor shall have the effect of, stating or implying that any activities undertaken by you will result in any specific sales, revenue growth or other results. If the text contains performance statistics or references to benchmarks, insert the following language; otherwise delete: Performance is based on measurements and projections using standard IBM benchmarks in a controlled environment. The actual throughput or performance that any user will experience will vary depending upon many factors, including considerations such as the amount of multiprogramming in the user's job stream, the I/O configuration, the storage configuration, and the workload processed. Therefore, no assurance can be given that an individual user will achieve results similar to those stated here. If the text includes any customer examples, please confirm we have prior written approval from such customer and insert the following language; otherwise delete: All customer examples described are presented as illustrations of how those customers have used IBM products and the results they may have achieved. Actual environmental costs and performance characteristics may vary by customer. Please review text for proper trademark attribution of IBM products. At first use, each product name must be the full name and include appropriate trademark symbols (e.g., IBM Lotus Sametime Unyte ). Subsequent references can drop IBM but should include the proper branding (e.g., Lotus Sametime Gateway, or WebSphere Application Server). Please refer to for guidance on which trademarks require the or symbol. Do not use abbreviations for IBM product names in your presentation. All product names must be used as adjectives rather than nouns. Please list all of the trademarks that you use in your presentation as follows; delete any not included in your presentation. IBM, the IBM logo, Lotus, Lotus Notes, Notes, Domino, Quickr, Sametime, WebSphere, UC2, PartnerWorld and Lotusphere are trademarks of International Business Machines Corporation in the United States, other countries, or both. Unyte is a trademark of WebDialogs, Inc., in the United States, other countries, or both. If you reference Adobe in the text, please mark the first use and include the following; otherwise delete: Adobe, the Adobe logo, PostScript, and the PostScript logo are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States, and/or other countries. If you reference Java in the text, please mark the first use and include the following; otherwise delete: Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both. If you reference Microsoft and/or Windows in the text, please mark the first use and include the following, as applicable; otherwise delete: Microsoft and Windows are trademarks of Microsoft Corporation in the United States, other countries, or both. If you reference Intel and/or any of the following Intel products in the text, please mark the first use and include those that you use as follows; otherwise delete: Intel, Intel Centrino, Celeron, Intel Xeon, Intel SpeedStep, Itanium, and Pentium are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other countries. If you reference UNIX in the text, please mark the first use and include the following; otherwise delete: UNIX is a registered trademark of The Open Group in the United States and other countries. If you reference Linux in your presentation, please mark the first use and include the following; otherwise delete: Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both. Other company, product, or service names may be trademarks or service marks of others. If the text/graphics include screenshots, no actual IBM employee names may be used (even your own), if your screenshots include fictitious company names (e.g., Renovations, Zeta Bank, Acme) please update and insert the following; otherwise delete: All references to [insert fictitious company name] refer to a fictitious company and are used for illustration purposes only IBM Corporation

32 Additional material IBM Corporation

33 What other design principles would benefit my extension? Allow the user to compose their server no profile augmentation wrap server create with your own server template to give useful defaults All configuration is in server.xml Automatic parsing & injection of updates Generated schema for use by tools/guis Users can determine content/structure/sharing of included files to suit their needs Keep it small & fast Late and lazy activation (DS can help) Short dependency stacks Dynamic behavior features restart independent of server and each other components react dynamically to configuration updates IBM Corporation

34 What other design principles would benefit my extension? (2/2) Monitoring and runtime operations are exposed through JMX MXBeans or Open Mbeans avoid client-side library dependencies Simple migration No migration required (or provided) for configuration Ø No exceptions: all configuration remains backward compatible Longer toleration of java versions Strict separation of product/user and internals/externals A given feature will only evolve in a backward-compatible way versions on features provides a way to handle incompatibilities in public spec upgrades IBM Corporation

35 What is public / can I rely on being in the next release? The application programming interfaces (APIs) and system programming interfaces (SPIs) defined by the content of the jars in the $ {wlp.install.dir}/dev directories. The application class loader has visibility to the API that is provided by the features in your server configuration. Product extension features have visibility to all API and SPI that is provided by the features in your server configuration. Compile your code against the JAR files in the ${wlp.install.dir}/dev directories. The server configuration, including public and protected features. Commands, scripts and archives in the ${wlp.install.dir}/bin directory and subdirectories Client utilities in the ${wlp.install.dir}/clients directory and subdirectories IBM Corporation

36 What is subject to change and not supported for direct use? The names of product binary jars, for example those in the $ {wlp.install.dir}/dev directory. Compile your code against these JAR files by using the tools or the javac -extdirs option Direct use of the product binaries in the ${wlp.install.dir}/lib directory. The only JAR files that can be directly invoked are in the $ {wlp.install.dir}/bin/tools directory. Message texts that are output by the server at run time. The layout of the product installation, other than the ${wlp.install.dir}/bin, ${wlp.install.dir}/clients and ${wlp.install.dir}/dev directories. Examples and template files in the ${wlp.install.dir}/templates directory. These files might be modified when you apply service to your installation. Private or third party Java packages that are not explicitly exposed as APIs. These are not visible to the application class loader at run time IBM Corporation

37 Warning about use of third-party content Third-party APIs might change over time without consideration to backward compatibility. These are Java packages that are considered part of the implementation of features developed in open source communities and delivered as part of the Liberty profile. Third-party APIs are not visible to applications by default; Java EE applications with a classloader configuration that explicitly allows third-party access will have visibility to those packages on the application class loader, and OSGi applications must explicitly import the packages. Consider the impact of incompatible changes before deciding to use third-party APIs. Safer option: ship and control your own copy IBM Corporation

38 Highly composable runtime based on features WAS Extensions Java EE support <feature>servlet-3.0</feature> <feature>jsf-2.0</feature> <feature>appsecurity-1.0</feature> runtime services config model webcontainer http app mgr osgi services jsf jsp app sec webcontainer http app mgr osgi services Traditional WAS profile Liberty profile IBM Corporation

39 Liberty feature set z/os ND Base, Express zoswlm zossecurity zostran Liberty Core controller clustermem jmssecurity wssecurity jaxb jaxws mongodb jmsserver jmsclient wmqclient mdb ldapreg oauth collectmem zoswlm zossecurity zostran cdi ejblite mgdbean webcache monitor localconn restconn monitor localconn restconn jndi appsecurity ssl sessiondb jndi appsecurity ssl sessiondb wab blueprint jaxrs wab blueprint jaxrs beanval json jpa jdbc beanval json jpa jdbc servlet jsp jsf servlet jsp jsf kernel kernel WAS WAS IBM Corporation

40 Product structure: strict separation of product and user files /wlp /bin /clients /dev /lafiles /lib /templates Product files the only ones modified by service. May be read-only for operation IBM Corporation

41 Product structure /wlp /bin /clients /dev /etc /lafiles /lib /templates /usr /shared /config /servers /<server-name> /apps /server.xml User files never modified by product service. May be read only for operation. WLP_USER_DIR IBM Corporation

42 Product structure /wlp /bin /clients /dev /etc /lafiles /lib /templates /usr /shared /config /servers /<server-name> /apps /logs /server.xml /workarea Server output location never modified by product service. Must be read/write for operation. WLP_OUTPUT_DIR IBM Corporation