Skip to main content

Servlet management

Suggest edit
Updated on June 30, 2021

Use the Servlet Management landing page in your Pega Cloud applications to securely add, modify, and disable servlet configurations without editing the web.xml file.

You can customize the servlet name, authentication type, and parameters. Additionally, you can add new servlets and disable and delete unused servlets, or create new servlets by cloning existing servlets.

A servlet is a Java program that extends capabilities of the server, responds to any incoming requests, and construct responses. Servlets are used during authentication in commonly used protocols, such as Lightweight Directory Access Protocol (LDAP), Security Assertion markup Language (SAML), and OpenID connect, and other.

Pega Cloud supports system-created servlets (default) and custom (user-defined) servlets, which are created by the security administrator.

The Availability column displays whether the servlet has been enabled or disabled, and whether a restart is required for changes to take effect.

When you add a servlet on the Servlet Management landing page, the URL pattern that you configure for the servlet adds servlet mappings for the corresponding servlet. For example, if there is a URL pattern named PRServlet under a servlet WebStandard, then two servlet mappings are created: / PRServlet and /PRServlet/*.

When you make servlet management changes, you need to restart your system for the changes to take effect. To request a restart of the entire environment, select New request in My Support Portal. For more information, see:

The image below shows the Servlet Management landing page.

The Servlet management landing page
The Servlet management landing page

To the right of the servlets, there are vertical ellipsis, when clicked, the following options are displayed: Clone, Configure, and Copy URL.

Note: System-generated servlets have different configuration options than user-created servlets. For example, you cannot delete system-generated servlets, but you can delete user-generated servlets.

An image of the options available on a system-generated servlet is shown below:

The options for a system-generated servlet: Clone,Configure, Copy URL, Delete

An image of the options available on a user-created servlet is shown below:

The options for a user-created servlet: Clone, Configure, Copy URL, Delete

Servlet cloning

Clicking Clone launches a dialog box similar to adding a new servlet. However, the Purpose and Servlet authentication type fields have the same information as the servlet you are cloning. Any Initialization parameters will also be carried over when a servlet is cloned.

When you want to rename an existing servlet or create a new servlet, with similar properties as another servlet, you can clone that servlet.

When you rename an existing servlet, you can clone the new servlet with the updated name, and then disable the original servlet so that only the new servlet is accessible.

The following figure shows a example of a cloned servlet configuration:

The Cloning a servlet dialog box

The cloning a servlet dialog box
The cloning a servlet dialog box in Servlet Management

Servlet configuration

The Configure option provides a summary of the servlet information and shows controls for editing and making changes to the configured servlet.

The following figure shows an example of the servlet configuration dialog box:

The Editing a servlet dialog

The editing a servlet dialog box
The editing a servlet dialog box in Servlet Management

Servlet copy URL copying

You can use the Copy URL option to copy the servlet URL and use that URL for testing or other purposes.

Servlet name
The standard URL to the specific servlet on the server side, and the Copy URL option provides access to the corresponding servlet URL in a browser without manually typing the IP address.
*
The default servlet URL pattern. If you access a URL after /prweb and the servlet is not found, you are redirected to the default servlet where * is configured as the URL pattern.
If you do not provide the * URL, then system becomes inaccessible. This setting is the minimum servlet configuration that is required for an application. Without this configuration, a 403 error is displayed.

You can copy the URL pattern of the Servlet name, as shown in the following example:

The Copy URL pattern dialog box

The copy URL pattern dialog box
The copy URL pattern dialog box in servlet management

  • Adding a servlet

    Add a new servlet, without editing the web.xml file, by cloning and modifying existing servlets where necessary.

  • Cloning a servlet

    Servlet Management is only available for Pega Cloud, and allows you to add, modify, and disable servlet configurations without editing the web.xml file. Clone a servlet to create a new servlet without having to recreate all the parameters.

  • Configuring a servlet

    Servlet Management is only available for Pega Cloud, and allows you to add, modify, and disable servlet configurations without editing the web.xml file. Create new servlets by cloning existing servlets and modifying where necessary.

  • Disabling a servlet

    Servlet Management is only available for Pega Cloud, and allows you to add, modify, and disable servlet configurations without editing the web.xml file. If there is a servlet that is not commonly used within the application and that you want to keep in the system, you can disable the servlet.

  • Deleting a servlet

    Servlet Management is only available for Pega Cloud, and allows you to add, modify, and disable servlet configurations without editing the web.xml file. You can delete user-defined servlets that are no longer used in the system and that you do not need to keep within the system.

  • Moving the * URL pattern between servlets

    The * is a wildcard character that is not used in the URL. * is the default servlet URL pattern that you can replace with another servlet.

Did you find this content helpful? YesNo

100% found this useful

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us