Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

The purpose of the plugin is to allow to set up a specific configuration for a Wedia portal application, by overriding a basic configuration provided by the product.

...

  • _portal

  • _portal@config

  • _portal@config@picker

The path _portal@$config@picker designates a configuration defined in 3 folders whose relative paths are successively :

...

  • either a number (the unit depends on the parameter)

  • or a number (integer or decimal) followed by a unit, among

    • s (seconds)

    • ms (milliseconds)

    • m (minutes)

    • h (hours)

Standard postprocessors

Surfer role

...

This feature is disableable by plugin configuration.

Command submission⛔ submission⚠️

Services that may fail due to lack of lock availability can be run in batch with guaranteed execution. When the execution fails because of the lock system, the execution is retried later.
At invocation, a set of commands is specified, each command corresponding to a service invocation. The service returns a command identifier and the current status of each command. It is possible to query this status via the command set identifier at any time until complete. Completed command sets are kept for a limited time. If the status of an unknown order set is requested (unknown id, or retention time exceeded), a done status will be obtained, without details per command

...

GET /api/portalconfig/cache

Get cache status

Filtering

Path

JSON filtering is done by path. A path is defined as a sequence of :

  • field names

  • array cell indexes between bracket

  • separators, as slash (/)

A path can be absolute or relative. An absolute path always starts with a separator (so a slash). If the path does not start with a slash, it is relative. Field names are separated by a slash. Array indexes are not.

Examples :

...

languagejson

...

Info

GET /api/portalconfig/info

Get some information about the plugin.

Response

Code Block
	public static final String STARTUP_ERROR_STATUS = "Startup error";
	public static final String STARTUP_INFO_STATUS = "Startup";
	public static final String SHUTDOWN_INFO_STATUS = "Shutdown";
	public static final String OK_INFO_STATUS = "OK";
	public static final String SHUTTINGDOWN_INFO_STATUS = "Shutting down";
  • version, version of the plugin

  • env, type of environment, among

    • DEV

    • PROD

    • PREPROD

  • security, true, if security is enabled

  • status, plugin status

    • label, status of the plugin, among

      • OK

      • Startup error

      • Startup

      • Shutdown

      • Shutting down

    • code, status code color, among

      • GREEN

      • YELLOW

      • RED

Filtering

Path

JSON filtering is done by path. A path is defined as a sequence of :

  • field names

  • array cell indexes between bracket

  • separators, as slash (/)

A path can be absolute or relative. An absolute path always starts with a separator (so a slash). If the path does not start with a slash, it is relative. Field names are separated by a slash. Array indexes are not.

Examples :

Code Block
languagejson
{
   "a": 1,
   "b": 2,
   "c": {
      "d": 3,
      "e": 4,
      "f": 5
   },
   "d": [ 6, 7, 8 ]
}

...

Absolute path and relative path

Or

Escape

Security

The security of the services is based on three actions of the ConfigResolver domain.

read

To test the reading rights

parameter

surfer, the surfer

write

To test the writing rights

parameter

surfer, the surfer

writeLayer

To test the writing right in a layer (or of a layer), i.e. a configuration container.

parameter

surfer, the surfer

layer, the name of the layer

delivery

The plugin comes with the domain and the three actions. For the read action, a passing rule is set. For the write and writeLayer actions, a blocking rule is set.

JSP

Include configuration in your own JSP

...