Binding a servlet to a custom configured path | Community
Skip to main content
C
candersen_hoodoo
August 20, 2020
Solved

Binding a servlet to a custom configured path

  • August 20, 2020
  • 4 replies
  • 4348 views

Hi there,

 

I was wondering what best practice would be to bind a servlet to a custom path based on a config. This servlet is an API endpoint, so selectors won't help us too much. For example, I have a servlet at /bin/foo/files, and I'd like to be able to configure that path to be at /bin/bar/files, or even /bar/files, based on an OSGi config or something similar with the path inside.

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

The best way is still to avoid hardcoding the path in a servlet. I would suggest another approach:

  1. Create sling resource type my/application/api/endpoint1
  2. Write a servlet which handles the POST/GET/... request to that resource type
  3. Build a template which uses my/application/api/endpoint1 as resourcetype OR
  4. Build a component which uses my/application/apo/endpoint as a resourcetype.
  5. Then create a page based  on that template or drop the component into a page.

 

Then you can create, remove, update, duplicate, ... this API endpoint during runtime. You can define ACLs on it (if you require the users of this API to authenticate). You don't need to reconfigure anything on OSGI level.

And you can even create a new "content tree" below /endpoints (who says, that pages can only reside below /content?)

 

4 replies

BrianKasingli
Community Advisor and Adobe Champion
BrianKasingliCommunity Advisor and Adobe Champion
Community Advisor and Adobe Champion
August 20, 2020

@candersen_hoodoo,

I don't think there's an out of a box way to dynamically set the path of your servlet, however, a solution you can try is to utilise and configure Apache rewrite rules for your use case, PT flag. Have a look at this article, which explains the solution more in detail. 

https://sourcedcode.com/sugar-coating-servlet-scripts-and-paths

Example:

 

RewriteRule ^/api/files$ /bin/bar/files [PT,L]

 

With the example above, when you visit https://my-site/api/files, you will be internally passed through to serve the servlet that has been registered.

 

 

    C
    candersen_hoodooAuthor
    August 20, 2020
    Unfortunately our servlet isn't front-end facing, so a dispatcher isn't used. It's purely an author API.
    Nikhil-Kumar
    Community Advisor
    Nikhil-KumarCommunity Advisor
    Community Advisor
    August 22, 2020

    @candersen_hoodoo 

    You can try getting it from the query param in servlet as request parameter and then assign it to some servlet's varialble locally.
    Then while defining the path for the servlet in Java, get this values as <Classname>.<vriableName>

    String path;

    path = request.getParameter("path");

    "sling.servlet.paths="+<ClassName>.<path>




      arunpatidar
      Community Advisor
      arunpatidarCommunity Advisor
      Community Advisor
      August 22, 2020

      Why dont you use AEM servlet as proxy servlet and use selector?

      Arun Patidar
      joerghoh
      Adobe Employee
      joerghohAdobe EmployeeAccepted solution
      Adobe Employee
      August 22, 2020

      The best way is still to avoid hardcoding the path in a servlet. I would suggest another approach:

      1. Create sling resource type my/application/api/endpoint1
      2. Write a servlet which handles the POST/GET/... request to that resource type
      3. Build a template which uses my/application/api/endpoint1 as resourcetype OR
      4. Build a component which uses my/application/apo/endpoint as a resourcetype.
      5. Then create a page based  on that template or drop the component into a page.

       

      Then you can create, remove, update, duplicate, ... this API endpoint during runtime. You can define ACLs on it (if you require the users of this API to authenticate). You don't need to reconfigure anything on OSGI level.

      And you can even create a new "content tree" below /endpoints (who says, that pages can only reside below /content?)

       

      Terms & ConditionsAccessibility statement

      Loading footer...