[FELIX-4710] Web Console: Display templated name hint for factory configuration entries

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: webconsole-4.2.2
• Fix Version/s: webconsole-4.2.6
• Component/s: Web Console
• Assignee: Carsten Ziegeler
• Reporter: Stefan Seifert
• Created: 26/Nov/14 00:49
• Updated: 30/Nov/15 05:47
• Resolved: 26/Jan/15 07:22

Description

currently for each factory configuration entry in the web console only a very cryptic name is displayed, consisting of the factory PID and a GUID. this is very inconvenient esp. if there are a lot of entries and the user want to edit a specific one:

proposal: the author of the OSGi service with factory configuration should be able to provide a "nameHint" template to display a nice human-readable name, and display the pid+gui only as tooltip:

attached is a patch with draft implementation of this based on an optional service property webconsole.configurationFactory.nameHint which can be set on the service which can reference other property names with placeholders. the web console then displays this name hint with the configured values replaced.

example (using SCR annotation):

@Property(name = "webconsole.configurationFactory.nameHint", value = "{serviceName}: {ribbonHosts}")

this will help on a lot of services, e.g. factory configurations for log configuration an others.

Issue Links

• is related to: FELIX-4978 Enable name hint for JAAS Config entries
• is related to: SLING-4726 Commons Log: Enable Name Hint for Web Console Log Config Entries
• is related to: FELIX-5083 Set webconsole.configurationFactory.nameHint for JAAS configurations
• is related to: SLING-4742 Service User Mapper: Web Console Name Hints for Mapping Configurations
• is related to: SLING-4743 Event: Web Console Name Hints for Job Queue Configuration