External APIs

External APIs can be referenced directly by customer projects. Such APIs are annotated with @Accesslevel(EXTERNAL). Javadoc is provided for all External APIs on a per-component basis.

The Javadoc for each component can be found at components\<component name>\doc\api.zip. Some components might not have any Javadoc if they have no External APIs. Only reference classes that are documented in Javadoc from customer code; referencing other classes produce discouraged warnings or access restricted errors and are not supported.

As with all APIs, it is expected that classes that are marked as External will evolve over time, while remaining compatible with previous versions. If you require some capability that cannot be fulfilled through a combination of External APIs and allowed extension mechanisms, raise your requirements through Support. If appropriate, a new API, customization hook, strategy pattern or configuration-based approach is made available, and such new APIs can be delivered in Feature Packs. Alternatively, an existing Internal API might, in some circumstances, be re-designated as External, if appropriate.