You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@syncope.apache.org by "Francesco Chicchiriccò (Jira)" <ji...@apache.org> on 2022/09/26 14:03:00 UTC

[jira] [Created] (SYNCOPE-1697) Commands & Macros

Francesco Chicchiriccò created SYNCOPE-1697:
-----------------------------------------------

             Summary: Commands & Macros
                 Key: SYNCOPE-1697
                 URL: https://issues.apache.org/jira/browse/SYNCOPE-1697
             Project: Syncope
          Issue Type: New Feature
          Components: console, core
            Reporter: Francesco Chicchiriccò
             Fix For: 3.0.0


h3. Commands

A new [implementation type|https://syncope.apache.org/docs/3.0/reference-guide.html#implementations] will be available: {{COMMAND}}.

A *Command* is a Java or Groovy class:
 * implementing a specific interface (with a single method {{run()}} optionally taking parameters)
 * optionally annotated with the input parameter names required to run

The typical use case here would be to encapsulate, in a single logical unit, the equivalent of two or more REST operations.

Commands can be executed via a new REST endpoint, with Console support.

h3. Macros

A new concept named {{Macro}} will be introduced.

A *Macro* is a specialized [custom Task|https://syncope.apache.org/docs/3.0/reference-guide.html#tasks-custom] which:
* groups one or more Commands into a given execution sequence
* is associated to a given Realm in order to fit with [delegated administration|https://syncope.apache.org/docs/3.0/reference-guide.html#delegated-administration]
* may require input values to run, matching the parameters declared by the composing Commands

Macro can be executed or scheduled via a new REST endpoint, with Console support.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)