Level 2

Solved

Servlet instatiation in aem

Forum|Forum|10 months ago
March 16, 2025
7 replies
829 views

Hi Team,

How to instatiate a servlet if runmode is dev or stage?

If it's path based we can get the runmode from backend and pass it to the fe and in fe we can check if the runmode from be is dev we can use ajax call and call servlet by path, but if it's resourcetype based servlet how to instatiate servlet by resourcetype based on dev runmode.

Best answer by Uppari_Ramesh

Hi @ns334 , If I understand correct, your requirement is to hit the servlet only is dev or stage env and you are worrying about automaticatic execution of servlet in case of resource based servlet. You can directly put a runmode check in resource based servlet so that it will prevent futher execution.

You can follow below approaches

1. There need not be an extra API call which tells you DEV or stage env. FE can always hit actual resource based servlet and in that servlet you can put a check if it is a DEV or STAGE runmode and break the flow. I would suggest this approach because run mode control check should always be at BE so that you will be in safe side even if someone calls the servlet that shouldn't run in DEV and it will stop the execution.

2. If you don't want FE calling a servlet always and you really need a servlet which tells runmode to FE then if you have actual resource based servlet then in this case also you need to put a run mode check.

Thanks

Ramesh

Uppari_RameshAccepted solution

Level 5

Hi @ns334 , If I understand correct, your requirement is to hit the servlet only is dev or stage env and you are worrying about automaticatic execution of servlet in case of resource based servlet. You can directly put a runmode check in resource based servlet so that it will prevent futher execution.

You can follow below approaches

1. There need not be an extra API call which tells you DEV or stage env. FE can always hit actual resource based servlet and in that servlet you can put a check if it is a DEV or STAGE runmode and break the flow. I would suggest this approach because run mode control check should always be at BE so that you will be in safe side even if someone calls the servlet that shouldn't run in DEV and it will stop the execution.

2. If you don't want FE calling a servlet always and you really need a servlet which tells runmode to FE then if you have actual resource based servlet then in this case also you need to put a run mode check.

Thanks

Ramesh

kapil_rajoria

Community Advisor

Hi @ns334
It doesn't matter whether your servlet is registered by resource type or path; you can use the approaches below to determine the run mode.
Further, based on servlet response, handle things in FE.

1. using SlingSettingService:

@Reference
private SlingSettingsService slingSettings;

private boolean enabled;

@Activate
@Modified
protected void activate() {
  this.enabled = slingSettings.getRunModes().contains("dev") ||
    slingSettings.getRunModes().contains("stage");
}
@Override
protected void doGet(SlingHttpServletRequest request, SlingHttpServletResponse response) {
  if (enabled) {
    response.getWriter().write("Servlet is enabled!");
  } else {
    response.getWriter().write("Servlet is disabled!");
  }
}

2. using custom configurations:

@Designate(ocd = MyServlet.Configuration.class)
public class MyServlet extends SlingAllMethodsServlet {

  @ObjectClassDefinition(name = "My Servlet Configuration")
  public @interface Configuration {
    @AttributeDefinition(name = "Enabled", description = "Enable the servlet")
    boolean enabled() default false;
  }

  private boolean enabled;

  @Activate
  @Modified
  protected void activate(Configuration config) {
    this.enabled = config.enabled();
  }

  @Override
  protected void doGet(SlingHttpServletRequest request, SlingHttpServletResponse response) {
    if (enabled) {
      response.getWriter().write("Servlet is enabled!");
    } else {
      response.getWriter().write("Servlet is disabled!");
    }
  }

3. using sling.runmodes property:

@Component(
    service = Servlet.class,
    property = {
        "sling.servlet.paths=/bin/devstageServlet",
        "sling.servlet.methods=GET",
        "sling.runmodes=dev|stage"  //Only register in dev or stage
    }
)
public class DevStageServlet extends SlingSafeMethodsServlet {

    @Override
    protected void doGet(SlingHttpServletRequest request, SlingHttpServletResponse response) throws IOException {
        response.getWriter().write("This servlet is only available in dev or stage environments.");
    }
}

N

NehaMa

Level 4

hi @ns334 - You can use https://medium.com/@vkarthik1356/alternative-osgi-code-for-slingsettingsservice-2ac6fcf71d53 and have the run mode based on environment picked.

arunpatidar

Community Advisor

Hi @ns334

You can use Osgi configuration policy to enable/disable servlet or any other osgi component/service based on run mode

ConfigurationPolicy.REQUIRE — There must be a corresponding Configuration object for the component configuration to become satisfied.
By specifying the configuration policy as REQUIRE the component will be enabled only when the configuration(osgi:config) is available for the specific run mode otherwise the component will be unsatisfied.

Please check https://experienceleaguecommunities.adobe.com/t5/adobe-experience-manager/how-to-enable-run-mode-specific-servlets-in-aem-aem-community/m-p/389330

Arun Patidar

Asutosh_Jena_

Community Advisor

Hi @ns334

Could you please clarify a bit more? Are you trying to avoid instantiating the servlet, or do you not want to invoke the servlet from the frontend using AJAX during development run mode? Additionally, I noticed you mentioned a resource type-based servlet. Providing more details on this would help us offer a more precise solution. Looking forward to your input.

Thanks,

Asutosh Jena

avesh_narang

Level 3

It would be great , if you can elaborate your use case . As getting runmode is altogether different from the registration of the servlet (path based or resourceType based ) . You can get the run modes in be and fe , and based on the condition you can apply the logic of the servlet .

kautuk_sahni

Community Manager

@ns334 Did you find the suggestions helpful? Please let us know if you need more information. If a response worked, kindly mark it as correct for posterity; alternatively, if you found a solution yourself, we’d appreciate it if you could share it with the community. Thank you!

Kautuk Sahni

Sign up

Login with SSO

Login to the community

Login with SSO

Scanning file for viruses.

This file cannot be downloaded