Skip to main content

Some useful OSGI commands to dig in to issues with deployed bundles deployed in WSO2 products

WSO2 Products developed on top of the core WSO2 Carbon platform.WSO2 Carbon is a componentized Service Oriented Platform(SOA) which is built on OSGI framework,which defines a dynamic component system for Java.Bundle is the unit of modularization in OSGI. 
If I described on how a WSO2 product is created ,first there are a set of components introduced and implemented as OSGI bundles.You can find such developed set of components from here.Then we group a set of components as a feature.And there are such pre-defined features which can be found from here.Then with selecting a relevant set of features,the product have been built.For example this pom.xml under the svn location contains the features set used by the product WSO2 API Manager product.And most importantly,one more advantage of this approach is at later time,product can be customize by adding more  features from wso2 feature manager at runtime.

The main focus of this blog post is to guide on some OSGi level commands that would help to identify issues,when a user tries to deploy an OSGI bundle into a WSO2 product. Most common error the developers are facing,is CNF [Class Not Found] error-Though the OSGI bundle deployed to product,the classes exposing from that particular bundle is not available to OSGI runtime and thus CNF will be thrown.

For such instances,following steps will help you to identify the root-cause of the issue. 
  1. First start the server with  enabling OSGI console available- ./wso2server.sh -DosgiConsole
  2. Then list the available bundles of the server by trying the OSGI command  -  "ss package_name_of_bundle". For get list of commands try the command 'help'.
  3. You'll notice particular bundle will be in 'INSTALLED' state according to OSGI life-cycle.[Not in 'ACTIVE' state]
  4. Try diagnosing the particular bundle with the command "diag bundle_id" [Here bundle_id is the id retrieved for the bundle from above 2nd step]
  5. Once you tried,above you'll see about the un-satisfied  constraints on the specific bundle.In other word,that particular bundle has not become as an active bundle,due to an unsatisfied dependency which is referring from the bundle.
  6. Most of the time,the unsatisfied constraint is a dependency which is imported by the spefic bundle,but from no where else that dependency has export to OSGI runtime,thus unable to find that dependency available in runtime to import and use with the bundle.You can check this by the command 'p packageNameOfUnsatisfiedDependency'.This command will list  the places where the dependency imported and exported.
  7. If the result of above 6,is like no entry about exported places,then we need to add that dependency to OSGI runtime by exporting it from same bundle or from a separate bundle. Or if the package name of that dependency is available as a public JDK package,then you can export it via System bundle by adding an entry for the package name of the dependency to launch.ini file [which can be found from {Product_Home}/repository/conf/etc]

Comments

Popular posts from this blog

Passing end-user details from client to real backend endpoint via JWT token

In real-world business system,WSO2 API Manager useful on exposing company APIs, in a secured and controlled manner with the features provided by APIManager as; OAuth support [To secure API invocations] Throttling support [To control API invocations] Monitoring support [To track API usage] More technically what happening is when a user sends a particular API request,it will goes to WSO2 APIManager node and from there,the request will route to the real implemented back-end endpoint of the particular API and get back the response and returned it to the API invoked user. There can be a use-case,that this back-end endpoint may expect the details of API invoked user as to pass those details to some internal company usage  as; Additional authentication/authorization Track usage data from an internal system. So how to support above requirement from WSO2 AM. There comes the use of JSON Web Token[JWT] implementation done inside WSO2 AM. JWT is a means of representing claims to...

How to rollback/commit processing messages from WSO2 ESB when enabled JMS transaction

This blog post describes the below use-case where WSO2 ESB 4.6.0 act as the intermediate channel in-between two JMS queues. The Use-case First messages will be de-queue to a proxy service deployed in WSO2 ESB from an queue in ActiveMQ message broker. Then inside ESB,the incoming messages will undergo with some message mediation flow and then the message will be send to another JMS queue deployed in JBoss server. Inside the ESB,following failures could be happen;            a) Failures during message mediation process failure inside ESB [for example if you                use   dbreportmediator/lookup mediator inside mediation flow,some times failures can                happen due  to database connection failures]          b) Message sending failure,due to endpoint is unavailability.[For example,the JBoss  ...

TPP Journey through WSO2 Open Banking

Introduction 2018 is all set to be a game-changing year for European banking. The Revised Payment Services Directive (PSD2) has opened the door to new third party providers [TPPs] to connect with banks and manage finances of bank customers on behalf of them. The PSD2 regulation has mandated banks to expose their core-banking account data and payment services to authorized TPPs to consume. Thus as a bank it’s essential to have a solution which will securely expose their internal banking services to third party providers in a trusted manner. WSO2 Open Banking solution provides all required components to expose bank APIs in a well secured manner in order to become PSD2 compliant. This article explains about the importance of the TPP role in PSD2 domain, the requirements set that banks need to provide for TPPs by PSD2 regulations and how WSO2 Open Banking solution supports these requirements.  From my last blog ,I have given an introduction for PSD2 and WSO2 Open Banking soluti...