Skip to content

Update javadoc links #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
+84 −84
Open

Update javadoc links #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
52e54e1
add ssh deployment
maxitemis Jun 25, 2025
6be94a6
Merge pull request #2 from maxistar/ssh_deployment
maxistar Jun 25, 2025
01a9371
Merge branch 'operaton:main' into main
maxistar Jul 17, 2025
b7aec5a
Merge branch 'operaton:main' into main
maxistar Sep 8, 2025
8782c40
change the javadoc links
maxitemis Oct 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/documentation/reference/deployment-descriptors/tags/process-engine.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,11 +95,11 @@ The following example shows an XML snippet which can be placed in both [processe
</p>
<p>
<strong>Text Content:</strong>
The fully qualified classname of the Process Engine Configuration class to be used for this process engine. The class must be a subclass of <a class="javadocref" href="org/operaton/bpm/engine/impl/cfg/ProcessEngineConfigurationImpl.html">ProcessEngineConfigurationImpl</a>.
The fully qualified classname of the Process Engine Configuration class to be used for this process engine. The class must be a subclass of <a class="javadocref" href="https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/engine/impl/cfg/ProcessEngineConfigurationImpl.html">ProcessEngineConfigurationImpl</a>.
</p>
<p>
<strong>Default Value:</strong>
<a class="javadocref" href="org/operaton/bpm/engine/impl/cfg/StandaloneProcessEngineConfiguration.html">StandaloneProcessEngineConfiguration</a>
<a class="javadocref" href="https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/engine/impl/cfg/StandaloneProcessEngineConfiguration.html">StandaloneProcessEngineConfiguration</a>
</p>
<p>
<strong>Example:</strong><br/>
Expand Down Expand Up @@ -215,7 +215,7 @@ The following example shows an XML snippet which can be placed in both [processe
</p>
<p>
<strong>Text Content:</strong>
The fully qualified classname of a process engine plugin. Must be an implementation of <a class="javadocref" href="org/operaton/bpm/engine/impl/cfg/ProcessEnginePlugin.html">ProcessEnginePlugin</a>
The fully qualified classname of a process engine plugin. Must be an implementation of <a class="javadocref" href="https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/engine/impl/cfg/ProcessEnginePlugin.html">ProcessEnginePlugin</a>
</p>
</td>
</tr>
Expand Down Expand Up @@ -504,7 +504,7 @@ The following is a list with the most commonly used process engine configuration
used as the Metrics Reporter identifier.
<br/><br/>
A custom hostname can be generated by providing an implementation of the
<a class="javadocref" href="org/operaton/bpm/engine/impl/history/event/HostnameProvider.html">HostnameProvider</a>
<a class="javadocref" href="https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/engine/impl/history/event/HostnameProvider.html">HostnameProvider</a>
interface and and setting the engine property <code>hostnameProvider</code> to an instance of that class.
<br/><br/>
</td>
Expand Down Expand Up @@ -1018,7 +1018,7 @@ The following is a list with the most commonly used process engine configuration
<td><code>disableBuiltinExceptionCodeProvider</code></td>
<td>Boolean</td>
<td>
Disables the default implementation of <a class="javadocref" href="org/operaton/bpm/engine/impl/errorcode/ExceptionCodeProvider.html">ExceptionCodeProvider</a> which allows overriding the <a href="../user-guide/process-engine/error-handling.md#reserved-code-range">reserved exception codes</a>.
Disables the default implementation of <a class="javadocref" href="https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/engine/impl/errorcode/ExceptionCodeProvider.html">ExceptionCodeProvider</a> which allows overriding the <a href="../user-guide/process-engine/error-handling.md#reserved-code-range">reserved exception codes</a>.
<p>
Default value is <code>false</code>.
</p>
Expand All @@ -1029,7 +1029,7 @@ The following is a list with the most commonly used process engine configuration
</tr>
<tr>
<td><code>customExceptionCodeProvider</code></td>
<td><code><a class="javadocref" href="org/operaton/bpm/engine/impl/errorcode/ExceptionCodeProvider.html">ExceptionCodeProvider</a></code></td>
<td><code><a class="javadocref" href="https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/engine/impl/errorcode/ExceptionCodeProvider.html">ExceptionCodeProvider</a></code></td>
<td>
Allows registering a custom implementation of the exception code provider allowing to provide custom exception codes.
<p>
Expand Down
2 changes: 1 addition & 1 deletion docs/documentation/user-guide/cdi-java-ee-integration/the-cdi-event-bridge.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ If the listener is invoked after the transaction has completed, the `DelegateTas
# The CDI Event Bridge in a process application

To use the CDI Event Bridge in combination with a multi application deployment and the shared process engine, the
<a class="javadocref" href="org/operaton/bpm/engine/cdi/impl/event/CdiEventListener">CdiEventListener</a> needs to be added as a
<a class="javadocref" href="https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/engine/cdi/impl/event/CdiEventListener">CdiEventListener</a> needs to be added as a
[Process Application Execution Event Listener](../../user-guide/process-applications/process-application-event-listeners.md).

Example configuration for [Servlet Process Application](../../user-guide/process-applications/the-process-application-class.md#the-servletprocessapplication):
Expand Down
2 changes: 1 addition & 1 deletion docs/documentation/user-guide/dmn-engine/data-types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ types. For example, you can add a new type for time or change the
transformation to support a different date format or localized boolean
constants.

To do this, implement a new [DmnDataTypeTransformer](org/operaton/bpm/dmn/engine/impl/spi/type/DmnDataTypeTransformer.html). The transformation is processed in the `transform()` method and returns a typed value. If it cannot successfully transform a value, it must throw an `IllegalArgumentException`.
To do this, implement a new [DmnDataTypeTransformer](https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/dmn/engine/impl/spi/type/DmnDataTypeTransformer.html). The transformation is processed in the `transform()` method and returns a typed value. If it cannot successfully transform a value, it must throw an `IllegalArgumentException`.

```java
public class CustomDataTypeTransformer implements DmnDataTypeTransformer {
Expand Down
24 changes: 12 additions & 12 deletions docs/documentation/user-guide/dmn-engine/embed.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ This section gives more insights of embedded DMN engine configuration. In case y

## Decision Table Evaluation Listeners

The DMN engine configuration allows you add a custom decision table [evaluation listener](org/operaton/bpm/dmn/engine/delegate/DmnDecisionTableEvaluationListener.html).
The DMN engine configuration allows you add a custom decision table [evaluation listener](https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/dmn/engine/delegate/DmnDecisionTableEvaluationListener.html).
A decision table evaluation listener is notified after a decision table has been evaluated. It receives an evaluation event which contains the result of the evaluation. You can decide if the listener should be notified before or after the default listeners.

```java
Expand All @@ -71,7 +71,7 @@ configuration.getCustomPostDecisionTableEvaluationListeners()
```

A specialized evaluation listener is the
[metric collector](org/operaton/bpm/dmn/engine/spi/DmnEngineMetricCollector.html)
[metric collector](https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/dmn/engine/spi/DmnEngineMetricCollector.html)
, which records the number of executed decision elements. This metric can be used to monitor the workload of a decision engine.

```java
Expand All @@ -87,7 +87,7 @@ configuration.setEngineMetricCollector(metricCollector);
```
## Decision Evaluation Listeners

The DMN engine configuration allows you add a custom [decision evaluation listener](org/operaton/bpm/dmn/engine/delegate/DmnDecisionEvaluationListener.html). A decision evaluation listener is
The DMN engine configuration allows you add a custom [decision evaluation listener](https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/dmn/engine/delegate/DmnDecisionEvaluationListener.html). A decision evaluation listener is
notified after a decision with all the required decisions has been evaluated. It receives an evaluation event
which contains the result of the evaluation. You can decide if the
listener should be notified before or after the default listeners.
Expand Down Expand Up @@ -117,16 +117,16 @@ Please be aware that these APIs are **not** part of the [public API](../../intro

:::

The [default DMN engine configuration](org/operaton/bpm/dmn/engine/impl/DefaultDmnEngineConfiguration.html)
The [default DMN engine configuration](https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/dmn/engine/impl/DefaultDmnEngineConfiguration.html)
has further customization and extension points.

## Customize DMN Transformation

It is possible to customize the transformation of DMN by providing a [DMN transformer](org/operaton/bpm/dmn/engine/impl/spi/transform/DmnTransformer.html) or configuring the [default one](org/operaton/bpm/dmn/engine/impl/transform/DefaultDmnTransformer.html).
It is possible to customize the transformation of DMN by providing a [DMN transformer](https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/dmn/engine/impl/spi/transform/DmnTransformer.html) or configuring the [default one](https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/dmn/engine/impl/transform/DefaultDmnTransformer.html).

### Register DMN Transform Listeners

The simplest customization is to provide a [transform listener](org/operaton/bpm/dmn/engine/impl/spi/transform/DmnTransformListener.html). The Listener is notified after a DMN element is
The simplest customization is to provide a [transform listener](https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/dmn/engine/impl/spi/transform/DmnTransformListener.html). The Listener is notified after a DMN element is
transformed. The listener can modify the transformed object.

```java
Expand All @@ -146,11 +146,11 @@ configuration.getTransformer()
### Register DMN Element Transform Handler

While the transform listener allows modifying of the transformed objects, it does not support instantiating custom subclasses.
This can be achieved using a custom [transform handler](org/operaton/bpm/dmn/engine/impl/spi/transform/DmnElementTransformHandler.html).
This can be achieved using a custom [transform handler](https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/dmn/engine/impl/spi/transform/DmnElementTransformHandler.html).

A transform handler is registered for a given [DMN model API] type like a `DecisionTable`.

First, implement a transform handler which can transform a [decision table](org/operaton/bpm/model/dmn/instance/DecisionTable.html).
First, implement a transform handler which can transform a [decision table](https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/model/dmn/instance/DecisionTable.html).

```java
public class MyDecisionTableHandler extends DmnElementTransformHandler<DecisionTable, MyDecisionTableImpl> {
Expand Down Expand Up @@ -289,7 +289,7 @@ Just make sure that the corresponding libraries are available on the classpath a
The default DMN engine resolves the supported expression and script languages
using different providers.

To evaluate `JUEL` expressions, the DMN engine uses the <a class="javadocref" href="org/operaton/bpm/dmn/engine/impl/spi/el/ElProvider.html">ElProvider</a> configured in the
To evaluate `JUEL` expressions, the DMN engine uses the <a class="javadocref" href="https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/dmn/engine/impl/spi/el/ElProvider.html">ElProvider</a> configured in the
DMN engine configuration. To use another implementation of the Unified Expression Language, replace this implementation.

```java
Expand All @@ -301,7 +301,7 @@ DefaultDmnEngineConfiguration configuration = (DefaultDmnEngineConfiguration) Dm
configuration.setElProvider(new MyElProvider());
```

To configure the `FEEL` engine used you can provide a custom <a class="javadocref" href="org/operaton/bpm/dmn/feel/impl/FeelEngineFactory.html">FeelEngineFactory</a>.
To configure the `FEEL` engine used you can provide a custom <a class="javadocref" href="https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/dmn/feel/impl/FeelEngineFactory.html">FeelEngineFactory</a>.

```java
// with a default DMN engine configuration
Expand All @@ -312,7 +312,7 @@ DefaultDmnEngineConfiguration configuration = (DefaultDmnEngineConfiguration) Dm
configuration.setFeelEngineFactory(new MyFeelEngineFactory());
```

Script languages are resolved by the <a class="javadocref" href="org/operaton/bpm/dmn/engine/impl/spi/el/DmnScriptEngineResolver.html">DmnScriptEngineResolver</a>. To customize the script engine resolving, provide an own implementation.
Script languages are resolved by the <a class="javadocref" href="https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/dmn/engine/impl/spi/el/DmnScriptEngineResolver.html">DmnScriptEngineResolver</a>. To customize the script engine resolving, provide an own implementation.

```java
// with a default DMN engine configuration
Expand All @@ -333,7 +333,7 @@ For more information on how to configure and use SLF4J, please refer to the
[user manual].


[evaluation listener]: <a class="javadocref" href="org/operaton/bpm/dmn/engine/delegate/DmnDecisionTableEvaluationListener.html">DmnDecisionTableEvaluationListener</a> Interface
[evaluation listener]: <a class="javadocref" href="https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/dmn/engine/delegate/DmnDecisionTableEvaluationListener.html">DmnDecisionTableEvaluationListener</a> Interface
[DMN model API]: https://github.com/operaton/operaton-dmn-model
[data types]: ../../user-guide/dmn-engine/data-types.md
[hit policies]: ../reference/dmn/decision-table/hit-policy.md
Expand Down
12 changes: 6 additions & 6 deletions docs/documentation/user-guide/dmn-engine/evaluate-decisions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ menu:

---

The DMN engine <a class="javadocref" href="org/operaton/bpm/dmn/engine/DmnEngine.html">interface</a> exposes methods for parsing and evaluating DMN Decisions.
The DMN engine <a class="javadocref" href="https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/dmn/engine/DmnEngine.html">interface</a> exposes methods for parsing and evaluating DMN Decisions.

# Parse Decisions

Decisions can be parsed from an `InputStream` or transformed from a <a class="javadocref" href="org/operaton/bpm/model/dmn/DmnModelInstance.html">DmnModelInstance</a>.
Decisions can be parsed from an `InputStream` or transformed from a <a class="javadocref" href="https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/model/dmn/DmnModelInstance.html">DmnModelInstance</a>.

This example shows how to parse a decision from an input stream:

Expand Down Expand Up @@ -108,7 +108,7 @@ The DRG is represented in the XML by the `definitions` element. The `id` of the

## Decision Tables only

It is possible to check if a parsed decision is implemented as [decision table] by using the method <a class="javadocref" href="org/operaton/bpm/dmn/engine/DmnDecision.html#isDecisionTable()">isDecisionTable()</a>.
It is possible to check if a parsed decision is implemented as [decision table] by using the method <a class="javadocref" href="https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/dmn/engine/DmnDecision.html#isDecisionTable()">isDecisionTable()</a>.

```java
// create a default DMN engine
Expand All @@ -133,7 +133,7 @@ if (decision.isDecisionTable()) {

# Evaluate Decisions

To evaluate (or "execute") a decision, either pass an already transformed <a class="javadocref" href="org/operaton/bpm/dmn/engine/DmnDecision.html">DmnDecision</a> or use a DMN model instance or input stream in combination with a decision key.
To evaluate (or "execute") a decision, either pass an already transformed <a class="javadocref" href="https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/dmn/engine/DmnDecision.html">DmnDecision</a> or use a DMN model instance or input stream in combination with a decision key.

As input to the evaluation, a set of input variables must be provided.

Expand Down Expand Up @@ -181,7 +181,7 @@ Use the `VariableContext` to support lazy-loading of variables.

## Interpret the Decision Result

The evaluation of a DMN decision returns a <a class="javadocref" href="org/operaton/bpm/dmn/engine/DmnDecisionResult.html">DmnDecisionResult</a>. If the decision is implemented as [decision table] then the result is a list of the
The evaluation of a DMN decision returns a <a class="javadocref" href="https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/dmn/engine/DmnDecisionResult.html">DmnDecisionResult</a>. If the decision is implemented as [decision table] then the result is a list of the
matching decision rule results. These results represent a mapping from an output name to an output value.

If the decision is instead implemented as [decision literal expression] then the result is a list
Expand Down Expand Up @@ -244,7 +244,7 @@ decisionResult.getSingleEntry();
```

Note that the decision can also be evaluated using the
<a class="javadocref" href="org/operaton/bpm/dmn/engine/DmnEngine.html##evaluateDecisionTable(org.operaton.bpm.dmn.engine.DmnDecision, java.util.Map)">evaluateDecisionTable()</a> method if it is implemented as [decision table]. In this case, evaluation returns a <a class="javadocref" href="org/operaton/bpm/dmn/engine/DmnDecisionTableResult.html">DmnDecisionTableResult</a> which is semantically equal and provides the same methods as a
<a class="javadocref" href="https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/dmn/engine/DmnEngine.html##evaluateDecisionTable(org.operaton.bpm.dmn.engine.DmnDecision, java.util.Map)">evaluateDecisionTable()</a> method if it is implemented as [decision table]. In this case, evaluation returns a <a class="javadocref" href="https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/dmn/engine/DmnDecisionTableResult.html">DmnDecisionTableResult</a> which is semantically equal and provides the same methods as a
`DmnDecisionResult`.

## Decisions with Required Decisions
Expand Down
4 changes: 2 additions & 2 deletions docs/documentation/user-guide/dmn-engine/feel/legacy-behavior.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,5 +32,5 @@ simple unary tests.
:::

[legacy behavior flag]: ../../../reference/deployment-descriptors/tags/process-engine.md#dmnFeelEnableLegacyBehavior
[fluent feel flag setter]: ../org/operaton/bpm/dmn/engine/impl/DefaultDmnEngineConfiguration.html#enableFeelLegacyBehavior
[feel flag setter](org/operaton/bpm/dmn/engine/impl/DefaultDmnEngineConfiguration.html#setEnableFeelLegacyBehavior)
[fluent feel flag setter]: https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/dmn/engine/impl/DefaultDmnEngineConfiguration.html#enableFeelLegacyBehavior
[feel flag setter](https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/dmn/engine/impl/DefaultDmnEngineConfiguration.html#setEnableFeelLegacyBehavior)
6 changes: 3 additions & 3 deletions docs/documentation/user-guide/dmn-engine/testing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ menu:
---

To easily test DMN decisions in a JUnit test, the DMN engine provides a
JUnit Rule. The <a class="javadocref" href="org/operaton/bpm/dmn/engine/test/DmnEngineRule.html">DmnEngineRule</a> creates a new default DMN engine. The DMN engine can be used in test cases to parse and evaluate decisions.
JUnit Rule. The <a class="javadocref" href="https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/dmn/engine/test/DmnEngineRule.html">DmnEngineRule</a> creates a new default DMN engine. The DMN engine can be used in test cases to parse and evaluate decisions.

```java
public class DecisionTest {
Expand Down Expand Up @@ -63,6 +63,6 @@ public class DecisionTest {
}
```

The [DmnDecisionResult](org/operaton/bpm/dmn/engine/DmnDecisionResult.html) implements the interface `List<DmnDecisionResultEntries>`. Whereas the
[DmnDecisionResultEntries](org/operaton/bpm/dmn/engine/DmnDecisionResultEntries.html) implements the interface `Map<String, Object>`.
The [DmnDecisionResult](https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/dmn/engine/DmnDecisionResult.html) implements the interface `List<DmnDecisionResultEntries>`. Whereas the
[DmnDecisionResultEntries](https://operaton.github.io/operaton/javadoc/operaton/1.0/org/operaton/bpm/dmn/engine/DmnDecisionResultEntries.html) implements the interface `Map<String, Object>`.
This allows you to use common `List` or `Map` asserts.
Loading