Authenticated Request?: NO
Request Arguments: locale, ourguid
Sample Implementation: GetBundleAction.java
The bundle url is provides localized language strings to be used for the proxy tool touch-points in Blackboard Learn (i.e. link names, descriptions).
This URL is called without MAC validation instead using the http URL (always - the https baseurl is not used for the bundle). It provides two arguments:
The locale field is the java locale represented as a string: lang_COUNTRY_Variant (i.e. "en_US"). The ourguid field represents the GUID of the Blackboard Learn instance returned during tool registration.
Refer to GetBundleAction.java in the sample proxy tool for a sample implementation and more direction. Some of the things to consider (commented in the code as well) are:
- Have different bundles for each locale.
- Branding per-Blackboard Learn instance (different langauge strings can be served depending on the guid of the Blackboard Learn server).
- Deal with locale fallbacks appropriately in the case where you are asked for a locale you do not support.
- Properly escape non-iso-8859-1 characters. Observe how the sample users Properties.store to ensure the correct character escaping.
If a bundle URL is not specified then the proxy tool cannot be localized. Instead, all of the name and description fields must contain the raw text to be displayed. Specifying a bundle URL is strongly recommended.