Submit Feedback
Legacy Knowledge Base
Published Sep. 10, 2025

How to perform some actions when an OSGi module is started/stopped

Written By

Jose L. Bango

How To articles are not official guidelines or officially supported documentation. They are community-contributed content and may not always reflect the latest updates to Liferay DXP. We welcome your feedback to improve How To articles!

While we make every effort to ensure this Knowledge Base is accurate, it may not always reflect the most recent updates or official guidelines.We appreciate your understanding and encourage you to reach out with any feedback or concerns.

Legacy Article

You are viewing an article from our legacy "FastTrack" publication program, made available for informational purposes. Articles in this program were published without a requirement for independent editing or verification and are provided"as is" without guarantee.

Before using any information from this article, independently verify its suitability for your situation and project.

Issue

  • I would like to perform some actions when my OSGi module is started/stopped. How can I achieve that?

Environment

  • Liferay DXP 7.0+

Resolution

NOTE: The following resolution requires customization and should only be implemented at the discretion of your team. Liferay Support will not be able to assist with designing or implementing customizations.

  • By leveraging OSGi annotations, you can get notified about lifecycle events in your Declarative Services components:
    • @Activate. This annotation marks a method that should be invoked when the component becomes satisfied and is activated.
    • @Deactivate. This annotation marks a method that should be invoked when the component is deactivated.
    • @Modified. This annotation marks a method that should be invoked when the component's configuration is modified.
  • You can check Liferay source code for examples. For instance, SPAHelper class uses all 3 aforementioned annotations.

Additional Information

Did this article resolve your issue ?
Legacy Knowledge Base
Did this article resolve your issue ?