Add configurable default servlet-filter URL patterns via boot.properties

[Copilot]

Adds openidm.servlet.alias and openidm.selfservice.alias properties to conf/boot/boot.properties that control the default URL patterns applied to servlet filters which do not specify explicit urlPatterns in their conf/servletfilter-*.json configuration. Updates ServletRegistrationSingleton to read these properties and build the default filter URL patterns accordingly.

Important: These properties only affect default servlet-filter URL patterns. They do not change the actual REST servlet registration, which remains at /openidm. The Self-Service UI context root is configured separately via conf/ui.context-selfservice.json.

Changes Made

• openidm-servlet-registrator: Updated ServletRegistrationSingleton to read openidm.servlet.alias (default /openidm) and openidm.selfservice.alias (default /selfservice) from boot.properties and use them to build default servlet-filter URL patterns. Added sanitizeAlias/normalizeAlias helpers to safely handle edge cases (trailing slashes, .. sequences, root context).
• conf/boot/boot.properties: Added commented-out openidm.servlet.alias and openidm.selfservice.alias entries with clarifying notes that these affect filter URL patterns only, not the core REST servlet context path.
• appendix-jetty.adoc: Added new section "Configuring Default Servlet-Filter URL Patterns" documenting the two properties, their defaults, and an IMPORTANT callout clarifying their limited scope.
• appendix-file-layout.adoc: Updated boot.properties description to mention the new filter URL pattern properties and their scope.
• appendix-ports-used.adoc: Added paragraph linking to the new section and clarifying that these properties influence filter patterns only.
• Copyright headers: Updated copyright year to 2026 in all modified files; added missing Portions Copyright 2026 3A Systems LLC. header to boot.properties.

Original prompt

Цель

Добавить возможность настройки базового REST context path через conf/boot/boot.properties без необходимости пересборки проекта.

Изменяемые файлы

1. openidm-servlet-registrator/src/main/java/org/forgerock/openidm/servletregistration/impl/ServletRegistrationSingleton.java

В методе activate(ComponentContext context) добавить чтение свойств через IdentityServer.getInstance().getProperty(...), аналогично тому, как это делается в других сервисах (например, TaskScannerService, HealthService).

Текущий код:

import org.osgi.framework.BundleContext;
...

private static final String[] DEFAULT_SERVLET_NAME = new String[] { "OpenIDM REST" };
private static final String[] DEFAULT_SERVLET_URL_PATTERNS = new String[] { "/openidm/*", "/selfservice/*" };

...

@Activate
public void activate(ComponentContext context) {
    bundleContext = context.getBundleContext();
    sharedContext = webContainer.createDefaultSharedHttpContext();
}

Необходимые изменения:

1. Добавить импорт org.forgerock.openidm.core.IdentityServer
2. Добавить константы для имён свойств:

private static final String PROP_SERVLET_ALIAS = "openidm.servlet.alias";
private static final String PROP_SELFSERVICE_ALIAS = "openidm.selfservice.alias";
private static final String DEFAULT_SERVLET_ALIAS = "/openidm";
private static final String DEFAULT_SELFSERVICE_ALIAS = "/selfservice";

3. Удалить или заменить DEFAULT_SERVLET_URL_PATTERNS — вместо статического массива строить его динамически в activate():

@Activate
public void activate(ComponentContext context) {
    bundleContext = context.getBundleContext();
    sharedContext = webContainer.createDefaultSharedHttpContext();

    String servletAlias = IdentityServer.getInstance().getProperty(PROP_SERVLET_ALIAS, DEFAULT_SERVLET_ALIAS);
    String selfServiceAlias = IdentityServer.getInstance().getProperty(PROP_SELFSERVICE_ALIAS, DEFAULT_SELFSERVICE_ALIAS);

    // Ensure paths start with /
    if (!servletAlias.startsWith("/")) {
        servletAlias = "/" + servletAlias;
    }
    if (!selfServiceAlias.startsWith("/")) {
        selfServiceAlias = "/" + selfServiceAlias;
    }

    defaultServletUrlPatterns = new String[] { servletAlias + "/*", selfServiceAlias + "/*" };
    logger.info("REST servlet URL patterns configured: {}, {}", servletAlias + "/*", selfServiceAlias + "/*");
}

4. Изменить DEFAULT_SERVLET_URL_PATTERNS с private static final на private String[] (instance field), чтобы его можно было задавать в activate():

private String[] defaultServletUrlPatterns = new String[] { "/openidm/*", "/selfservice/*" };

5. В методе registerFilterWithWebContainer заменить использование DEFAULT_SERVLET_URL_PATTERNS на defaultServletUrlPatterns:

List<String> urlPatterns = config.get(SERVLET_FILTER_URL_PATTERNS)
        .defaultTo(Arrays.asList(defaultServletUrlPatterns))
        .asList(String.class);

2. openidm-zip/src/main/resources/conf/boot/boot.properties

Добавить в конец файла документацию по новым свойствам (закомментированные примеры):

# REST API context path (default: /openidm). Example: /myidm
# openidm.servlet.alias=/openidm

# Self-service UI context path (default: /selfservice). Example: /myselfservice
# openidm.selfservice.alias=/selfservice

Требования

