New example of osgi config files not working with Aem cloud SDK.

Hi @tb3dock 

After reading your questions below I just tried to create a sample OSGi service on my local SDK with .cfg.json as the extension for the OSGi configuration file and it works perfectly fine.

So I believe you are missing something while writing code. Please see the sample code below that I have written:

Service Interface which has only 3 attributes (2 string and 1 int type), with default value so incase, the configuration values are not provided in the respective runmode, the default values can be picked.

package com.adobe.aem.guides.wknd.core.services;

import org.osgi.service.metatype.annotations.AttributeDefinition;
import org.osgi.service.metatype.annotations.AttributeType;
import org.osgi.service.metatype.annotations.ObjectClassDefinition;

@ObjectClassDefinition(name = "EndPoint Configuration Service", description = "EndPoint Configuration Service")
public @interface EndPointConfigurationService {

    @AttributeDefinition(name = "EndPoint URL", description = "Configure EndPoint URL", type = AttributeType.STRING)
    String endPointURL() default "https://www.google.co.in";

    @AttributeDefinition(name = "EndPoint Name", description = "Configure EndPoint Name", type = AttributeType.STRING)
    String endPointName() default "Google India";

    @AttributeDefinition(name = "EndPoint Name", description = "Configure EndPoint Name", type = AttributeType.INTEGER)
    int timeoutDuration() default 10000;
}

Service Class Implementing the above Interface:

package com.adobe.aem.guides.wknd.core.services.impl;

import com.adobe.aem.guides.wknd.core.services.EndPointConfigurationService;
import org.osgi.framework.Constants;
import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.metatype.annotations.Designate;

@Component(immediate = true, service = EndPointConfigurationServiceImpl.class,
        property = {"process.label=EndPoint Configuration Service",
                Constants.SERVICE_DESCRIPTION + "=EndPoint Configuration Service for XXXX Account",
                Constants.SERVICE_VENDOR + "=Someone for Testing"})
@Designate(ocd = EndPointConfigurationService.class)
public class EndPointConfigurationServiceImpl {

    private EndPointConfigurationService endPointConfigurationService;

    @Activate
    protected void activate(EndPointConfigurationService config) {
        this.endPointConfigurationService = config;
    }

    public String getEndPointURL() {
        return endPointConfigurationService.endPointURL();
    }

    public String getEndPointName() {
        return endPointConfigurationService.endPointName();
    }

    public int getTimeoutDuration() {
        return endPointConfigurationService.timeoutDuration();
    }
}

OSGi Configuration that is added on default run mode in AEM:

com.adobe.aem.guides.wknd.core.services.impl.EndPointConfigurationServiceImpl.cfg.json

{
  "endPointURL": "https://www.facebook.com",
  "endPointName": "Facebook Global",
  "timeoutDuration": "50000"
}

Sample Servlet to Invoke the Service:

As of now I have used a path based servlet, but it is preferred to use a Resource based servlet.

package com.adobe.aem.guides.wknd.core.servlets;

import com.adobe.aem.guides.wknd.core.services.impl.EndPointConfigurationServiceImpl;
import org.apache.http.entity.ContentType;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.SlingHttpServletResponse;
import org.apache.sling.api.servlets.HttpConstants;
import org.apache.sling.api.servlets.ServletResolverConstants;
import org.apache.sling.api.servlets.SlingSafeMethodsServlet;
import org.osgi.framework.Constants;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.servlet.Servlet;
import javax.servlet.ServletException;
import java.io.IOException;

@Component(service = Servlet.class, property = {"process.label=EndPoint Servlet",
        Constants.SERVICE_DESCRIPTION + "=" + "This is a test servlet to get the end points from OSGi",
        ServletResolverConstants.SLING_SERVLET_METHODS + "=" + HttpConstants.METHOD_GET,
        ServletResolverConstants.SLING_SERVLET_PATHS + "=" + "/bin/testendpoint"})
public class EndPointServlet extends SlingSafeMethodsServlet {

    private static final long serialVersionUID = 1L;

    private static final Logger log = LoggerFactory.getLogger(EndPointServlet.class);

    @Reference
    private transient EndPointConfigurationServiceImpl endPointConfigurationService;

    @Override
    protected void doGet(SlingHttpServletRequest request, SlingHttpServletResponse response) throws ServletException, IOException {
        log.info("***** :: doGet :: Start :: *****");

        response.setContentType(ContentType.TEXT_PLAIN.getMimeType());

        final String responseString = "EndPointURL -> " + endPointConfigurationService.getEndPointURL() + "\n" +
                "EndPointName -> " + endPointConfigurationService.getEndPointName() + "\n" +
                "TimeOut Duration -> " + endPointConfigurationService.getTimeoutDuration();

        log.info("***** :: doGet :: End :: *****");

        response.getWriter().write(responseString);
    }
}

Response when the config file is present: 

EndPointURL -> https://www.facebook.com
EndPointName -> Facebook Global
TimeOut Duration -> 50000 

Response when the config is not present, taking the default value from service:

EndPointURL -> https://www.google.co.in
EndPointName -> Google India
TimeOut Duration -> 10000

Hope this helps!

Thanks

First, you don't have "2 copies of the config", they are different ones (check the names and also the PIDs).

The OSGI configuration of the Servlet looks correct, because the configuration has just the definition for the enabled boolean property, I don't understand why you consider it as problematic. The default value of the configuration is displayed, because you haven't provided a actual configuration for it.

For the service: The "_" in the java names are escaping a "." in the actual property name. Which is a kind of workaround, because at the time when this type of annotations were introduced, a lot of osgi configurations were already out there which were using the "." as separator in the OSGI config names. And the SCR implementation before did not have the annotation and the config classes, there you had to read and convert the properties manually, and for this the API was using plain strings.

Please try and use this format as configuration:

I would recommend to use plain Camel Case namings also for the properties, that makes it much more readable, and use "_" only for legacy implementations which are using property names containing dots. So if you change your property names in the configuration to "servicenamePropertyNameDropDown" (or something better), you can use "servicenamePropertyNameDropDown" also in the OSGI configuration.

HTH,

Jörg

You have so many problems with your code, can you try with below code set.

https://github.com/arunpatidar02/aemaacs-aemlab/commit/f66fbcf743d5ff043e2d41e6dde9a8d5d2d560d3