How to validate OSGi Service properties from webconsole? | Community
Skip to main content
Dinu_Arya
Dinu_Arya
Level 6
October 16, 2015
Solved

How to validate OSGi Service properties from webconsole?

  • October 16, 2015
  • 7 replies
  • 1482 views

Hi,

I have written a service and added some properties using @Property . While configuring the service from web console, I have to show some user friendly message or some alert to an author if he/she enters more than the allowed items/count(Max count: 5). Is it possible to validate these fields? Pls let me know.

Thanks,

AryA

This post is no longer active and is closed to new replies. Need help? Start a new post to ask your question.
Best answer by joerghoh

Hi,

I would expect, that an administrator (or someone, who is supposed to change the OSGI configuration) is allowed to read logfiles, so you can validate your parameters in the code. There is no possibility to add validation logic in the felix config forms. When you have a multi-value parameter, you can limit the maximum number of entries via the property, and this setting is validated (the UI doesn't let you create more than 5 entries for example).

Jörg

7 replies

Venkata_Kumar
Venkata_Kumar
Level 2
October 16, 2015
        Usually,authors are not supposed to access Felix console..coz..if they delete something or click on something else, it may screw entire system. Ideally, only admins are allowed to do changes.. If you want authors to change config,place the config at your application level config nodes and give option for authors to change.In that case, you can also add validations
smacdonald2008
smacdonald2008
Level 10
October 16, 2015

I am not aware of how to let authors know through the Felix web console where you install the OSGi bundle and place it into an active state. One option that you have is to write an error message in the AEM log file if the property contains an invalid value.  

Also - take a look at this AEM topic:

http://docs.adobe.com/docs/en/cq/current/deploying/configuring_osgi.html

joerghoh
Adobe Employee
joerghohAdobe EmployeeAccepted solution
Adobe Employee
October 16, 2015

Hi,

I would expect, that an administrator (or someone, who is supposed to change the OSGI configuration) is allowed to read logfiles, so you can validate your parameters in the code. There is no possibility to add validation logic in the felix config forms. When you have a multi-value parameter, you can limit the maximum number of entries via the property, and this setting is validated (the UI doesn't let you create more than 5 entries for example).

Jörg

Dinu_Arya
Dinu_AryaAuthor
Level 6
October 16, 2015

Jorg,

ya. But admin might not know what is the exact issue. Can u pls share how can I declare multi-value parameter?  Pls let me know how can I limit the maximum number of entries via the property

Thanks A lot,

AryA.

smacdonald2008
smacdonald2008
Level 10
October 16, 2015

See: http://stackoverflow.com/questions/14370606/setting-properties-in-adobe-cq5

joerghoh
Adobe Employee
joerghohAdobe Employee
Adobe Employee
October 16, 2015

Hi,

you can do something like this:

@Property(label="limited parameter", description="use at max 5", cardinality=5) private String[] myParams;

See the documentation of cardinality on http://felix.apache.org/documentation/subprojects/apache-felix-maven-scr-plugin/scr-annotations.html#property

Venkata_Kumar
Venkata_Kumar
Level 2
October 16, 2015
        Usually,authors are not supposed to access Felix console..coz..if they delete something or click on something else, it may screw entire system. Ideally, only admins are allowed to do changes.. If you want authors to change config,place the config at your application level config nodes and give option for authors to change.In that case, you can also add validations
Terms & ConditionsAccessibility statement

Loading footer...