• Обратная совместимость: если свойства не заданы в boot.properties, поведение идентично текущему (/openidm/* и /selfservice/*)
• Значения по умолчанию: openidm.servlet.alias=/openidm, openidm.selfservice.alias=/selfservice
• Пример кастомной конфигурации в boot.properties: openidm.servlet.alias=/myidm, openidm.selfservice.alias=/myselfservice
• Путь автоматически дополняется / в начале, если она отсутствует
• При старте сервиса в лог пишется итоговый URL pattern

Пример использования после мёржа

В conf/boot/boot.properties:

openidm.servlet.alias=/myidm
openidm.selfservice.alias=/myselfservice

После перезапуска OpenIDM REST API будет доступен по http://localhost:8080/myidm/ вместо http://localhost:8080/openidm/

The following is the prior conversation context from the user's chat exploration (may be truncated):

User: какие пути решения ?

Assistant: Вот подробный анализ вопроса "Как изменить REST context?" в OpenIDM, основанный на изучении исходного кода.

---

Что такое REST context в OpenIDM?

В OpenIDM под "REST context" может подразумеваться две разные вещи:

1. Базовый путь REST API (/openidm/) — корневой путь, по которому доступны все REST-эндпоинты
2. Путь UI (/, /admin, /api) — пути, по которым зарегистрированы веб-интерфейсы

---

Пути решения

Вариант 1: Изменить путь UI (через конфигурационные файлы)

Это самый простой и поддерживаемый способ. В каталоге conf/ есть JSON-файлы контекстов:

conf/ui.context-selfservice.json — Self-Service UI (по умолчанию /):

</details>



<!-- START COPILOT CODING AGENT SUFFIX -->

*This pull request was created from Copilot chat.*
>

<!-- START COPILOT CODING AGENT TIPS -->
---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more [Copilot coding agent tips](https://gh.io/copilot-coding-agent-tips) in the docs.

[Copilot]

Pull request overview

This PR aims to make the REST (and related) context paths configurable via conf/boot/boot.properties, and updates documentation/copyright headers accordingly.

Changes:

• Add new openidm.servlet.alias / openidm.selfservice.alias properties to boot.properties (documented as examples).
• Update ServletRegistrationSingleton to read those properties and use them to build default servlet-filter URL patterns.
• Update integrators-guide docs to describe the new configuration options, plus copyright year bumps.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
openidm-zip/src/main/resources/conf/boot/boot.properties	Adds commented examples for the new alias properties and a copyright header.
openidm-servlet-registrator/src/main/java/.../ServletRegistrationSingleton.java	Reads boot properties and uses them to set default filter urlPatterns.
openidm-servlet-registrator/pom.xml	Adds openidm-system dependency (for IdentityServer) and bumps copyright years.
openidm-doc/src/main/asciidoc/integrators-guide/appendix-ports-used.adoc	Mentions configurable REST context paths via boot.properties.
openidm-doc/src/main/asciidoc/integrators-guide/appendix-jetty.adoc	Documents alias properties and updates servlet-filter default behavior description.
openidm-doc/src/main/asciidoc/integrators-guide/appendix-file-layout.adoc	Notes alias properties as part of boot.properties contents.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The new boot.properties aliases are only used to build default filter urlPatterns here; they do not change where the REST servlet is actually registered (it remains hard-coded elsewhere, e.g., the API servlet registers at "/openidm"). If an operator sets openidm.servlet.alias, filters relying on the default patterns will stop applying to the real REST endpoints, which can break integrations and potentially bypass expected filter behavior. Either wire these properties into the servlet registration path(s) as well (and update any other components that hard-code /openidm), or rename/re-scope the properties and docs to clearly state they affect only default servlet-filter URL patterns.

[Copilot]

This section claims the REST API and Self-Service UI context paths can be changed via conf/boot/boot.properties, but the code changes in this PR only adjust the default servlet-filter urlPatterns and do not update the actual servlet registrations (the REST servlet alias is still hard-coded to /openidm in the API servlet component). As written, users following these instructions will not actually move the REST endpoints and may inadvertently cause filters to no longer apply. Please either implement the alias change end-to-end (servlet registrations + any hard-coded /openidm usages), or reword this section to describe the narrower behavior that’s actually implemented.

[Copilot]

The text refers to the “Self-Service UI” being at /selfservice/ by default. In this distribution, the selfservice UI context root appears to be configured via conf/ui.context-selfservice.json and defaults to "/", while /selfservice is typically a REST sub-resource under /openidm (e.g., /openidm/selfservice/...). Please clarify what /selfservice actually refers to here (UI vs REST), and align the defaults and examples accordingly so operators don’t break links/bookmarks.

[Copilot]

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The added note says these properties do NOT change the core REST servlet context path (it remains /openidm), but the PR title/description and other docs in this PR describe this as changing the REST API context path. Please align the PR messaging/docs with actual behavior (or implement actual servlet alias remapping if that’s the intent).

[Copilot]

The self-service section says “Example override: /selfservice”, which is the default value rather than an override. Update the example to something like /myselfservice (and keep it consistent with the commented property example below).

Suggested change

	# Example override: /selfservice
	#openidm.selfservice.alias=/selfservice
	# Example override: /myselfservice
	#openidm.selfservice.alias=/myselfservice

[Copilot]

This new section claims openidm.servlet.alias / openidm.selfservice.alias change the REST API and Self-Service UI context paths and that the REST API becomes available at /myidm/. In the code change, these properties only change the default servlet-filter URL patterns (used when a filter config omits urlPatterns); servlet aliases themselves are not moved. Please update the section title/text/examples accordingly (and clarify that Self-Service UI context root is configured via conf/ui.context-selfservice.json, which defaults to /).

[vharseko]

@copilot apply changes based on the comments in this thread

[Copilot]

@copilot apply changes based on the comments in this thread

Applied in e0d0fc9:

1. boot.properties – Fixed the selfservice example: /selfservice is the default value, not an override, so changed to /myselfservice.

2. appendix-jetty.adoc – Rewrote the section: renamed from "Configuring the REST API Context Path" to "Configuring Default Servlet-Filter URL Patterns"; added an IMPORTANT callout explicitly stating these properties do not change the actual REST servlet registration (which remains at /openidm), and clarified that the Self-Service UI context root is configured separately via conf/ui.context-selfservice.json.