What are the public APIs available in JBoss Portal 6?

Solution Unverified - Updated -

Environment

  • JBoss Portal Platform (JPP)
    • 6.x

Issue

  • Understanding public API/Service API's, What's available, what's we can use?
    Example: we've discussed implementing organization service; what other API's are out there that enable us to create components that leverage the Portal functionality?

Resolution

In JPP 6.0, the following APIs are public:

  • Organization API 1 - package exo.platform.services.organization
  • LocalPolicy API 2 - package exo.platform.services.resources
  • REST API 3

In addition, a public Portal API is going to be added to access Portal and Navigation objects in JPP 6.1. The community documentation 4 already contains information about this API.

  1. https://access.redhat.com/documentation/en-US/Red_Hat_JBoss_Portal/6.0/html/Reference_Guide/sect-Reference_Guide-Organization_API.html ↩︎

  2. https://access.redhat.com/documentation/en-US/Red_Hat_JBoss_Portal/6.0/html/Reference_Guide/chap-Reference_Guide-Localization_Configuration.html#sect-Reference_Guide-Pluggable_Locale_Policy-LocalePolicy_API ↩︎

  3. https://access.redhat.com/documentation/en-US/Red_Hat_JBoss_Portal/6.0/html/Administration_Guide/sid-8094332_GateInManagement-REST.html ↩︎

  4. https://docs.jboss.org/author/display/GTNPORTAL36/GDG-Public+API ↩︎

Root Cause

Only those APIs in Portal which are documented are considered public. Using other/private APIs is not recommended, as there is no guarantee that they remain stable in future releases.

This solution is part of Red Hat’s fast-track publication program, providing a huge library of solutions that Red Hat engineers have created while supporting our customers. To give you the knowledge you need the instant it becomes available, these articles may be presented in a raw and unedited form.

Comments